API Keys
ANTS Platform has two kinds of API key:
| Key | Where | Used for |
|---|---|---|
| Project API key | Project Settings → API Keys | SDKs, OpenTelemetry exporters and the public REST API for one project. |
| Organization API key | Organization Settings → API Keys | The organization Admin API (projects, project keys, memberships) and SCIM provisioning. |
These are separate from LLM connections, which let the platform call model providers, from Budget AI keys, and from the enrollment keys of the Discover AI agents.
Who can manage keys
- Project keys need the
integrations.apiKeys:adminpermission. Among the built-in roles only the Owner has it. A custom role can grant it through Integrations & service accounts → Project API keys. - Organization keys need
organization:CRUD_apiKeys(Owner only) and theadmin-apientitlement (Enterprise plans). The tab is also hidden unless the deployment setsNEXT_PUBLIC_HIDE_ORGANIZATION_API_KEYS_SETTINGStofalse, and it is hidden by default.
A key pair
Each key has two parts:
| Part | Format | Use |
|---|---|---|
| Public key | pk-ap-... | Identifies the key. Sent as the username in HTTP Basic auth. |
| Secret key | sk-ap-... | The credential. Sent as the password. Shown in full only once. |
ANTS Platform stores only a hash of the secret key. The list shows a masked form, so a lost secret cannot be recovered. Create a new key instead.
Create a key
Create
Select Create API keys. There is no form. The key is created at once.
Copy the secret
The sheet shows the Secret Key, the Public Key and the Host to send data to. Project keys also show a quick start snippet. Copy the secret key now. It cannot be retrieved later.
Add a note
Back in the list, select Add note to record what the key is for, such as the service or environment that uses it.
Configure your client
Set the keys and host in your SDK or exporter. See Sending Data In.
If step-up verification is enabled on the deployment, creating a key first asks you to enter a code sent to your email. See Authentication & Security.
The key list
| Column | Meaning |
|---|---|
| Created | When the key was created. |
| Created by | The person who created the key, with their email on hover. Unknown for keys created before creators were recorded, by the system, or through the Admin API. |
| Note | Your description. Editable. |
| Public key | The full public key. |
| Secret key | A masked form of the secret. |
| Agents | Project keys only. The agents that have sent data with this key, with first seen and last seen times in the tooltip. Shows No activity recorded until the key is used. |
| Governance write | Organization keys only, shown when the governance API is available to the organization. A switch that lets the key change governance data through the governance API. Turning it on asks for step-up verification. |
| Expires | The expiry date, the days left when 14 or fewer remain, Expired, or Never for older keys created before expiry existed. |
There is no last-used time. The list shows 10 keys per page.
The project API Keys page also has an AI Studio connectors button, which opens Project Settings → Integrations to import traces from AWS Bedrock and Google Vertex AI.
Who created a key
ANTS Platform records the person who created each project and organization API key, and shows it in the Created by column. The creator is recorded for keys created in the console, including keys that the platform creates for you when you set up Discover AI enrollment, an AI agent connector, or the MS Graph and Copilot Studio connectors.
Unknown means no creator is recorded: the key was created before this was tracked, by the system, or through the Admin API.
When the creator leaves
When someone is deprovisioned through SCIM or by Okta access reconciliation, ANTS Platform finds the API keys they created in that organization: organization keys, and project keys in its projects.
- By default the keys keep working, because revoking an ingestion key stops data flowing. Owners, and members who administer Budget AI keys, get a Keys of a deprovisioned person notification and an email that list the keys to rotate, and an audit entry lists them by public key, scope, project and note. Secrets are never recorded.
- To revoke them instead, an Owner or Security & Compliance member turns on Revoke API keys created by a deprovisioned person under Organization Settings → Features → SCIM provisioning. It is off by default. While it is off, the setting shows how many existing keys it would make revocable. Turning it on or off asks for step-up verification. Revoked keys are deleted and stop authenticating on the next request.
- Some keys are never revoked automatically, even with the setting on, because revoking them would break a device fleet, a connector or an integration. They are flagged for rotation, and the notification says why each was kept:
- Discover AI keys;
- AI agent connector, MS Graph connector and Copilot Studio connector keys;
- keys that have made a successful SCIM change or a successful governance API request;
- the key that sent the deprovisioning request.
When an administrator leaves, also review the keys whose creator is Unknown. Deprovisioning cannot tell whether the leaver created them. Rotate any key that person may have copied. People deprovisioned before creators were recorded never have their keys listed; review those keys by hand.
Expiry
- Project and organization keys expire 6 months after creation. You cannot choose a different period.
- Requests with an expired key are refused with
401. - Owners are emailed and notified in the app 30, 14, 7 and 1 days before a key expires. See Notifications.
- To send these to other tools, create automation rules on API key expiring and Key expired. Key expired fires once when a project key reaches its expiry date. Rules can also act on API key created and API key revoked.
Rotate and delete
There is no rotate action. To rotate a key, create a new one, update your clients, then delete the old one with the trash icon and confirm Permanently delete. A deleted key stops working within a few minutes, once the authentication cache refreshes.
Creating a key, changing its note and deleting it are recorded in Audit Logs.
Ingestion-only project keys
A deployment can set PROJECT_API_KEYS_INGESTION_ONLY=true. Project keys can then only send traces, fetch prompts and check authentication. Calls that read or delete data return 403. The create sheet shows Trace ingestion only. Organization keys are not affected.
What organization keys can do
With the admin-api entitlement, an organization key can:
- List the organization's projects, and create, update and delete projects.
- List, create and delete project API keys.
- List and update organization memberships, and project memberships (project memberships also need the
rbac-project-rolesentitlement). - Provision users through SCIM.
Organization keys cannot read project data such as traces. They authenticate with HTTP Basic auth; the SCIM endpoints also accept them as Authorization: Bearer <public key>:<secret key>. Keys have no finer-grained scopes.
Treat secret keys like passwords. Never commit them to source control or put them in browser code. Use one key per service or environment so you can delete one without affecting the rest.
Next steps
- Sending Data In: use keys to send traces.
- API Reference: authenticate REST calls.
- SCIM Provisioning: use an organization key with your identity provider.