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 apikey path parameter accepts:

  • The raw api_key value
Security
authorization
Path
tenant_idstring, (uuid)required

UUID of the tenant

questionnaire_idstring, (uuid)required

UUID of the questionnaire

apikeystringrequired

api_key value of the key to delete.

Examples:
Delete by api_key value
3f8a1b2c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a
curl -i -X DELETE \
  'https://api.us.clearspeed.com/questionnaire/tenants/{tenant_id}/questionnaires/{questionnaire_id}/apikeys/3f8a1b2c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

API key deleted successfully

Response
No content