1. Docs
  2. API Reference
  3. Revoke a publishable key

Revoke a publishable key

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/publishable-keys/{id}

Retires a key. Calls presenting it afterwards resolve no Environment and fail exactly as they would for a key that never existed. Sessions already issued from it are unaffected — revoking a key stops new sign-ins, it does not sign anyone out.

Authentication

Bearer TokenAuthorization

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

Requires capability publishable_keys.manageDeveloper Console

Create, rename, and revoke publishable keys. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

Publishable key revoked

application/json

  • errorApiErrorBodyDto*

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}/publishable-keys/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Publishable key revoked

(empty body)
 Related endpoints
GETList the environment's publishable keys
POSTCreate a publishable key
PATCHRename a publishable key
 Was this page helpful?

Tell us how we can improve this guide.

Canopy