Update canary settings

PATCH

/canary/settings

curl --request PATCH \
  --url https://example.com/api/v1/canary/settings \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "defaultMaxBatchSize": 1, "autoSelect": true, "defaultCanaryInstanceId": 1, "defaultPartialPolicy": "gate" }'

• API v1

Updates the opt-in enable flag, default batch size, auto-select, default canary instance, and default partial policy. defaultMaxBatchSize must be an integer >= 1.

Request Body^required

Media typeapplication/json

object

enabled

boolean

defaultMaxBatchSize

integer

>= 1

autoSelect

boolean

defaultCanaryInstanceId

One of:

integer

integer

null

null

defaultPartialPolicy

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

Responses

200

Updated 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"
}

400

Invalid settings payload

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to update canary settings

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}