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 Uploader role or above: deploying a build is a build job, not a project change. 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.
Idempotent. Posting the build that is already live and approved changes nothing: the response has changed: false and queued: false, and the project is switched on if it was off. Send redistribute: true to copy that build to the region’s streaming servers again, for example after a server was rebuilt.

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.
boolean
default:"false"
Copy the build to the region’s streaming servers again even when it is already the live, approved build.

Response

string
The build now being distributed.
boolean
false when the build was already live and the project already on.
boolean
true: distribution was queued. false: the build is already live and nothing was copied.
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.ready webhook (build.saving fires earlier, while the build is still being processed — activating then is refused with 409).
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.