Find broken graph links

Find relation edges whose source or target row is missing. Results are returned in resumable pages.

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

Locate links with missing endpoint recordsContinue truncated scans before treating an empty page as an all-clear.

Select the relationSet scan budget and result limit.
Check link endpointsFind edges with missing source or target rows.
Continue from next_afterResume when the response reports truncation.

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
`budget`	`integer`	Optional
`limit`	`integer`	Optional
`after`	`string`	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.

Read the result

Read dangling for broken links. If truncated is true, continue with next_after; an empty page is not an all-clear when scanning stopped at a budget or page limit.

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.
413	Split or reduce the request body.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
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/dangling?rel=follows&budget=1000&limit=10" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "schema": "demo.people",
  "relation": "follows",
  "edge_model": "derived",
  "endpoints": [
    {
      "side": "target",
      "column": "follows_id",
      "target": "demo.people",
      "target_registered": true
    }
  ],
  "budget": 1000,
  "limit": 10,
  "scanned_rows": 3,
  "probes": 3,
  "dangling": [],
  "truncated": false,
  "truncated_by": null,
  "next_after": null
}

The seeded relation has registered targets; work counters are illustrative.

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