Create custom nodes

This endpoint registers new node kinds along with optional display metadata such as icons and colors. The provided configuration controls how nodes of the specified kinds are interpreted and rendered in the UI. Only free, solid-style Font Awesome icons are supported. Hex color codes must follow the format #RGB or #RRGGBB. If no valid icon or color is provided, the system will fall back to a question mark icon and a white background color. Batch input is supported; you may submit multiple configuration objects in a single request.

POST /api/v2/custom-nodes

Create custom nodes

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/custom-nodes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_types": {
    "KindA": {
      "icon": {
        "type": "font-awesome",
        "name": "house",
        "color": "#FFFFFF"
      }
    },
    "KindB": {
      "icon": {
        "type": "font-awesome",
        "name": "coffee",
        "color": "#000000"
      }
    }
  }
}
'

201

{
  "data": [
    {
      "id": 123,
      "kindName": "<string>",
      "config": {
        "icon": {
          "type": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      }
    }
  ]
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Body

application/json

custom_types · object

Show child attributes

Response

201

application/json

CREATED

data · object[]

Show child attributes