Skip to content
/
API Key

API Key

Request

Permanently delete an API key. Requires the apikey:delete scope.

This action cannot be undone. Any integration using the deleted key will immediately start receiving 401 Unauthorized responses.

The id path parameter must be the API key's id (UUID), as returned in the id field when the key is created.

Security
authorization
Path
tenant_idstring, (uuid)required

UUID of the tenant

questionnaire_idstring, (uuid)required

UUID of the questionnaire

idstring, (uuid)required

UUID of the API key

Examples:
Delete by API key id
3f2a1c9e-7b4d-4e8a-9c1f-2d6b8e0a5f13
curl -i -X DELETE \
  'https://api.us.clearspeed.com/questionnaire/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys/3f2a1c9e-7b4d-4e8a-9c1f-2d6b8e0a5f13' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

API key deleted successfully

Response
No content