Revoke API key

DELETE

/api/v1/api-keys/{keyId}

const url = 'https://localhost:8080/api/v1/api-keys/example';
const options = {
  method: 'DELETE',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"reason":"Key compromised"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://localhost:8080/api/v1/api-keys/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "Key compromised" }'

Revoke one of the authenticated user’s API keys, optionally recording a revocation reason. JWT/session only — API keys cannot manage API keys

Authorizations

BearerAuth

Parameters

Path Parameters

keyId

required

string

API Key ID

Request Body

Optional revocation reason

application/json

object

reason

Defaults to “Revoked by user”

string

Example

Key compromised

Responses

200

API key revoked successfully

application/json

Confirmation body for endpoints that return no resource

object

message

string

Example

{
  "message": "Operation completed successfully"
}

400

Bad request - Invalid key ID

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized - Authentication required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - API keys cannot manage API keys, or can only revoke own API keys

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

API key not found

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

409

API key already revoked

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}