1. Docs
  2. API Reference
  3. Create a new API key

Create a new API key

POST/api/v1/api-keys

Issues a new API key in the active Application, scoped to the current Environment. The full cnpy_-prefixed secret is returned exactly once in the key field of the response and is never recoverable afterward — only a masked key_preview and metadata persist. access_mode: "scoped" requires a non-empty scopes array and enforces it on every authorization check; access_mode: "full_access" forbids scopes and bypasses RBAC entirely within the Application. Pass expires_at (ISO 8601) for an expiring key or omit it for none. Supports Idempotency-Key for safe retries, emits an api_key.created event, and is rate-limited to 20 requests per minute per Application.

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.

Request body

application/json

namestring Required

API key name

descriptionstring Optional

API key description

access_modeenum Required

Required. `scoped` enforces the `scopes` array on every authorization check (deny if the requested permission isn't listed). `full_access` bypasses RBAC entirely within the key's Application — every permission is granted. Pick `scoped` whenever possible; `full_access` should be a deliberate choice (use cases: bootstrap automation, trusted backend services that legitimately need App-wide access). `scoped` requires a non-empty `scopes` array; `full_access` forbids `scopes`.

one of "scoped" · "full_access"

scopesstring[] Optional

Permission scopes this key is authorized for. Required and must be non-empty when `access_mode` is `scoped`. Must be omitted when `access_mode` is `full_access`.

expires_atstring Optional

Expiration date (ISO 8601). Omit for no expiration.

Responses

application/json

  • dataApiKeyCreatedResponseDto*

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.

409api_keys.name_conflictConflict
When it happens

An API key with this name already exists for this Application.

Remediation

Choose a unique name, or fetch the existing key with GET /api-keys before retrying.

400api_keys.invalid_scopeBad request
When it happens

One or more requested scopes are not valid for the current Environment.

Remediation

Request only scopes available to this Environment. See the scopes field in the request body above.

Idempotency

Idempotency-Key header

Send an Idempotency-Key header to make retries safe. Canopy replays the same response for matching keys within 24 hours.

Rate limit

20 requests per 1mPer Application

Emitted events

  • api_key.created

Returned object

ApiKeyCreatedResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/api-keys" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "access_mode": "scoped",
    "scopes": [
      "string"
    ],
    "expires_at": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "key": "string",
    "key_preview": "string",
    "access_mode": "scoped",
    "scopes": [
      "string"
    ],
    "expires_at": "2026-04-20T12:00:00.000Z",
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList API keys for Application
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