DATABRICKS
Databricks
Databricks Warehouses

Enable or disable auto-tune for a SQL warehouse

Changed on

Enable or disable auto-tune for a serverless SQL warehouse.

Applies inline and synchronously — unlike the job-cluster toggle, a warehouse /edit drains gracefully, so there is no async worker hand-off. See app.service.databricks.auto_tune.warehouse_toggle for the full enable/disable flow (recommendation resolution, write-once baseline capture, and the audit trail written).

post/api/v1/databricks/warehouses/{warehouse_id}/auto-tune/toggle

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/api/v1/databricks/warehouses/{warehouse_id}/auto-tune/toggle
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

warehouse_idstring required

Headers

x-tenantstring required

Request body

enabledboolean required

Desired auto-tune state for the warehouse.

instance_idinteger required

Tenant instance ID (workspace) the warehouse runs in.

workspace_idstring required

Required Databricks workspace_id. Scopes credential resolution to the correct workspace on multi-workspace tenants (defends against cross-workspace warehouse_id collisions) AND is the join key the ingestion cost-savings mart (mrt_auto_tune_cost_savings) uses to attribute realized savings on (workspace_id, entity_id). An empty or mismatched value silently drops all actual savings for this warehouse.

rec_type'resize' | 'auto_terminate'

Which axis this toggle targets. Defaults to auto_terminate so every existing caller is unaffected — this is NOT a master toggle that flips both axes (contrast the all-purpose-cluster path's rec_type=None semantics).

Response

Successful Response

auto_tune_mode'enabled' | 'disabled' required
appliedboolean

True iff this call actually mutated the live warehouse.

auto_stop_mins_frominteger nullable
auto_stop_mins_tointeger nullable
blockedboolean

True iff the requested action could not proceed (see reason).

reasonstring nullable
audit_event_idsinteger[]

Changes

  • a1870d258a3aRevision changes
    • breaking

      the request property const value rollback was added

    • breaking

      request property // list-of-types was narrowed by removing types null from media type application/json

    • info

      the request property default value rollback was added

  • fcb62c79da95Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property