OUoutrival
canaries

Hold, advance, or wait a running canary

Changed on

One compare-and-set update; returns the canary body.

post/api/v1/canaries/{experiment_id}/transition

Request

  • Base URL
    https://api.outrival.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outrival.com/api/v1/canaries/{experiment_id}/transition
  • Auth
    HTTP bearer

Path parameters

experiment_idstring uuid required

Request body

action'hold' | 'advance' | 'wait' required

hold enrollment, advance to the next phase, or wait for a person

expected_phase'phase_10' | 'phase_50' | 'phase_100' required

The phase the caller read; any other phase is canary_stale

wait_reason'no_traffic' | 'unsettled' | 'control_too_small' | 'launch_gate' nullable

Why a person must decide. Required for wait

Response

Successful Response

unknown required

Changes