Get the shortest path graph

A graph of the shortest path from start_node to end_node.

GET /api/v2/graphs/shortest-path

Get the shortest path graph

cURL

curl --request GET \
  --url https://bloodhound.specterops.io/openapi.json/api/v2/graphs/shortest-path \
  --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.

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

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

200

application/json

A graph of the shortest path from start_node to end_node.

data · object

Show child attributes