Deploy a project build

Deploys a project build to an environment. Use the /api/projects/:id/build endpoint to build the project first.

Path parameters

idintegerRequired
The ID of the project build to retrieve.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
environment_typestringRequired

Specifies the deployment environment for the build. Accepted values include the following:

  • sandbox

  • test

  • stage

  • uat

  • preprod

  • prod

titlestringOptional
Title of the build.
descriptionstringOptional
A brief description of the build.

Response

Success reply
idinteger
Deployment ID.
created_atstring
Timestamp in ISO 8601 format.
updated_atstring
Timestamp in ISO 8601 format.
titlestring
Title of the deployment
descriptionstring
Description of the deployment.
project_build_idinteger
ID of the associated project build.
environment_typestring
Specifies the deployment environment for the build.
project_idstring
Project ID.
stateenum
Status of the build.
Allowed values:
performed_by_namestring
Name of the user who initiated the build.

Errors