Safe House

Create a canary credential

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).

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

Request body

agent_idstring required
canary_type'api_key' | 'password' | 'database_url' | 'ssh_key' | 'oauth_token' required

Response

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

idstring
agent_idstring
canary_type'api_key' | 'password' | 'database_url' | 'ssh_key' | 'oauth_token'
triggeredboolean
triggered_atstring date-time nullable
created_atstring date-time
canary_valuestring required

Changes

No recorded changes to this operation across all 1 revision of this API.