Deploy a project build | Workato

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

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.

1	curl -X POST https://www.workato.com/api/project_builds/1/deploy \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"environment_type": "environment_type"
6	}'

1	{
2	"id": 67,
3	"created_at": "2021-12-10T11:59:03.426-08:00",
4	"updated_at": "2021-12-10T11:59:03.426-08:00",
5	"title": "title",
6	"description": "description",
7	"project_build_id": 46,
8	"environment_type": "test",
9	"project_id": "10416",
10	"state": "pending",
11	"performed_by_name": "Josh Hernandez"
12	}

Path parameters

Headers

Request

Response

Errors