Developer APIResourcesProjects

Deploy an approved deployment

Deploys an approved deployment. The Require review and approval toggle must be enabled in Workspace admin > Settings > Deployments to access this endpoint.

Path parameters

idintegerRequired
The unique identifier of the deployment.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
include_tagsbooleanOptional
Specify whether the deployment should include tags.

Response

Success reply
idinteger
The deployment ID.
created_atstring
The creation time of the deployment, expressed in ISO 8601 timestamp format.
updated_atstring
The last updated time of the deployment, expressed in ISO 8601 timestamp format.
titlestring
The title of the deployment.
descriptionstring

The deployment description. This will be null if not provided in the request that created the deployment.

project_build_idinteger
The ID of the project build associated with the deployment.
environment_typestring
The environment associated with the deployment.
project_idstring
The ID of the project associated with the deployment.
stateenum
The current state of the deployment.
Allowed values:
detailed_statestring
Additional details about the current state of the deployment.
performed_by_namestring
The name of the user who performed the deployment.
assetslist of objects
review_stateenum
The state of the review.
Allowed values:
reviewslist of objects

Errors