Find a path

Reports whether one node can reach another along a relation within a depth limit.

GET /v1/tenants/{tenant}/graph/{schema}/path

Check whether one record reaches anotherA truncated search cannot prove that no path exists.

Select source and destinationChoose the relation and maximum search depth.
Check bounded reachabilityFollow links within the requested depth.
Read reachable and truncatedThis response does not contain an ordered route.

Before you start

Use your database bearer token.

Register the schema and relation, then add their rows. The examples use demo.people, its bidirectional follows relation, and linked rows u1, u2 and u3.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required

Query parameters

Field	Type	Required
`rel`	`string`	Required
`src`	`string`	Required
`dst`	`string`	Required
`max_depth`	`integer`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

reachable answers the reachability question within the requested depth. Check truncated before interpreting a negative result as proof that no path exists. This response does not contain an ordered path.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
408	Reduce query work or adjust the timeout.
429	Honor Retry-After when present; back off.
499	The client cancelled the request.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/graph/demo.people/path?rel=follows&src=u1&dst=u3&max_depth=3" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "max_depth": 3,
  "reachable": true,
  "truncated": false
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Query parameters

Headers

Read the result

Response statuses