Skip to main content

OntologyHealthResponse

Ontology consistency status for the complete set of ontology query surfaces, with resynchronization, orphan cleanup, and schema-drift details.

statusStatus (string)required

Mirror health status

Possible values: [ok, degraded]

marker object

Degraded marker body when status=degraded

anyOf
statusStatus (string)
Constant value: degraded
Default value: degraded
sinkSink (string)required
slotSlot (string)required
reasonReason (string)required
confirmed_flush_lsn object
anyOf
string
invalidated_atInvalidated At (integer)required
resync objectrequired

Resync flow run state

activeActive (boolean)required

True when a resync flow run is in flight

run_id object

Run id of the active run

anyOf
string
state object

Run state of the active run

anyOf
string
orphans object

Orphan-table detection marker; null when none

anyOf
statusStatus (string)
Default value: orphans_detected
countCount (integer)required
detected_atDetected At (integer)required

Unix time in milliseconds when orphaned resources were detected.

orphans object[]required
  • Array [
    • schema_nameSchema Name (string)required
    table_nameTable Name (string)required
    first_seenFirst Seen (integer)required
  • ]
    • orphan_cleanup object

    Orphan cleanup flow run state

    activeActive (boolean)required

    True when a cleanup flow run is in flight

    run_id object

    Run id of the active run

    anyOf
    string
    state object

    Run state of the active run

    anyOf
    string
    schema_drift object

    Detected schema drift, or null when none exists. Remediation requires recreation or a manual migration.

    anyOf
    statusStatus (string)
    Default value: schema_drift_detected
    countCount (integer)required
    detected_atDetected At (integer)required

    Unix time in milliseconds when schema drift was detected.

    drifts object[]required
  • Array [
    • resource_idResource Id (string)required
    schema_nameSchema Name (string)required
    table_nameTable Name (string)required
    missing_columnsstring[]
    Default value: []
    type_mismatchesstring[]
    Default value: []
    first_seenFirst Seen (integer)required
  • ]
    • OntologyHealthResponse
    {
      "status": "ok",
      "marker": {
        "status": "degraded",
        "sink": "string",
        "slot": "string",
        "reason": "string",
        "confirmed_flush_lsn": "string",
        "invalidated_at": 0
      },
      "resync": {
        "active": true,
        "run_id": "string",
        "state": "string"
      },
      "orphans": {
        "status": "orphans_detected",
        "count": 0,
        "detected_at": 0,
        "orphans": [
          {
            "schema_name": "string",
            "table_name": "string",
            "first_seen": 0
          }
        ]
      },
      "orphan_cleanup": {
        "active": true,
        "run_id": "string",
        "state": "string"
      },
      "schema_drift": {
        "status": "schema_drift_detected",
        "count": 0,
        "detected_at": 0,
        "drifts": [
          {
            "resource_id": "string",
            "schema_name": "string",
            "table_name": "string",
            "missing_columns": [
              "string"
            ],
            "type_mismatches": [
              "string"
            ],
            "first_seen": 0
          }
        ]
      }
    }