1. Docs
  2. API Reference
  3. Active/inactive API key counts for the environment

Active/inactive API key counts for the environment

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/summary

Active/inactive API-key counts across the entire active Environment (optionally filtered by the same q name search the list uses), not just the current page. Requires api_key.view.

Authentication

Bearer TokenAuthorization

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

Requires capability api_keys.viewDeveloper Console

View API keys. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Query Parameters

qstring Optional

Responses

application/json

  • dataActiveSummaryDto*

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

ActiveSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/api-keys/summary?q=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "active_count": 0,
    "inactive_count": 0
  }
}
 Related endpoints
GETList API keys for Application
POSTCreate a new API key
GETList the permission scopes a scoped key can hold
PATCHActivate or deactivate an API key
DELETEDelete an API key
POSTRotate an API key's secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy