1. Docs
  2. API Reference
  3. Delete a hierarchy node

Delete a hierarchy node

DELETE/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/nodes/{id}

Soft-deletes a hierarchy node and its entire subtree in the current Environment by setting each node's status to deleted (rows are retained rather than hard-deleted), and removes every role assignment anchored at any node in the subtree so hidden branches can't keep granting access. Gated by hierarchy.manage on the node; the root node cannot be deleted (400). Supply an If-Match header with the node's current version for optimistic concurrency — a stale value returns 409. Returns 204 No Content and writes a node.deleted audit row.

Authentication

Bearer TokenAuthorization

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

Requires capability env_structure.manageDeveloper Console

Create, edit, move, and delete the Environment's hierarchy nodes and edit its levels. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

idstring Required

Headers

  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since.

Responses

Node deleted successfully

application/json

  • errorApiErrorBodyDto*

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.

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/value/applications/value/environments/value/nodes/value" \
  -H "If-Match: "3"" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
HTTP/1.1 204 Node deleted successfully

(empty body)
 Related endpoints
GETList hierarchy nodes (scoped, paged)
POSTCreate a hierarchy node
GETGet a hierarchy node
PATCHUpdate a hierarchy node
GETGet subtree from a node
GETGet ancestor chain for a node
GETGet direct children of a node
POSTMove (reparent) a node
GETList identities at a node
GETGet identity summary for a node
 Was this page helpful?

Tell us how we can improve this guide.

Canopy