Refresh Connection Schema

Refreshes a connection's cached schemas. Call this when the upstream source has added, removed, or changed tables, objects, or fields and you need Polytomic to re-inspect the connection before creating or updating sync configuration. This endpoint does not return the refreshed schemas directly. Follow the `Location` header or poll [`GET /api/connections/{id}/schemas/status`](../../../../../api-reference/schemas/get-status) until the refresh completes, then fetch the schemas you need. > 📘 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

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 should be refreshed.

Headers

X-Polytomic-VersionstringRequired

Response headers

locationstring

Response

Accepted

Errors

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