Skip to main content
POST
Refresh schema

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId
string<uuid>
required

The ID of the model to be refreshed.

Query Parameters

branch_id
string<uuid>

Required if Branch-based schema refresh is enabled. The ID of the branch for models with this setting enabled.

Do not provide this parameter when the setting is not enabled.

hard_refresh
boolean
default:true

Whether to perform a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to true (hard refresh).

When combined with schemas or tables, a hard refresh is scoped to the selection: dropped objects are removed only inside the selected schemas or tables, and the rest of the model is left untouched.

schemas
string

Comma-separated list of schemas to selectively refresh. Only the listed schemas are reloaded; the rest of the model is preserved.

Unless hard_refresh=false is also set, objects inside the selected schemas that are no longer present in the data source are removed.

tables
string

Comma-separated list of tables to selectively refresh. Only the listed tables are reloaded; the rest of the model is preserved.

Unless hard_refresh=false is also set, objects inside the selected tables that are no longer present in the data source are removed.

Response

Model refresh started

jobId
string<uuid>

ID of the job.

modelId
string<uuid>

ID of the model.

status
string

Status of the schema refresh. This value will be running to indicate that the refresh has started.

Example:

"running"