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_id
Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E
. For example, EA2300
.
id
Project ID. This parameter accepts a valid project_id
or a valid folder_id
, formatted as f\{:folder_id}
, for example: f660222
.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
environment_type
The environment the project is deployed to. Accepted values: test
or prod
.
title
A title of the deployment.
description
A brief description of the deployment.
Response
Success reply
id
Deployment ID.
created_at
Timestamp in ISO 8601 format.
updated_at
Timestamp in ISO 8601 format.
title
Title of the deployment.
description
Description of the deployment.
project_build_id
ID of the associated project build.
environment_type
The environment where the project is deployed.
project_id
Project ID.
state
Status of the build. Possible values are: pending
, success
, and failed
.
performed_by_name
Name of the user who initiated the build.