Skip to main content
GET
Unity Catalog sync state for a pipeline

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Path Parameters

name
string
required

Response

Sync state

pipeline
string
enabled
boolean
coordinates
object
state
enum<string>
Available options:
never,
synced,
error
lastSyncAt
string
lastRunId
string
commentsHash
string
tagsHash
string
propertiesHash
string
lastError
string
lineageEnabled
boolean

unityCatalog.enabled and the lineage knob (default on)

lineage
enum<string>
Available options:
off,
never,
published,
error
lineageHash
string

Hash of the last published lineage definition; null until published

lastLineageAt
string

ISO-8601 UTC time lineage was last published

registerEnabled
boolean

Object-store Iceberg destination with unityCatalog.enabled and the register knob (default on)

register
enum<string>

Iceberg register status. stale means Unity Catalog still points at an older metadata file of the table. With catalogMode: rest, rest means the last run committed through the catalog and refused means it wrote by path instead (see restRefusedReason).

Available options:
off,
never,
registered,
stale,
error,
rest,
refused
registeredMetadataLocation
string

The table's metadata file at the last register (or stale-pointer check); null until registered

lastRegisterAt
string

ISO-8601 UTC time the table was registered

catalogMode
enum<string>

The pipeline's unityCatalog.catalogMode (absent means register); object-store Iceberg only

Available options:
register,
rest
restMetadataLocation
string

The table's metadata file after the last commit through the catalog; null until then

lastRestCommitAt
string

ISO-8601 UTC time of the last commit through the catalog

restRefusedReason
string

Why the last catalogMode rest run wrote by path instead of through the catalog; null otherwise

restCreatedTable
string

catalog.schema.table of a table the catalog created for this pipeline at a location Datris refused (for example a Databricks managed table); never written to, still held by the catalog until an admin drops it. Null otherwise.