API Keys

Revoke Api Key

Revoke a key at once (idempotent). Your own keys; admins and owners: any key of the workspace.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
DELETE/api/v1/workspaces/current/api-keys/{key_id}
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

key_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X DELETE "http://localhost:8000/api/v1/workspaces/current/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Zapier sync",
  "key_prefix": "ro_pat_Ab3dE",
  "scopes": [
    "string"
  ],
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "user_email": "string",
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z",
  "revoked_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}