GET
/
api
/
v2
/
graphs
/
shortest-path
{
  "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

​
start_node
string
required

The start node objectId

​
end_node
string
required

The end node objectId

​
relationship_kinds
string

The contains predicate checks a property against the values in a given comma separated list.

  • in checks if the property matches an element in the given comma separated list.
    • in:Contains,GetChangesAll,MemberOf
  • nin checks if the property does not match an element in the given comma separated list.
    • nin:LocalToComputer,MemberOfLocalGroup

Response

200
application/json

A graph of the shortest path from start_node to end_node.

The response is of type object.