Skip to main content
PUT
Enable or disable a branch's staging environment
Enabling a branch keeps its staging environment always active and accessible at <deploymentUrl>/dev-mode/{branchName}/cubejs-api/v1; disabled (the default) it is only active while the branch is viewed in Cube Cloud. Enabled branches are the ones listed by GET /api/v1/deployments/{deploymentId}/environments?type=staging. Only shared branches qualify — personal dev branches and the deploy branch are rejected.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Body

application/json

SetBranchStagingEnvironmentRequest

enabled
boolean
required
branchId
integer | null
branchName
string | null

Response

200 - application/json
data
object
required