1. Docs
  2. API Reference
  3. Activate or deactivate an API key

Activate or deactivate an API key

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

Enables or disables an existing API key in the current Environment via the is_active flag. Disabling is reversible: a disabled key is rejected by authentication immediately and can be re-enabled later. Returns the key's metadata with no secret. Returns 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

Request body

application/json

is_activeboolean Required

Whether the key is active. Set `false` to deactivate (the key stops authenticating immediately, reversibly); set `true` to reactivate.

Responses

application/json

  • dataApiKeyResponseDto*

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

ApiKeyResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'
Response
{
  "data": {
    "id": "string",
    "client_id": "string",
    "name": "string",
    "description": "string",
    "key_preview": "string",
    "access_mode": "scoped",
    "scopes": [
      "string"
    ],
    "is_active": false,
    "last_used_at": "2026-04-20T12:00:00.000Z",
    "expires_at": "2026-04-20T12:00:00.000Z",
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 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
DELETEDelete an API key
POSTRotate an API key's secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy