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

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/graphs/shortest-path
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

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.

Changes

No recorded changes to this operation across all 86 revisions of this API.