Skip to main content
API keys belong to an organization and carry explicit permissions. Use separate keys for agent ingestion, policy delivery, evaluators, CI automation, and administrative scripts.

Create and rotate a key

  1. Go to Administration → Keys, select new key, and enter a workload name.
  2. Choose a permission set and adjust individual permissions only when the preset is insufficient.
  3. Create the key and copy its one-time secret immediately.
  4. Open the key later to update grants, disable it, or regenerate the secret.
The creation drawer is where you choose the narrowest grants required by the workload.The new API key drawer with permission presets and individual grants.After creation, the Keys page shows the persistent metadata and management actions. The one-time secret is not shown again.The API Keys page showing key permissions, creation time, and regenerate and disable actions.Use this list to review grants regularly and disable keys that no longer map to an active workload.
The two permissions required by a connected Failproof AI machine are independent:
  • events:add sends events and session data.
  • policies:pull retrieves assigned policy deployments.
Key secrets are shown when created or regenerated. Store them in a secret manager and rotate them without reusing an operator’s interactive credentials.

Permission catalog

orgs:admin is reserved for the instance operator and cannot be granted to an organization key or ordinary member. Retired incidents:* and alerts:ack tokens are accepted for compatibility and normalize to current issues:* permissions. Builtin permission sets are read-only, standard, and admin. standard adds evaluation triggering, query execution, issue response, and assistant use to read permissions. Key creation strips human-only grants even when a permission set contains them.
Instance-scoped keys can select an organization with the X-AgentEye-Org header. Set it explicitly on multi-organization deployments; omission may select the default organization.