Get path composition

Returns a graph representing the various nodes and edges that make up the complex post-processed edge.

GET /api/v2/graphs/edge-composition

Get path composition

cURL

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

200

{
  "data": {
    "nodes": {},
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "lastSeen": "2023-11-07T05:31:56Z",
        "properties": {}
      }
    ]
  }
}

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

Query Parameters

source_node · integer<int32> · required

The ID of the starting node.

target_node · integer<int32> · required

The ID of the ending node.

edge_type · string · required

The type of edge to show the composition for.

Response

200

application/json

Returns graph data that contains a collection of nodes and edges related to the composition of the edge queried.

data · object

Show child attributes