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

Rotate the environment's signing key

POST/api/v1/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 Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission auth_settings.manageAuthentication

Change the Environment's sign-in settings. Held only when named: full access does not include it. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Headers

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

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*

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. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

SigningKeySetResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/signing-keys/rotate" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -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