Skip to main content
POST
Switch a project on. Viewers are admitted from the moment the call returns. Idempotent: calling it on a project that is already on succeeds with changed: false.
Scope: control. Team members need the Editor role or above. Limited to 30 control calls per minute per account.
Enabling a project with no approved build does not fail, but viewers will be refused with disconnect code 4009 until a build is approved. The response carries a warning when that is the case.

Path parameters

string
required
The project to switch on.

Headers

string
required
An API key issued with the control scope.

Response

string
The project id.
string
Project name.
string
Project region.
boolean
Always true after this call.
boolean
false if the project was already on.
string[]
Empty, or one line per condition that will stop viewers even though the project is on.

Errors

Next steps

Disable Project

Switch it off and end live sessions.

Set Active Build

Choose which build viewers get.