Altimate AI Databricks Warehouses API
The Databricks Warehouses API from Altimate AI — 14 operation(s) for databricks warehouses.
The Databricks Warehouses API from Altimate AI — 14 operation(s) for databricks warehouses.
openapi: 3.1.0
info:
title: Fast ACCOUNT_COSTS Databricks Warehouses API
version: 0.1.0
tags:
- name: Databricks Warehouses
paths:
/api/v1/databricks/warehouses/filters:
get:
tags:
- Databricks Warehouses
summary: Get filter options for warehouses
description: Get distinct filter values for warehouse filtering.
operationId: get_warehouse_filters_api_v1_databricks_warehouses_filters_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: prefix
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Search prefix for name filters
title: Prefix
description: Search prefix for name filters
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Workspace ID to filter by
title: Workspace Id
description: Workspace ID to filter by
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseFilterOptions'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses:
get:
tags:
- Databricks Warehouses
summary: Get all Databricks warehouses
description: Get list of all warehouses.
operationId: get_warehouses_api_v1_databricks_warehouses_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by workspace ID
title: Workspace Id
description: Filter by workspace ID
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: Start date (inclusive) for cost / utilization metrics. Defaults to 30 days before `end_date`.
title: Start Date
description: Start date (inclusive) for cost / utilization metrics. Defaults to 30 days before `end_date`.
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: End date (inclusive). Defaults to today.
title: End Date
description: End date (inclusive). Defaults to today.
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number (1-indexed)
default: 1
title: Page
description: Page number (1-indexed)
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Items per page
default: 20
title: Page Size
description: Items per page
- name: sortAttribute
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort column name. Valid columns: warehouse_name, workspace_name, warehouse_type, warehouse_size, min_num_clusters, max_num_clusters, auto_stop_mins, last_state_change, estimated_cost, auto_tune_savings (both sorted with nulls last).'
title: Sortattribute
description: 'Sort column name. Valid columns: warehouse_name, workspace_name, warehouse_type, warehouse_size, min_num_clusters, max_num_clusters, auto_stop_mins, last_state_change, estimated_cost, auto_tune_savings (both sorted with nulls last).'
- name: sortOrder
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Sort direction: ''asc'' or ''desc'''
title: Sortorder
description: 'Sort direction: ''asc'' or ''desc'''
- name: warehouse_names
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by warehouse names
title: Warehouse Names
description: Filter by warehouse names
- name: warehouse_types
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by warehouse types (CLASSIC, PRO, SERVERLESS)
title: Warehouse Types
description: Filter by warehouse types (CLASSIC, PRO, SERVERLESS)
- name: warehouse_sizes
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by warehouse sizes
title: Warehouse Sizes
description: Filter by warehouse sizes
- name: workspace_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Filter by one or more workspace IDs
title: Workspace Ids
description: Filter by one or more workspace IDs
- name: auto_tune_status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'Filter by auto-tune status: ''enabled'' or ''disabled''.'
title: Auto Tune Status
description: 'Filter by auto-tune status: ''enabled'' or ''disabled''.'
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehousesResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/total-savings:
get:
tags:
- Databricks Warehouses
summary: Get total auto-tune savings across SQL warehouses
description: 'Get the SQL warehouses list page''s "Total Savings" cards — Realised
Savings, Estimated Annual Savings, and Total Opportunities.
Declared before `/{warehouse_id}` so FastAPI''s declaration-order route
matching doesn''t swallow this path as a warehouse_id lookup.
Note: unlike the warehouses list, this aggregate only supports a single
``workspace_id`` — ``get_warehouse_savings_totals_by_type`` (the
underlying repo method, shared with ``DatabricksSavingsService``''s
other overall-savings endpoints) takes one workspace, not a list.'
operationId: get_warehouses_total_savings_api_v1_databricks_warehouses_total_savings_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by workspace ID
title: Workspace Id
description: Filter by workspace ID
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehousesTotalSavingsResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/cost-trends:
get:
tags:
- Databricks Warehouses
summary: Get warehouse cost trends by SKU
description: Get warehouse (SQL) cost trends over time broken down by SKU.
operationId: get_warehouse_cost_trends_api_v1_databricks_warehouses_cost_trends_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: granularity
in: query
required: false
schema:
type: string
description: Time granularity (day, week, month)
default: day
title: Granularity
description: Time granularity (day, week, month)
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by workspace ID
title: Workspace Id
description: Filter by workspace ID
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseCostTrendsResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/serverless-candidates:
get:
tags:
- Databricks Warehouses
summary: Get serverless migration candidates
description: Get warehouses that are candidates for serverless migration.
operationId: get_serverless_candidates_api_v1_databricks_warehouses_serverless_candidates_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: max_auto_stop_mins
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Maximum auto-stop time (minutes) for candidates. Warehouses with `auto_stop_mins <= this value` are returned — lower values yield a stricter filter. Defaults to 10 when neither this nor the deprecated `min_auto_stop_mins` alias is sent.
title: Max Auto Stop Mins
description: Maximum auto-stop time (minutes) for candidates. Warehouses with `auto_stop_mins <= this value` are returned — lower values yield a stricter filter. Defaults to 10 when neither this nor the deprecated `min_auto_stop_mins` alias is sent.
- name: min_auto_stop_mins
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: DEPRECATED — use `max_auto_stop_mins`. Kept for backward compat.
deprecated: true
title: Min Auto Stop Mins
description: DEPRECATED — use `max_auto_stop_mins`. Kept for backward compat.
deprecated: true
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by workspace ID
title: Workspace Id
description: Filter by workspace ID
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__databricks__warehouse__ServerlessCandidatesResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}:
get:
tags:
- Databricks Warehouses
summary: Get warehouse details
description: Get detailed information for a specific warehouse.
operationId: get_warehouse_detail_api_v1_databricks_warehouses__warehouse_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseDetail'
'403':
description: Not authorized
'404':
description: Warehouse not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/events:
get:
tags:
- Databricks Warehouses
summary: Get warehouse events
description: Get events for a specific warehouse.
operationId: get_warehouse_events_api_v1_databricks_warehouses__warehouse_id__events_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: event_type
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by event type (e.g., SCALED_UP, SCALED_DOWN)
title: Event Type
description: Filter by event type (e.g., SCALED_UP, SCALED_DOWN)
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseEventsResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/state-history:
get:
tags:
- Databricks Warehouses
summary: Get warehouse state history
description: Get state change history for a specific warehouse.
operationId: get_warehouse_state_history_api_v1_databricks_warehouses__warehouse_id__state_history_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseStateHistoryResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/cost:
get:
tags:
- Databricks Warehouses
summary: Get warehouse cost data
description: Get cost data for a specific warehouse.
operationId: get_warehouse_cost_api_v1_databricks_warehouses__warehouse_id__cost_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date for cost data
title: Start Date
description: Start date for cost data
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date for cost data
title: End Date
description: End date for cost data
- name: granularity
in: query
required: false
schema:
type: string
description: Time granularity (day, week, month)
default: day
title: Granularity
description: Time granularity (day, week, month)
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__databricks__warehouse__WarehouseCostResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/auto-tune/savings-trends:
get:
tags:
- Databricks Warehouses
summary: Get per-day auto-tune savings (realized + potential) for a SQL warehouse
description: 'Get realized and potential auto-tune savings per day for a SQL
warehouse, scoped to the warehouse''s auto-stop tuning.'
operationId: get_warehouse_auto_tune_savings_trends_api_v1_databricks_warehouses__warehouse_id__auto_tune_savings_trends_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: instance_id
in: query
required: true
schema:
type: integer
description: Databricks instance id
title: Instance Id
description: Databricks instance id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: granularity
in: query
required: false
schema:
type: string
description: 'Time granularity: ''day'', ''week'', or ''month'''
default: day
title: Granularity
description: 'Time granularity: ''day'', ''week'', or ''month'''
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseAutoTuneSavingsTrendsResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/auto-tune/savings-summary:
get:
tags:
- Databricks Warehouses
summary: Get realised savings range and estimated annual savings for a SQL warehouse
description: 'Get the "Realised Savings" range and "Estimated Annual Savings"
figure shown above a SQL warehouse''s detail tabs. Realised savings are
summed over ``[start_date, end_date]``; the annual estimate annualizes a
trailing 29-day actual+potential run-rate independent of that range.'
operationId: get_warehouse_auto_tune_savings_summary_api_v1_databricks_warehouses__warehouse_id__auto_tune_savings_summary_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: instance_id
in: query
required: true
schema:
type: integer
description: Databricks instance id
title: Instance Id
description: Databricks instance id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseAutoTuneSavingsSummaryResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/running-stats-trends:
get:
tags:
- Databricks Warehouses
summary: Get warehouse running stats trends
description: Get daily active/idle time trends for a specific warehouse.
operationId: get_warehouse_running_stats_trends_api_v1_databricks_warehouses__warehouse_id__running_stats_trends_get
deprecated: true
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/app__schemas__databricks__warehouse__WarehouseRunningStatsTrendsResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/utilization-efficiency:
get:
tags:
- Databricks Warehouses
summary: Get warehouse utilization efficiency
description: Get daily utilization efficiency (0-1) for a specific warehouse.
operationId: get_warehouse_utilization_efficiency_api_v1_databricks_warehouses__warehouse_id__utilization_efficiency_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
description: Start date
- name: end_date
in: query
required: false
schema:
type: string
format: date
description: End date
title: End Date
description: End date
- name: navigationSource
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Navigationsource
- name: x-tenant
in: header
required: true
schema:
type: string
title: X-Tenant
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseUtilizationEfficiencyResponse'
'403':
description: Not authorized
'404':
description: No ClickHouse database configured
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/databricks/warehouses/{warehouse_id}/query-metrics-timeline:
get:
tags:
- Databricks Warehouses
summary: Get time-bucketed query metrics timeline for a warehouse
description: 'Get the time-bucketed metrics timeline powering the SQL warehouse
Monitoring page''s stacked charts (latency, queueing, scan size, cache
hit rate, spill).
Hybrid-sourced: historical buckets come from the ClickHouse mirror,
and the fresh tail the mirror hasn''t ingested yet (up to ~24h) is
read live from Databricks system tables via the Statement Execution
API against the tenant''s ingestion SQL warehouse — this will
auto-start that warehouse if it is currently suspended. A live-tail
failure degrades to a ClickHouse-only response rather than erroring.
The lookback window is capped at ``MAX_MONITORING_LOOKBACK_DAYS`` days
regardless of what''s requested — ``end_date`` is clamped to today and
``start_date`` is clamped to ``end_date - MAX_MONITORING_LOOKBACK_DAYS``
(silently, not a 400; the frontend''s date-range picker clamps to the
same bound).'
operationId: get_warehouse_query_metrics_timeline_api_v1_databricks_warehouses__warehouse_id__query_metrics_timeline_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: warehouse_id
in: path
required: true
schema:
type: string
title: Warehouse Id
- name: start_date
in: query
required: true
schema:
type: string
format: date
description: Start date
title: Start Date
descripti
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-databricks-warehouses-api-openapi.yml