Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Warehouse Imports

Update a warehouse import

Update an existing warehouse import's settings.

Patchable Fields

The following fields can be modified:

  • paused (boolean, required): Pause or resume the import sync
  • run_every (integer): Sync frequency in nanoseconds. Must be one of the following values:
    • 0: API-triggered only (no scheduled sync)
    • 3600000000000: Hourly
    • 86400000000000: Daily
    • 604800000000000: Weekly
  • databricks_params (object): Databricks-specific cluster configuration (only for Databricks sources). Note: this is a full replacement, not a partial merge. Always provide the complete desired cluster configuration.

Pause/Resume Behavior

  • When paused: true, the import job will be stopped and no new syncs will be triggered
  • When paused: false, the import job will be resumed with the specified frequency
  • When resuming, you can optionally update run_every

Databricks Configuration

For Databricks Jobs compute imports, you can update cluster configurations:

  • export_cluster_config: Configuration for the data export job cluster
patch/projects/{projectId}/warehouse-sources/imports/{importId}

Path parameters

projectIdinteger required

Your project id (eg: 12345)

importIdinteger required

Your warehouse import id (eg: 12345)

Request body

pausedboolean required

Whether to pause (true) or resume (false) the import

run_every0 | 3600000000000 | 86400000000000 | 604800000000000 required

Sync frequency in nanoseconds. Only these values are accepted:

  • 0 - API-triggered only (use the manual-sync endpoint to trigger)
  • 3600000000000 - Hourly
  • 86400000000000 - Daily
  • 604800000000000 - Weekly

Response

Success

status'ok'

"ok" if the request succeeded, "error" otherwise.

Example response

{
  "status": "ok"
}