Update an formation
PUT/v1/projects/:project_id/formations/:formation_id
Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
A template read back can be sent as read: each { "no_echo": true } placeholder takes the stored value at its path, in a resource that then equals its deployed declaration, or the update is 400 VALIDATION_FAILED.
A template-shape error is refused with 400. A deploy failure is not: the operation ran, so the formation is returned with 200 and status: "failed", and error explains why. Read status — a 2xx here means the deploy was attempted, not that it worked. The naturali CLI exits non-zero on that body so update-formation && … does not lie.
A deploy that replaced a resource and could not delete the superseded one answers status: "active" with error.code: "FORMATION_REPLACE_CLEANUP_FAILED" — the desired state is realised, and error.meta.failures names every resource still live. The next deploy retries the disposal.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 429
- 500
- 502
- 4XX
Updated formation
Bad Request
Unauthorized
Forbidden — either the caller may not operate on formations in the project, or it lacks an action a resource this template declares requires. error.meta.denied_actions names every missing action; nothing is applied.
Not Found
REQUEST_REJECTED — the request body is over the size the body parser accepts
QUOTA_EXCEEDED — a requests quota on the calling API key or its project is spent for the window; Retry-After says when it reopens
Response Headers
Seconds until the quota window admits a request again
Unexpected server error — INTERNAL_ERROR, with the raw message never forwarded
The deployment's admission service is asked about this write and did not answer — ADMISSION_UNAVAILABLE; the write did not happen
The deployment's admission service refused this write — answered under the service's own 4xx status, with its code (matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$, not necessarily an ERROR_CODES key), message and meta; the write did not happen. A status this operation also declares on its own is documented there