64 lines
813 B
Markdown
64 lines
813 B
Markdown
|
# 14_api_usage.md
|
||
|
|
|
||
|
|
# API Usage
|
||
|
|
|
||
|
|
Keine Coolify-Endpunkte erfinden.
|
||
|
|
|
||
|
|
## Workflow
|
||
|
|
|
||
|
|
```text
|
||
|
|
Auth prüfen
|
||
|
|
Version/Health prüfen
|
||
|
|
Teams/Projects/Servers/Destinations lesen
|
||
|
|
Resource lesen
|
||
|
|
Änderung planen
|
||
|
|
Write ausführen
|
||
|
|
Readback
|
||
|
|
Deploy
|
||
|
|
Logs/Status
|
||
|
|
Report
|
||
|
|
```
|
||
|
|
|
||
|
|
## Regeln
|
||
|
|
|
||
|
|
```text
|
||
|
|
404 = stoppen, nicht raten.
|
||
|
|
422 = Payload/Schema prüfen.
|
||
|
|
Delete nie ohne expliziten Auftrag.
|
||
|
|
Write immer mit Readback.
|
||
|
|
Capability Check vor Key-, Domain-, Env-, Deploy-Workflow.
|
||
|
|
```
|
||
|
|
|
||
|
|
## Write Actions
|
||
|
|
|
||
|
|
```text
|
||
|
|
create/update resource
|
||
|
|
set env
|
||
|
|
set domain
|
||
|
|
set volumes
|
||
|
|
set build settings
|
||
|
|
deploy/restart
|
||
|
|
```
|
||
|
|
|
||
|
|
## Fallback
|
||
|
|
|
||
|
|
Wenn API nicht reicht:
|
||
|
|
|
||
|
|
```text
|
||
|
|
UI-Schritt dokumentieren
|
||
|
|
manuelle Aktion nennen
|
||
|
|
nicht behaupten, API könne es
|
||
|
|
```
|
||
|
|
|
||
|
|
## Report
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
api_report:
|
||
|
|
checked:
|
||
|
|
used:
|
||
|
|
writes:
|
||
|
|
readback:
|
||
|
|
unsupported:
|
||
|
|
manual_steps:
|
||
|
|
```
|