honeytokens
honeytokens create
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.
Usage
pgbeam honeytokens create [flags]Options
| Option | Description | Required | Default |
|---|---|---|---|
--schema-name <value> | Optional schema. Null or empty matches the unqualified/public form. | No | - |
--relation-name <value> | Relation (table or view) name of the decoy. | Yes | - |
--action <value> | Response when the honeytoken is tripped. One of: audit_only, kill. | Yes | - |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --no-trunc, --debug) are
also available on this command.
Examples
# Register a honeytoken
pgbeam honeytokens create
# Output as JSON
pgbeam honeytokens create --jsonOutput
Renders a human-readable table or detail view by default; pass --json for the raw API response.