API

Create and manage canaries from scripts or provisioning jobs.

GET /canaries/api/

List canaries owned by the authenticated user.

POST /canaries/api/

Create a new canary and receive its ping and status URLs.

Authentication

Create an API key from your profile, then send it in the Authorization header.

header required

Authorization: Api-Key <your-api-key>

Create a canary

request JSON

curl -fsS https://tools.devops.care/canaries/api/ \
  -H "Authorization: Api-Key <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"name":"daily-backup","max_survival_interval":"1 00:00:00"}'

Fields

Field	Direction	Use
`name`	read/write	Human-readable job name shown in the dashboard and notifications.
`max_survival_interval`	read/write	Django duration string. Examples: `01:00:00` for 1 hour, `1 00:00:00` for 1 day.
`ping_url`	read only	Call this from your job after a successful run.
`status_url`	read only	Use this from other monitoring tools when needed.

Open the full API reference