Skip to content

Activate a site deployment

POST
/sites/{name}/deployments/{deployment_number}/activate
curl --request POST \
--url https://example.com/sites/example/deployments/1/activate \
--header 'Authorization: Bearer <token>'
name
required
Name
string
deployment_number
required
Deployment Number
integer

Successful Response

Media typeapplication/json
SiteDeploymentResponse
object
active
required
Active
boolean
actor
required
Actor
string
credential
required
Any of:
string
deployed_at
required
Deployed At
string format: date-time
deployment_number
required
Deployment Number
integer
size_bytes
required
Size Bytes
integer
source
required
Source
string
Allowed values: dashboard api
Example
{
"source": "dashboard"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}