Get canary settings

GET

/canary/settings

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

• API v1

Responses

200

Canary settings

Media typeapplication/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

integer

null

null

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

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}