Skip to main content
POST
Choose which build the project serves. The build is marked Ready, the project is switched on, and distribution to the region’s streaming servers is queued. Viewers get the new build once it reaches Approved; poll Build Status for that.
Scope: control. Team members need the Editor role or above. Limited to 30 control calls per minute per account.
Only a build the pipeline has finished processing can be set active: status Ready, Approved, Distribute or Distributing to Servers. A build still downloading or scanning is refused with 409; a failed or rejected build needs a new upload.

Path parameters

string
required
The project.

Headers

string
required
An API key issued with the control scope.

Request body

string
required
The build to activate: uploadId from Upload File, or id from List Builds.

Response

string
The build now being distributed.
boolean
true: distribution was queued.
string
The build’s status before this call.
boolean
Always true: setting a build active switches the project on.
string
What to do next.

Errors

A full release from CI

1

Upload

Upload File with autoRelease: false; keep the uploadId.
2

Wait for processing

Poll Build Status until state is ready_for_activation, or listen for the build.saving webhook.
3

Activate

Call this endpoint with the uploadId.
4

Wait for distribution

Poll Build Status until state is live. Optionally End Sessions so current viewers reconnect onto the new build.