Embedded APIResourcesProjects

Build a project

Builds a project. You can use the following endpoint to deploy the project to an environment:

  • /api/project_builds/:id/deploy.

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.
descriptionstringOptional
A brief description of the build.
include_test_casesbooleanOptional

Instructs the build to include test cases or not. Default: false.

include_tagsbooleanOptional

Specifies whether to include tags assigned to assets in the build. Tags are excluded from the build when set to false. Set to false by default.

Response

Success reply
idinteger
Build ID.
created_atstring
Timestamp in ISO 8601 format.
updated_atstring
Timestamp in ISO 8601 format.
descriptionstring
Description of the build.
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.
download_urlstring

URL to download the package. Returns null if the build is not complete.

Errors