GET
/
api
/
v2
/
graphs
/
edge-composition
{
  "data": {
    "nodes": {},
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "lastSeen": "2023-11-07T05:31:56Z",
        "properties": {}
      }
    ]
  }
}
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Query Parameters

​
source_node
integer
required

The ID of the starting node.

​
target_node
integer
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.

The response is of type object.

GET
/
api
/
v2
/
graphs
/
edge-composition
{
  "data": {
    "nodes": {},
    "edges": [
      {
        "source": "<string>",
        "target": "<string>",
        "label": "<string>",
        "kind": "<string>",
        "lastSeen": "2023-11-07T05:31:56Z",
        "properties": {}
      }
    ]
  }
}
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Query Parameters

​
source_node
integer
required

The ID of the starting node.

​
target_node
integer
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.

The response is of type object.