---
title: "Stop a running canary"
method: POST
path: "/api/v1/canaries/{experiment_id}/stop"
tags: ["canaries"]
---

# Stop a running canary

`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

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

## Path parameters

- `experiment_id` string, uuid, required

## Request body

- StopCanaryRequest: Cancel a running canary. The default stays as it is.
  - `reason` 'phase_failed' | 'person_stopped', required: A failed phase, or a person's decision
  - `actor_user_id` string, uuid, required: Who stopped it, or the system user

## Response `200`

Successful Response

- unknown

## Other responses

- `401`: The bearer is not the canary service token
- `404`: No canary has this id
- `409`: error_code canary_stale: the canary is not running
- `422`: Validation Error
- `503`: CANARY_SERVICE_TOKEN is not configured

## Changes

- **2026-10-21** `a63b52fb6b6e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/outrival/apis/fastapi/changes/api/v1/canaries/:experiment_id/stop/post.md)

---

[API](https://skmtc.dev/outrival/apis/fastapi.md) - [All operations](https://skmtc.dev/outrival/apis/fastapi/llms.txt) - [OpenAPI document](https://skmtc.dev/outrival/apis/fastapi/revisions/f27d90300b5e?raw)