Get custom node

Retrieve the configuration for a specific custom node kind. Returns the display settings and metadata for the requested node kind.

GET /api/v2/custom-nodes/{kind_name}

Get custom node

cURL

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

200

{
  "id": 1,
  "kindName": "KindA",
  "config": {
    "icon": {
      "type": "font-awesome",
      "name": "house",
      "color": "#FFFFFF"
    }
  }
}

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

Path Parameters

kind_name · string · required

Kind Name

Response

200

application/json

OK

id · integer

kindName · string

config · object

Show child attributes