Skip to main content

RecordCatalogSync

POST 
/v1/catalog/sync-state

RecordCatalogSync persists what the last catalog sync saw and did.

A sync runs in the client: it fetches a published catalog, compares it with this management plane and writes the difference. The catalog version that drove a run is only known to that client, and a report-only run changes nothing the server could observe, so a run reports itself here.

How the record advances:

  • checked_at / checked_version advance on every recorded run, including report-only ones. They say when this plane last looked at a published catalog, and which one.
  • applied_at / applied_version advance only when applied is set, which means the run wrote the catalog and left nothing unwritten. They say which published catalog this plane is actually on.

The two together are the drift an operator acts on: the published catalog is at version X, this plane is on version Y, applied N days ago.

Request​

Responses​

Success