Graph
Community
Enterprise
Get the shortest path graph
A graph of the shortest path from start_node to end_node.
get/api/v2/graphs/shortest-path
Query parameters
start_nodestring required
The start node objectId
end_nodestring required
The end node objectId
relationship_kindsstring
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
Specific relationship kinds to include in the pathfinding search. If the kinds are not valid kinds, the query will error.
only_traversableboolean
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.