---
title: "Create a canary credential"
method: POST
path: "/safe-house/canaries"
tags: ["Safe House"]
---

# Create a canary credential

`POST /safe-house/canaries`

## Request

- Base URL: `https://api.mnemom.ai/v1`
- URL: `https://api.mnemom.ai/v1/safe-house/canaries`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Mnemom-Api-Key`

Generates a format-valid but non-functional credential (api_key / password / database_url / ssh_key / oauth_token). The canary value is **only returned on creation** — plant it in the agent's context so exfiltration attempts trip it. Requires the owner, admin or member role in the caller's organization (viewers and auditors are read-only and get 403).

## Request body

- object
  - `agent_id` string, required
  - `canary_type` 'api_key' | 'password' | 'database_url' | 'ssh_key' | 'oauth_token', required

## Response `201`

Canary created. `canary_value` is returned once and must be captured.

- object: Canary credential planted in an agent context. `canary_value` is only returned on creation.
  - `id` string
  - `agent_id` string
  - `canary_type` 'api_key' | 'password' | 'database_url' | 'ssh_key' | 'oauth_token'
  - `triggered` boolean
  - `triggered_at` string, date-time, nullable
  - `created_at` string, date-time
  - `canary_value` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `404`: Resource not found
- `429`: Rate-limit exceeded. The global per-IP limiter (100 requests/minute, applied to every `/v1/*` route) rejected this request. Back off until the window resets — `Retry-After` carries the cooldown in seconds and `X-RateLimit-Reset` the absolute reset time.
- `500`: Server error — request was well-formed but the server failed to fulfill it. Typically a downstream dependency (DB / RPC / external API) returned an unexpected error.

---

[API](https://skmtc.dev/mnemom/apis/mnemom-api.md) · [All operations](https://skmtc.dev/mnemom/apis/mnemom-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mnemom/apis/mnemom-api/revisions/274b7a6ea182?raw)