Skip to navigation

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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection whose schema cache status should be returned.

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error