1. Docs
  2. API Reference
  3. Create an Application

Create an Application

POST/api/v1/applications

Creates an Application in the Account from a name and optional slug (derived from the name when omitted), with its default Environments, each with its own root hierarchy node. A slug already in use in the Account returns 409 (application.slug_conflict), and so does a create in an Account that already holds 25 Applications, the most it may (application.limit). Writes an application.created audit row. Requires application.manage.

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 application.manageAccount

Create, update, and delete Applications and Environments, and change Environment settings. 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.

Request body

application/json

namestring Required

Display name for the new Application

slugstring Optional

URL-safe slug. Must be lowercase alphanumeric with optional dashes (no leading/trailing dash). Auto-derived from `name` when omitted.

Responses

application/json

  • dataApplicationResponseDto*

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. 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

ApplicationResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/applications" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "slug": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "account_id": "string",
    "name": "string",
    "slug": "string",
    "default_environment_id": "string",
    "settings": {},
    "version": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList the Account's Applications
GETGet an Application
PATCHRename an Application
DELETEDelete an Application
PUTSet an Application's default Environment
GETList an Application's Environments
POSTCreate an Environment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy