Update an formation
PUT/api/v1/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-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 builtin 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
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