Skip to main content
GET
/
api
/
v2
/
graphs
/
shortest-path
Get the shortest path graph
curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/graphs/shortest-path \
  --header 'Authorization: Bearer <token>'
{
  "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
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

​
start_node
string
required

The start node objectId

​
end_node
string
required

The end node objectId

​
relationship_kinds
string

Specific relationship kinds to include in the pathfinding search. If the kinds are not valid kinds, the query will error. 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
Pattern: ^(in|nin):(\w+)(,\s*\w+)*$
​
only_traversable
boolean

Whether or not to only include traversable kinds. If true and no relationship_kinds are specified, all traversable kinds will be searched. If true, and relationship_kinds param includes non-traversable kinds, the non-traversable kinds will be excluded from the path search. If false or omitted, all kinds will be searched.

Response

A graph of the shortest path from start_node to end_node.

​
data
object