Trigger Lineage Sync

POST

/api/v1/lineage/sync

curl --request POST \
  --url 'https://example.com/api/v1/lineage/sync?sync_type=full'

Trigger on-demand lineage synchronization from Databricks system tables.

This endpoint triggers a manual sync of lineage data from Databricks system tables to the local PostgreSQL database for faster lookups and offline access.

Works independently of the background sync worker - you don’t need to enable ENABLE_LINEAGE_BACKGROUND_SYNC to use this endpoint.

Args: sync_type: Type of sync - ‘full’ (both table and column), ‘table’, or ‘column’ scope: Optional scope filter (future enhancement for specific catalogs/tables)

Returns: Sync operation results including counts and duration

Parameters

Query Parameters

sync_type

Sync Type

Type of sync: ‘full’, ‘table’, ‘column’

string

default: full

Type of sync: ‘full’, ‘table’, ‘column’

scope

Any of:

string

string

null

null

Optional scope filter (e.g., catalog or table pattern)

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

202

Successful Response

Media typeapplication/json

Example^generated

example

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}