public-api
public-referential

Create Referential Check

Create a new referential integrity check.

Requires read-write or admin scope. Accepts asset UUID, qualified name (e.g., "postgresql.mydb"), or asset name.

SDK Usage:

from anomalyarmor import Client
client = Client()
check = client.referential.create(
    "asset-uuid",
    child_table_path="catalog.schema.orders",
    child_column_name="customer_id",
    parent_table_path="catalog.schema.customers",
    parent_column_name="id",
)
post/api/v1/sdk/referential/{asset_id}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/sdk/referential/{asset_id}
  • Auth: none declared

Path parameters

asset_idstring required

Headers

Authorizationstring

Request body

child_table_pathstring required

Fully qualified child table path

child_column_namestring required

FK column in child table

parent_table_pathstring required

Fully qualified parent table path

parent_column_namestring required

PK column in parent table

namestring nullable

Friendly name

descriptionstring nullable

Optional description

capture_intervalstring

Capture interval (hourly, daily, weekly, or cron)

max_orphan_countinteger nullable

Alert if orphan count exceeds this value

min_child_countinteger nullable

Each parent should have at least this many children

max_child_countinteger nullable

Each parent should have at most this many children

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.