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

Delete an Application

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}

Deletes the active Application and cascade-removes its Environments and all their child rows. Refuses with 400 when it is the last Application in the Account, so an admin always has somewhere to land after deletion. Returns 204 No Content on success, 404 when the Application no longer exists, and emits an application.deleted audit event.

Authentication

Bearer TokenAuthorization

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

Requires capability applications.manageDeveloper Console

Create, edit, and delete Applications and Environments. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Responses

Application deleted along with every Environment, role, permission, assignment, OAuth client, webhook, identity invite, and audit row scoped under it

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.

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.

Request
curl -X DELETE "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Application deleted along with every Environment, role, permission, assignment, OAuth client, webhook, identity invite, and audit row scoped under it

(empty body)
 Related endpoints
GETGet the current Application
PATCHUpdate the Application name or settings
PUTSet the App's default Environment
GETGet the admin's resume-state for this Application
PUTUpdate the admin's resume-state for this Application
 Was this page helpful?

Tell us how we can improve this guide.

Canopy