Skip to main content
These admin routes run the Console’s own Personal key administration (the Platform → Developers → Personal keys page) for a platform API key, and a person’s own Personal keys for their Personal key. An External App is refused with 403, even when it holds the permission.
  • List every Personal key and host sign-in in the deployment, newest active keys first, with apikeys:read at platform scope. Past the inventory limit the answer keeps the newest active keys and sets overflow. A row answers the key’s id, label, prefix, scopes, status and dates, never its owner, secret or hash.
  • Revoke any person’s Personal key or host sign-in with apikeys:manage at platform scope, with an optional reason. The owner is told on their personal bell and email, as when an administrator revokes it in the Console. A missing key, or one that is not a Personal key, answers 404; an already revoked key answers 409.
Both are platform operations: the key needs the permission at platform scope, else 403. A revoke is audited under the key: a platform API key as a system actor, a Personal key as its owner. A retry with the same Idempotency-Key never answers the stored response.

Your own Personal keys

These run the Console’s Settings → Personal keys actions for your Personal key, as you. They need no permission, and they act only on your own keys. Your key’s own scopes must reach apikeys:read to list and apikeys:manage to revoke or delete; otherwise the call gets 403 naming that key, whatever you hold yourself:
  • GET /api/v3/me/api-keys lists your Personal keys and host sign-ins, active and revoked.
  • POST /api/v3/me/api-keys/{keyId}/revoke revokes one of them, with an optional reason. An already revoked key answers 409.
  • DELETE /api/v3/me/api-keys/{keyId} deletes one you have revoked and disables its role grants. An active key answers 409: revoke it first.
Another person’s key, a missing key, and a key that is not a Personal key all answer 404, and no permission reaches them. A platform API key, or any other credential that is not a Personal key, gets 403 with personRequired: true. A revoke or delete is audited as you, through your Personal key. Creating a Personal key and changing its scopes stay in the Console.