Revoke API key

DELETE

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

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

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Path Parameters

keyId

required

string

API Key ID

Request Body

Optional revocation reason

Media type application/json

object

reason

string

Example

Key compromised

Responses

200

API key revoked successfully

Media type application/json

object

message

string

Example

{
  "message": "Operation completed successfully"
}

400

Bad request - Invalid key ID

Media type application/json

object

error

string

error_description

string

Example

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

401

Unauthorized - Authentication required

Media type application/json

object

error

string

error_description

string

Example

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

403

Forbidden - Can only revoke own API keys

Media type application/json

object

error

string

error_description

string

Example

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

404

API key not found

Media type application/json

object

error

string

error_description

string

Example

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

409

API key already revoked

Media type application/json

object

error

string

error_description

string

Example

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

500

Internal server error

Media type application/json

object

error

string

error_description

string

Example

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