---
title: "Toggle Auto Tune for an all-purpose cluster (master or sub-toggle)"
method: PATCH
path: "/api/v1/databricks/clusters/{cluster_id}/auto-tune/toggle"
tags: ["DATABRICKS", "Databricks", "Databricks Clusters"]
deprecated: true
---

# Toggle Auto Tune for an all-purpose cluster (master or sub-toggle)

`PATCH /api/v1/databricks/clusters/{cluster_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/clusters/{cluster_id}/auto-tune/toggle`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

> **Deprecated.**

Enable/disable Auto Tune for the cluster. ``rec_type=None`` is the
master toggle (flips both sub-toggles). Records config + audit only;
no Databricks edit. On enable, the cluster permission preflight runs
first and blocks the write if the SP can't manage the cluster.

## Path parameters

- `cluster_id` string, required

## Query parameters

- `instance_id` integer, required: Tenant instance ID (workspace)
- `workspace_id` string, nullable: Optional Databricks workspace_id to scope the lookup.
- `navigationSource` string, nullable

## Headers

- `x-tenant` string, required

## Request body

- ClusterAutoTuneToggleRequest: Request body for ``PATCH /databricks/clusters/{id}/auto-tune/toggle``. ``rec_type=None`` is the master toggle — it flips ALL sub-toggles (``resize`` + ``auto_terminate`` + ``autoscale`` + ``family_change``) to ``enabled``. A specific ``rec_type`` flips only that sub-toggle. Nothing is applied to Databricks; the call records the config change + an audit event.
  - `enabled` boolean, required: Desired state for the toggle.
  - `rec_type` 'resize' | 'auto_terminate' | 'autoscale' | 'family_change', nullable: Which sub-toggle to flip. None = master toggle (flips all cluster axes: Worker Sizing, Auto Termination, Enable Autoscaling, Instance Family).

## Response `200`

Successful Response

- ClusterAutoTuneToggleResponse: Response for the cluster Auto Tune toggle endpoint. Returns the resolved master ``auto_tune_mode`` so the FE can re-render the header pill without a second round-trip.
  - `auto_tune_mode` string, nullable
  - `audit_event_id` integer, nullable
  - `entity_name` string, nullable
  - `preflight` ToggleAutoTunePreflight: Surfaced to the FE so it can render an actionable error inline. When ``blocked=False`` the toggle pipeline ran. When ``blocked=True`` no DB writes happened and ``actionable_message`` should be shown to the user verbatim (e.g. "ask your workspace admin to add r5.xlarge to the policy allowlist").
    - `blocked` boolean
    - `reason` string, nullable
    - `actionable_message` string, nullable
    - `can_manage_blocked` boolean
    - `turn_off_allowed` boolean
  - `rolled_back_rec_types` string[]

## Other responses

- `403`: Not authorized
- `422`: Validation Error

## Changes

- **2026-10-14** `1b2d675195d7`: 1 info
  - added the optional property `preflight/turn_off_allowed` to the response with the `200` status
- **2026-09-30** `a1870d258a3a`: 1 info
  - added the optional property `preflight/can_manage_blocked` to the response with the `200` status
- **2026-09-02** `fcb62c79da95`: 2 info
  - added the new `autoscale` enum value to the request property `rec_type/anyOf[subschema #1]/`
  - added the new `family_change` enum value to the request property `rec_type/anyOf[subschema #1]/`

[Operation history](https://skmtc.dev/myaltimate/apis/myaltimate-api/changes/api/v1/databricks/clusters/:cluster_id/auto-tune/toggle/patch.md)

---

[API](https://skmtc.dev/myaltimate/apis/myaltimate-api.md) - [All operations](https://skmtc.dev/myaltimate/apis/myaltimate-api/llms.txt) - [OpenAPI document](https://skmtc.dev/myaltimate/apis/myaltimate-api/revisions/727657ce54e9?raw)