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

Create a hierarchy node

POST/api/v1/nodes

Creates a hierarchy node in the active Application's current Environment. Prerequisite: the Environment must have a hierarchy schema — define it first via PATCH /api/v1/hierarchy-schema (or the Console's enable-hierarchy wizard), or this endpoint returns 400 ("Hierarchy schema is not configured"). Authorization is evaluated against hierarchy.manage on the parent node when parent_node_id is supplied, or Application-wide when creating the root. The node type and the parent/child relationship are validated against the schema, only one root node is permitted per Environment (a second returns 409), and the configured max_depth is enforced; a missing slug is derived from the name. Returns 201 with the created node and writes a node.created audit row.

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

parent_node_idstring Optional

Parent node ID (null for root)

node_typestring Required

Node type (org-defined, e.g. 'department', 'team')

namestring Required

Display name for the node

descriptionstring Optional

Optional free-text description shown under the node name

slugstring Optional

URL-friendly slug (auto-generated if omitted)

metadataobject Optional

Arbitrary metadata

Responses

application/json

  • dataNodeResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

NodeResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/nodes" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "parent_node_id": "string",
    "node_type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "metadata": {}
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "parent_node_id": "string",
    "node_type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "status": "string",
    "metadata": {},
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList hierarchy (scoped tree)
GETList the hierarchy as parent edges
GETGet a hierarchy node
PATCHUpdate a hierarchy node
DELETEDelete 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