Revoke API key

DELETE /api/v1/api-keys/{keyId} Select code sample Fetch cURL

const url = 'https://localhost:8080/api/v1/api-keys/example';const options = {  method: 'DELETE',  headers: {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: 
  
   ' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Key compromised" }'

Revoke one of the authenticated user’s API keys, optionally recording a revocation reason

Authorizations

Section titled “Authorizations ”

BearerAuth
ApiKeyAuth

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” keyId required string

API Key ID

Request Body

Section titled “Request Body ”

Optional revocation reason

Media type application/json object reason string

Example

Key compromised

Responses

Section titled “ Responses ”

200

Section titled “200 ”

API key revoked successfully

Media type application/json object message string

Example

{  "message": "Operation completed successfully"}