1. Docs
  2. API Reference
  3. Delete an API key

Delete an API key

DELETE/api/v1/api-keys/{id}

Permanently deletes an API key from the active Environment. The row is removed entirely rather than just disabled, so the key can never authenticate again and disappears from listings; the lifecycle remains traceable in the audit log. Returns 204 No Content on success and 404 when no key with the given id exists in the active Environment.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Responses

API key deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/api-keys/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 API key deleted

(empty body)
 Related endpoints
GETList API keys for Application
POSTCreate a new API key
PATCHActivate or deactivate an API key
POSTRotate an API key's secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy