Plan a formation deployment
POST/v1/projects/:project_id/formations/plan
Computes a diff between the desired template and the current stack state without making any changes. Returns the list of planned actions. With formation_id, a { "no_echo": true } placeholder takes that formation's stored value, as on an update.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 429
- 500
- 502
- 4XX
Plan result
Bad Request
Unauthorized
Forbidden
The project does not exist or the caller is not a member of it (RESOURCE_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