Skip to main content
POST
/
v1
/
api-keys
/
{key_id}
/
revoke
Revoke API Key
curl --request POST \
  --url https://api.example.com/v1/api-keys/{key_id}/revoke
{
  "created_at": "2024-01-01T00:00:00",
  "expiration_date": "2024-12-31T23:59:59",
  "key_id": "507f1f77bcf86cd799439011",
  "name": "Development API Key",
  "permissions": [
    "read",
    "write"
  ],
  "revoked": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.verbex.ai/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
key_id
string
required

Response

Successful Response

​
_id
string
required

Unique identifier for this API key in the database

​
name
string
required

The descriptive name given to this API key

​
permissions
string[]
required

List of permission scopes granted to this API key

​
expiration_date
string<date-time>
required

Timestamp when this API key will expire and become invalid

​
created_at
string<date-time>
required

Timestamp when this API key was created

​
created_by_user_id
string
required

Identifier of the user who created this API key

​
revoked
boolean
default:false

Indicates if this API key has been manually revoked before its expiration date