Revoke Key

DELETEhttps://api.confident-ai.com/v2/projects/{projectId}/api-keys/{apiKeyId}

Permanently revokes a project-scoped API key. Both its current value and any replacement value in flight stop authenticating at once, so anything still sending traces with it starts failing. This cannot be undone — a new key has to be created in its place.

DELETE/v2/projects/{projectId}/api-keys/{apiKeyId}

curl -X DELETE "https://api.confident-ai.com/v2/projects/{projectId}/api-keys/{apiKeyId}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "id": 1420
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project the key belongs to.
apiKeyIdintegerRequired
The id of the API key.

Response

Revoke Key succeeded.

successboolean
Indicates if the request was successful.
dataobject
Confirmation that an API key was revoked. The key's row is deleted and both of its values stop authenticating at once.
Show 1 propertyHide 1 property
- idinteger
  The id of the API key that was revoked.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI