For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • POSTUpsert Schema Fields
      • DELDelete Schema Field
      • PATCHPatch Schema Field
      • PUTSet Primary Keys
      • DELReset Primary Keys
      • POSTRefresh Connection Schema
      • GETGet Schema Status
      • GETGet Schema
      • GETGet Schema Records
Logo
Log inBook a demo
API ReferenceSchemas

Refresh Connection Schema

POST
https://app.polytomic.com/api/connections/:id/schemas/refresh
POST
/api/connections/:id/schemas/refresh
$curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/refresh \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{}
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.
Was this page helpful?
Previous

Get Schema Status

Next

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 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. 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
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

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

Headers

X-Polytomic-VersionstringOptional

Response headers

locationstring

Response

Accepted

Errors

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