API

The API lets you create and inspect canaries and pull their trigger logs. All endpoints require a bearer token, which you create from your dashboard once signed in.

Authentication

Authorization: Bearer <your-api-token>

Endpoints

MethodPathDescription
GET/api/v1/canariesList your canaries
POST/api/v1/canariesCreate a canary (type, name, optional settings)
GET/api/v1/canaries/{id}Fetch a single canary
GET/api/v1/canaries/{id}/triggersList trigger events for a canary
GET/api/v1/meCurrent token owner

Example

curl https://canary.dk/api/v1/canaries \
  -H "Authorization: Bearer $CANARY_TOKEN"

Responses are JSON. Canary delivery endpoints (the decoys themselves) are open-CORS and need no auth.