Get custom nodes

Retrieve a list of all custom node configurations. This endpoint returns the current set of registered node kinds and their display settings.

GET /api/v2/custom-nodes

Get custom nodes

cURL

curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/custom-nodes \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": 1,
      "kindName": "KindA",
      "config": {
        "icon": {
          "type": "font-awesome",
          "name": "house",
          "color": "#FFFFFF"
        }
      }
    },
    {
      "id": 2,
      "kindName": "KindB",
      "config": {
        "icon": {
          "type": "font-awesome",
          "name": "coffee",
          "color": "#000000"
        }
      }
    }
  ]
}

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]+)$

Response

200

application/json

OK

data · object[]

Show child attributes