Deploy a project

Deploy a project. Specify the target environment in the query parameters. Projects can only be deployed from the development environment.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

idstringRequired

Project ID. This parameter accepts a valid project_id or a valid folder_id, formatted as f\{:folder_id}, for example: f660222.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
environment_typestringRequired

The environment the project is deployed to. Accepted values: test or prod.

titlestringOptional
A title of the deployment.
descriptionstringOptional
A brief description of the deployment.

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
The environment where the project is deployed.
project_idstring
Project ID.
statestring

Status of the build. Possible values are: pending, success, and failed.

performed_by_namestring
Name of the user who initiated the build.

Errors