Revoke an API key

POST /v1/api-keys/{key_id}/revoke

Revokes an API key of the caller's Organization. Every api instance refuses the key within 5 seconds (target), because the verified-key cache lives at most 3 seconds, and the key stays readable with status: revoked and revoked_at for the audit trail. Revoking a key that is already revoked or expired changes nothing and answers it as it stands. Session only (api.md section 2): the api refuses the route to every API key; Phase 0 accepts a Member ID token, so a Member signed in to the cockpit with api_keys:write makes the write.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the api_keys:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/api-keys/key_.../revoke" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/api-keys/key_.../revoke`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/api-keys/key_.../revoke",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is ApiKey.