> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datris.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Unity Catalog sync state for a pipeline

> Whether the pipeline opted into Unity Catalog sync, its three-level table coordinates (Databricks destinations, or the registered table of an object-store Iceberg destination with `unityCatalog.catalog` set), the last sync (`state` is `never`, `synced` or `error`), the lineage publish status (`lineage` is `off`, `never`, `published` or `error`; lineage failures appear in `lastError` as lines prefixed `uc-lineage:`), and the Iceberg register status (`register` is `off`, `never`, `registered`, `stale`, `error`, `rest` or `refused`; register warnings appear in `lastError` as lines prefixed `uc-register:`).



## OpenAPI

````yaml /openapi.yaml get /api/v1/pipelines/{name}/unity-catalog
openapi: 3.0.3
info:
  title: Datris API
  description: >
    REST API for the Datris AI Data Platform. Ingest, validate, transform,
    store, and retrieve data.


    For AI agent integration, use the [MCP
    Server](https://docs.datris.ai/mcp-server) instead.
  version: 1.28.0
  contact:
    name: Datris
    url: https://datris.ai
  license:
    name: Apache 2.0
servers:
  - url: http://localhost:8080
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /api/v1/pipelines/{name}/unity-catalog:
    get:
      tags:
        - Pipelines
      summary: Unity Catalog sync state for a pipeline
      description: >-
        Whether the pipeline opted into Unity Catalog sync, its three-level
        table coordinates (Databricks destinations, or the registered table of
        an object-store Iceberg destination with `unityCatalog.catalog` set),
        the last sync (`state` is `never`, `synced` or `error`), the lineage
        publish status (`lineage` is `off`, `never`, `published` or `error`;
        lineage failures appear in `lastError` as lines prefixed `uc-lineage:`),
        and the Iceberg register status (`register` is `off`, `never`,
        `registered`, `stale`, `error`, `rest` or `refused`; register warnings
        appear in `lastError` as lines prefixed `uc-register:`).
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sync state
          content:
            application/json:
              schema:
                type: object
                properties:
                  pipeline:
                    type: string
                  enabled:
                    type: boolean
                  coordinates:
                    type: object
                    properties:
                      catalog:
                        type: string
                      schema:
                        type: string
                      table:
                        type: string
                      qualified:
                        type: string
                      kind:
                        type: string
                        description: >-
                          `iceberg` for an object-store Iceberg table; absent
                          for Databricks
                      location:
                        type: string
                        description: >-
                          Table root of an object-store Iceberg table
                          (s3a://bucket/prefix)
                  state:
                    type: string
                    enum:
                      - never
                      - synced
                      - error
                  lastSyncAt:
                    type: string
                  lastRunId:
                    type: string
                  commentsHash:
                    type: string
                  tagsHash:
                    type: string
                  propertiesHash:
                    type: string
                  lastError:
                    type: string
                  lineageEnabled:
                    type: boolean
                    description: unityCatalog.enabled and the lineage knob (default on)
                  lineage:
                    type: string
                    enum:
                      - 'off'
                      - never
                      - published
                      - error
                  lineageHash:
                    type: string
                    description: >-
                      Hash of the last published lineage definition; null until
                      published
                  lastLineageAt:
                    type: string
                    description: ISO-8601 UTC time lineage was last published
                  registerEnabled:
                    type: boolean
                    description: >-
                      Object-store Iceberg destination with unityCatalog.enabled
                      and the register knob (default on)
                  register:
                    type: string
                    enum:
                      - 'off'
                      - never
                      - registered
                      - stale
                      - error
                      - rest
                      - refused
                    description: >-
                      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`).
                  registeredMetadataLocation:
                    type: string
                    description: >-
                      The table's metadata file at the last register (or
                      stale-pointer check); null until registered
                  lastRegisterAt:
                    type: string
                    description: ISO-8601 UTC time the table was registered
                  catalogMode:
                    type: string
                    enum:
                      - register
                      - rest
                    description: >-
                      The pipeline's unityCatalog.catalogMode (absent means
                      register); object-store Iceberg only
                  restMetadataLocation:
                    type: string
                    description: >-
                      The table's metadata file after the last commit through
                      the catalog; null until then
                  lastRestCommitAt:
                    type: string
                    description: ISO-8601 UTC time of the last commit through the catalog
                  restRefusedReason:
                    type: string
                    description: >-
                      Why the last catalogMode rest run wrote by path instead of
                      through the catalog; null otherwise
                  restCreatedTable:
                    type: string
                    description: >-
                      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.
        '404':
          description: Pipeline not configured
        '500':
          description: Error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Optional API key for authentication (enabled via application.yaml)

````