Get Schema Status | Polytomic Docs

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.

Returns the current schema inspection status for a connection. Poll this endpoint after calling [`POST /api/connections/{id}/schemas/refresh`](../../../../../api-reference/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`](../../../../../api-reference/schemas/get-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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

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

Response

dataobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error