Revoke an API key

DELETE

/v1/admin/api-keys/{key_id}

Immediately revokes a key. The key will fail validation from this point forward. Active reservations using this key can still be committed/released, but no new operations are permitted.
REVOCATION IS PERMANENT: - Cannot be undone - Revoked keys remain in database for audit trail - Status transitions: ACTIVE → REVOKED

Authorizations

AdminKeyAuth

Administrative API key with full system access

Type

API Key (header: X-Admin-API-Key)

Parameters

Path Parameters

key_id*

Type

string

Required

Query Parameters

reason

Type

string

Max Length

512

Responses

Key revoked

Content-Type

application/json

{

  

"key_id": "string",

  

"tenant_id": "string",

  

"key_prefix": "string",

  

"name": "string",

  

"description": "string",

  

"permissions": [

  

  

"string"

  

],

  

"scope_filter": [

  

  

"string"

  

],

  

"status": "string",

  

"created_at": "string",

  

"last_used_at": "string",

  

"expires_at": "string",

  

"revoked_at": "string",

  

"revoked_reason": "string",

  

"metadata": {

  

  

"additionalProperties": "string"

  

}

}

DELETE

/v1/admin/api-keys/{key_id}

Playground

Authorization

AdminKeyAuth

Variables

Key

Value

key_id*

reason

Samples

Powered by VitePress OpenAPI