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

Get Schema Status

GET
https://app.polytomic.com/api/connections/:id/schemas/status
GET
/api/connections/:id/schemas/status
$curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/status \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "cache_status": "cached",
4    "last_refresh_finished": "2023-04-25T12:00:00Z",
5    "last_refresh_started": "2023-04-25T12:00:00Z"
6  }
7}
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.
Was this page helpful?
Previous

Get Schema

Next

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

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

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

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

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