CLcloudzero
costformation

POST /v2/costformation/definitions/async

Submit an asynchronous CostFormation definition publish job. Returns a job ID, initial status of pending, and a poll_url to check progress. Use the Get a publish job endpoint to poll for completion.

Request

Headers

cloudzero-idempotency-keystring

If passed, any subsequent operation with the same value for this header will return the exact same result. This is true for all responses, i.e. successes and errors.

cloudzero-test-keystring

If passed, the operation executes in the namespace specified by this key. Resource mutations in the namespace last for 1 hour.

Request body

validate_onlyboolean

If true, validates the definition without creating a publish job.

save_draft_onlyboolean

If true, saves the definition as a draft without publishing.

compressionstring nullable

Optional compression format applied to the definition payload.

Response

Successful Operation

job_idstring

Unique identifier for the publish job.

statusstring

Current status of the publish job. One of: pending, in_progress, completed, failed, superseded, cancelled.

poll_urlstring

URL path to poll for job status updates.

Example response

{
  "job_id": "job-abc123",
  "status": "pending",
  "poll_url": "/v2/costformation/publish-jobs/job-abc123"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.