Sign in
latestSwagger 2.02026-08-1095121164.0 KB

94758829689e

sites

Deploy Environment

Deploys code to an environment.

post/v0/sites/{site_id}/environments/{env_id}/deploy

Path parameters

site_idstring required

Site UUID

env_idstring required

Environment ID

Request body

clear_cacheboolean

Whether to clear cache after deployment

notestring

Deployment note/annotation

sync_contentboolean

Whether to sync content from Live (for Test environment only)

updatedbboolean

Whether to run database updates after deployment

Example request

{
  "note": "Deploy from API"
}

Response

active_descriptionstring

Active description of the workflow

idstring required

Workflow ID

number_of_tasksinteger

Number of tasks in the workflow

Example response

{
  "active_description": "Creating database backup",
  "id": "12345678-1234-1234-1234-123456789012",
  "number_of_tasks": 5
}