Rollout
Available from Phase 3
/api/v1/sets/{ref}/channels/{channel}/rolloutAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
1 <= lengthValue in
- "production"
- "staging"
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sets/string/channels/production/rollout"{ "channel": "production", "stage": "inactive", "version": 1, "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "gates": [ { "id": "string", "required": "string", "actual": "string", "met": true } ], "warnings": [ "string" ]}/api/v1/sets/{ref}/channels/{channel}/rolloutAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
1 <= lengthValue in
- "production"
- "staging"
Query Parameters
Preview: run the checks and return a DryRunResult. Writes nothing.
Header Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/api/v1/sets/string/channels/production/rollout" \ -H "Content-Type: application/json" \ -d '{ "stage": "inactive", "reason": "string" }'{ "channel": "production", "from": "inactive", "to": "inactive", "version": 1}Bandwise is an independent product built on TypeSafe's System One models. It is not TypeSafe's documentation. For the System One models themselves, see docs.typesafe.ai.