Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Schemas

Get Schema Status

Returns the current schema inspection status for a connection.

Poll this endpoint after calling POST /api/connections/{id}/schemas/refresh to track progress. When status transitions to completed, the refreshed schemas are available for use in sync configuration.

📘 Schema refresh is asynchronous

This endpoint kicks off a background refresh of the connection's cached schemas and returns a Location header pointing at GET /api/connections/{id}/schemas/status. Poll that endpoint until cache_status transitions from refreshing to fresh (or until last_refresh_finished advances past last_refresh_started) to observe completion.

Only connections whose current health status is healthy may be refreshed.

get/api/connections/{id}/schemas/status

Path parameters

idstring uuid required

Unique identifier of the connection whose schema cache status should be returned.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the connection whose schema cache status should be returned.

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "cache_status": "cached",
    "last_refresh_finished": "2023-04-25T12:00:00Z",
    "last_refresh_started": "2023-04-25T12:00:00Z"
  }
}