Skip to main content
PUT
/
api
/
v2
/
api-keys
/
{key_id}
/
revoke
{
  "id": "<string>",
  "customer_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "is_revoked": true,
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token from Auth0 authentication

Path Parameters

​
key_id
string
required

The unique identifier of the API key (UUID format).

Examples:

"07f5aec0-3ec3-441f-a098-912d201d067d"

Response

Successful Response

Model for API key revocation information (V2).

​
id
string
required
​
customer_id
string
required
​
name
string
required
​
is_revoked
boolean
required
​
created_at
string<date-time>
required
​
description
string | null
​
expires_at
string<date-time> | null
​
last_used_at
string<date-time> | null
⌘I