Apply a configuration plan
/configuration/applicationsApplies a configuration plan previously returned by the plan operation. Submit the plan's id as plan_id, together with its signature and steps.
Before accepting the request, the API verifies that the plan is still valid, that its signature matches the submitted steps, and that none of the affected resources has changed since the plan was calculated. A plan can only be applied with the same credentials used to create it, and only once.
The plan is applied asynchronously. The response returns an operation, and the Location header points to it so you can track progress.
Steps are not applied as a single transaction: if a step fails, steps that were already applied remain in effect.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/configuration/applications" \ -H "Content-Type: application/json" \ -d '{ "plan_id": "string", "signature": "string", "steps": [ {} ] }'{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}Configuration
Configuration in API v3: apply a configuration plan, create a configuration plan, validate a configuration manifest.
Create a configuration plan POST
Calculates the steps required to bring the account to the state described in a configuration manifest, and returns them as a signed plan. This operation is synchronous and does not modify any resource. The plan expires 24 hours after it is created, as indicated by `expires_at`. To apply it, submit the plan to the apply operation before it expires. If the manifest is invalid, the API returns `validation_failed` with the same error codes reported by the validation operation, and no plan is created.