Get canary settings

GET

/canary/settings

const url = 'https://example.com/api/v1/canary/settings';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/canary/settings

Responses

200

Canary settings

application/json

object

enabled

required

Opt-in. When false the staged flow is hidden and start falls through to a plain sync.

boolean

defaultMaxBatchSize

required

integer

>= 1

autoSelect

required

Allow least-critical auto-pick when no explicit or default canary is set.

boolean

defaultCanaryInstanceId

required

One of:

integer
null

integer

defaultPartialPolicy

required

How a partial canary outcome is treated:

gate: pass-with-warning; continue to the verification gate
abort: treat as failure; remaining instances are never touched

string

Allowed values: gate abort

Example

{
  "defaultPartialPolicy": "gate"
}

500

Failed to read canary settings

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}