1. Docs
  2. API Reference
  3. Rotate the environment's signing key

Rotate the environment's signing key

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/signing-keys/rotate

Rotate the Environment's signing key. reason: manual promotes the staged next key (or mints one) to current and keeps the old key published as previous for a day, so no live token is refused. reason: emergency mints a fresh current and retires every other key in the set at once: tokens they signed stop verifying on the next check. Use it for a suspected compromise and nothing else.

Authentication

Bearer TokenAuthorization

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

Requires capability auth_settings.manageDeveloper Console

Change Environment sign-in settings. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Request body

application/json

reasonenum Required

`manual` keeps the old key published as `previous` for a day so no live token is refused. `emergency` retires every other key at once: tokens they signed stop verifying on the next check.

one of "manual" · "emergency"

Responses

application/json

  • dataSigningKeySetResponseDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

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

SigningKeySetResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/signing-keys/rotate" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "manual"
  }'
Response
{
  "data": {
    "issuer": "string",
    "discovery_url": "string",
    "jwks_url": "string",
    "keys": [
      {
        "id": "string",
        "kid": "string",
        "status": "next",
        "algorithm": "string",
        "current_from": {},
        "current_until": {},
        "created_at": "2026-04-20T12:00:00.000Z"
      }
    ]
  }
}
 Related endpoints
GETThe environment's signing keys
 Was this page helpful?

Tell us how we can improve this guide.

Canopy