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

Rename a publishable key

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

Renames a key. The name is a label with no behavioural consequence and is the only mutable field: a key's type cannot change, because sessions already issued from it carry the delivery that type implied. To switch type, create a new key and revoke the old one.

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

Request body

application/json

namestring Required

Label shown in the dashboard, so several keys on one environment are tellable apart.

max length 100

Responses

application/json

  • dataPublishableKeyResponseDto*

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.

Returned object

PublishableKeyResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/publishable-keys/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "key": "string",
    "type": "web",
    "name": "string",
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList the environment's publishable keys
POSTCreate a publishable key
DELETERevoke a publishable key
 Was this page helpful?

Tell us how we can improve this guide.

Canopy