OUoutrival
canaries

Stop a running canary

Changed on

Cancel the canary with reason canary_<reason>; returns the canary body.

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

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}/stop
  • Auth
    HTTP bearer

Path parameters

experiment_idstring uuid required

Request body

reason'phase_failed' | 'person_stopped' required

A failed phase, or a person's decision

actor_user_idstring uuid required

Who stopped it, or the system user

Response

Successful Response

unknown required

Changes