Register a honeytoken
Registers a decoy (canary) relation for the project. Any agent statement that references it is blocked and recorded as a canary_tripped audit event.
AuthorizationBearer <token>
JWT issued by Better Auth. Verified via JWKS.
In: header
Path Parameters
project_id*string
Unique project identifier (prefixed, e.g. prj_xxx).
Match
^[a-zA-Z0-9_.-]+$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for creating or updating a honeytoken.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/honeytokens" \ -H "Content-Type: application/json" \ -d '{ "relation_name": "customer_ssns", "action": "audit_only" }'{ "id": "hnt_01j9x8y7z6w5v4u3t2s1r0q9p8", "project_id": "prj_01j9x8y7z6w5v4u3t2s1r0q9p8", "schema_name": "public", "relation_name": "customer_ssns", "action": "audit_only", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}{ "error": { "code": "string", "message": "string" }}