provisioning

Get the status of a previously issued provisioning job

Queries the CSP for the status of a previously issued provisioning job for which that CSP issued an HTTP 202 response, indicating that the provisioning job was accepted but a response was not available immediately. This allows continuously checking the status to inform the end user. The provisioning job ID must be unique across all provisioning jobs and must never be reused; however, a provisioning job ID must be queryable for at least 168 but no more than 240 hours.

get/provisioning/{provisioningJobId}/status

Path parameters

provisioningJobIdstring required

The ID of the provisioning job

Response

Get provisioning status successful

provisioning_job_idstring required

The ID of the Provisioning job; used for retrieving status to inform end user. This ID must be unique across all provisioning jobs across portfolios.

portfolio_idstring

The ID of the Portfolio for which status is being returned

environment_idstring

The ID of the Environment for which status is being returned

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE' required

Example response

{
  "provisioning_job_id": "123456789"
}

Changes

Changed in 7 of the 50 revisions of this API.345

Feb 10, 2023c20f3ebace5322See the full diff
- ●
  added the new FAILURE enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new SUCCESS enum value to the status response property for the response status 200
  response-property-enum-value-added
- ○
  removed the COMPLETE enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the FAILED enum value from the status response property for the response status 200
  response-property-enum-value-removed
Feb 10, 20230290bea4247c1See the full diff
- ○
  added the new optional header request parameter X-Atat-Api-Version to all path's operations
  new-optional-request-default-parameter-to-existing-path
Jan 31, 20239fbf5defc05a11See the full diff
- ●
  deleted the header request parameter X-Target-Impact-Level
  request-parameter-removed
- ○
  added the optional property environment_id to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 24, 2022f8442ac9c67511See the full diff
- ▲
  added the new path request parameter provisioningJobId
  new-request-path-parameter
- ●
  deleted the path request parameter portfolioId
  request-parameter-removed
Oct 20, 20220012adbb99c01See the full diff
- ▲
  the response property portfolio_id became optional for the status 200
  response-property-became-optional
Oct 17, 2022253a3f8319a71See the full diff
- ○
  endpoint added
  endpoint-added
Apr 28, 20220aaa4c57a9851See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history