Bandwise docs
API reference

Rollout

Available from Phase 3

The HTTP API is not live yet. These endpoints are the planned contract, generated from the same schema the server will use. Paths and fields can still change before they ship.

Read a channel's rollout stage, next-stage gates and auto-demote status.

GET/api/v1/sets/{ref}/channels/{channel}/rollout

Authorization

AuthorizationBearer <token>

An 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

ref*string
Length1 <= length
channel*string

Value in

  • "production"
  • "staging"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/sets/string/channels/production/rollout"
null

Move a channel to another rollout stage. Pausing is never gated.

PUT/api/v1/sets/{ref}/channels/{channel}/rollout

Authorization

AuthorizationBearer <token>

An 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

ref*string
Length1 <= length
channel*string

Value in

  • "production"
  • "staging"

Query Parameters

dryRun?boolean

Preview: run the checks and return a DryRunResult. Writes nothing.

Header Parameters

Idempotency-Key?string

Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.

Length1 <= length

Request 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"  }'
null

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.

Review

Previous Page

Settings

Next Page