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

Delete an API key

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability api_keys.manageDeveloper Console

Create, edit, rotate, and delete API keys. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

API key deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 API key deleted

(empty body)
 Related endpoints
GETList API keys for Application
POSTCreate a new API key
GETList the permission scopes a scoped key can hold
GETActive/inactive API key counts for the environment
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