Embedded APIResourcesProjects

Deploy a downloaded package

Deploys a downloaded package in a customer workspace to an environment. You must use the Build project endpoint (/api/managed_users/:managed_user_id/projects/:id/build) to build the project before you can deploy it.

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.

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

The environment the build deploys to. Must be either test or 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
The environment where the project is deployed.
project_idstring
Project ID.
stateenum

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

Allowed values:
performed_by_namestring
Name of the user who initiated the build.

Errors