openapi: 3.1.0 info: title: Azure Databricks REST API description: >- Core REST API for managing Azure Databricks workspaces, clusters, jobs, and workspace objects programmatically. This specification covers the Clusters API (2.0), Jobs API (2.1), and Workspace API (2.0) endpoints available on Azure Databricks instances. version: 2.1.0 contact: name: Azure Databricks Support url: https://learn.microsoft.com/answers/tags/166/azure-databricks license: name: Microsoft Azure Terms url: https://azure.microsoft.com/en-us/support/legal/ x-apiReferenceDocumentation: https://docs.databricks.com/api/azure/workspace/introduction servers: - url: https://{databricks_instance}.azuredatabricks.net/api description: Azure Databricks workspace instance variables: databricks_instance: default: adb-1234567890123456.1 description: >- The unique identifier for your Azure Databricks workspace instance. Found in the workspace URL. security: - BearerAuth: [] - AzureADToken: [] tags: - name: Clusters description: >- Manage Databricks clusters for running Apache Spark workloads. Create, start, restart, resize, terminate, and permanently delete clusters. externalDocs: description: Clusters API reference url: https://docs.databricks.com/api/azure/workspace/clusters - name: Jobs description: >- Create and manage jobs to run notebooks, JARs, Spark submit, Python scripts, and pipeline tasks on Databricks clusters. Schedule recurring jobs, trigger runs, and monitor execution. externalDocs: description: Jobs API reference url: https://docs.databricks.com/api/azure/workspace/jobs - name: Workspace description: >- Manage workspace objects such as notebooks, folders, files, and repos. Import, export, list, and delete workspace objects. externalDocs: description: Workspace API reference url: https://docs.databricks.com/api/azure/workspace/workspace paths: /2.0/clusters/create: post: operationId: createCluster summary: Azure Databricks Create a New Cluster description: >- Creates a new Apache Spark cluster. Returns the ID of the newly created cluster. The cluster starts in a PENDING state and transitions to RUNNING when ready. Optionally, you can attach libraries to the cluster after creation. tags: - Clusters requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateClusterRequest' examples: CreateclusterRequestExample: summary: Default createCluster request x-microcks-default: true value: cluster_name: example_value spark_version: example_value node_type_id: '500123' driver_node_type_id: '500123' num_workers: 10 autoscale: min_workers: 10 max_workers: 10 spark_conf: example_value azure_attributes: first_on_demand: 10 availability: SPOT_AZURE spot_bid_max_price: 42.5 ssh_public_keys: - example_value custom_tags: example_value cluster_log_conf: dbfs: destination: example_value s3: destination: example_value region: example_value endpoint: example_value init_scripts: - workspace: {} volumes: {} dbfs: {} abfss: {} spark_env_vars: example_value enable_elastic_disk: true instance_pool_id: '500123' policy_id: '500123' enable_local_disk_encryption: true runtime_engine: STANDARD data_security_mode: NONE single_user_name: example_value responses: '200': description: Cluster created successfully content: application/json: schema: type: object properties: cluster_id: type: string description: Canonical identifier for the newly created cluster examples: - "1234-567890-abcde123" examples: Createcluster200Example: summary: Default createCluster 200 response x-microcks-default: true value: cluster_id: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/edit: post: operationId: editCluster summary: Azure Databricks Edit a Cluster description: >- Edits the configuration of an existing cluster. The cluster must be in a RUNNING or TERMINATED state. If the cluster is running, it will be restarted with the new configuration. tags: - Clusters requestBody: required: true content: application/json: schema: allOf: - type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to edit - $ref: '#/components/schemas/CreateClusterRequest' examples: EditclusterRequestExample: summary: Default editCluster request x-microcks-default: true value: {} responses: '200': description: Cluster edited successfully content: application/json: schema: type: object examples: Editcluster200Example: summary: Default editCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/start: post: operationId: startCluster summary: Azure Databricks Start a Terminated Cluster description: >- Starts a terminated cluster given its ID. Works only for clusters in a TERMINATED state. Uses the last specified cluster configuration. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to start examples: StartclusterRequestExample: summary: Default startCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster start initiated successfully content: application/json: schema: type: object examples: Startcluster200Example: summary: Default startCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/restart: post: operationId: restartCluster summary: Azure Databricks Restart a Running Cluster description: >- Restarts a running cluster given its ID. The cluster must be in a RUNNING state. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to restart examples: RestartclusterRequestExample: summary: Default restartCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster restart initiated successfully content: application/json: schema: type: object examples: Restartcluster200Example: summary: Default restartCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/delete: post: operationId: terminateCluster summary: Azure Databricks Terminate a Cluster description: >- Terminates a cluster given its ID. The cluster is removed from the running state but its configuration is preserved so it can be restarted. Use permanent-delete to fully remove a cluster. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to terminate examples: TerminateclusterRequestExample: summary: Default terminateCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster termination initiated successfully content: application/json: schema: type: object examples: Terminatecluster200Example: summary: Default terminateCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/permanent-delete: post: operationId: permanentDeleteCluster summary: Azure Databricks Permanently Delete a Cluster description: >- Permanently deletes a Spark cluster. If the cluster is running, it is terminated and its resources freed. The cluster is removed permanently and cannot be restarted. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to permanently delete examples: PermanentdeleteclusterRequestExample: summary: Default permanentDeleteCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster permanently deleted content: application/json: schema: type: object examples: Permanentdeletecluster200Example: summary: Default permanentDeleteCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/get: get: operationId: getCluster summary: Azure Databricks Get Cluster Information description: >- Retrieves the information for a cluster given its identifier. Returns the current state, configuration, and metadata for the cluster. tags: - Clusters parameters: - name: cluster_id in: query required: true description: The cluster about which to retrieve information schema: type: string example: '500123' responses: '200': description: Cluster information retrieved successfully content: application/json: schema: $ref: '#/components/schemas/ClusterInfo' examples: Getcluster200Example: summary: Default getCluster 200 response x-microcks-default: true value: cluster_id: '500123' cluster_name: example_value spark_version: example_value node_type_id: '500123' driver_node_type_id: '500123' num_workers: 10 autoscale: min_workers: 10 max_workers: 10 state: PENDING state_message: example_value creator_user_name: example_value start_time: 10 terminated_time: 10 last_state_loss_time: 10 last_activity_time: 10 autotermination_minutes: 10 cluster_source: UI spark_conf: example_value azure_attributes: first_on_demand: 10 availability: SPOT_AZURE spot_bid_max_price: 42.5 custom_tags: example_value cluster_log_conf: dbfs: destination: example_value s3: destination: example_value region: example_value endpoint: example_value init_scripts: - workspace: {} volumes: {} dbfs: {} abfss: {} spark_env_vars: example_value enable_elastic_disk: true instance_pool_id: '500123' policy_id: '500123' default_tags: example_value cluster_log_status: last_attempted: 10 last_exception: example_value termination_reason: code: example_value type: example_value parameters: example_value data_security_mode: example_value single_user_name: example_value runtime_engine: example_value disk_spec: disk_count: 10 disk_size: 10 disk_type: azure_disk_volume_type: example_value executors: - private_ip: example_value public_dns: example_value node_id: '500123' instance_id: '500123' start_timestamp: 10 host_private_ip: example_value driver: private_ip: example_value public_dns: example_value node_id: '500123' instance_id: '500123' start_timestamp: 10 host_private_ip: example_value jdbc_port: 10 cluster_memory_mb: 10 cluster_cores: 42.5 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/list: get: operationId: listClusters summary: Azure Databricks List All Clusters description: >- Returns information about all pinned and active clusters, and up to 200 of the most recently terminated all-purpose clusters in the past 30 days, and up to 30 of the most recently terminated job clusters in the past 30 days. tags: - Clusters parameters: - name: can_use_client in: query required: false description: >- Filter clusters based on what type of client can use the cluster. Possible values are NOTEBOOKS and JOBS. schema: type: string example: example_value responses: '200': description: List of clusters retrieved successfully content: application/json: schema: type: object properties: clusters: type: array description: List of cluster information objects items: $ref: '#/components/schemas/ClusterInfo' examples: Listclusters200Example: summary: Default listClusters 200 response x-microcks-default: true value: clusters: - cluster_id: '500123' cluster_name: example_value spark_version: example_value node_type_id: '500123' driver_node_type_id: '500123' num_workers: 10 state: PENDING state_message: example_value creator_user_name: example_value start_time: 10 terminated_time: 10 last_state_loss_time: 10 last_activity_time: 10 autotermination_minutes: 10 cluster_source: UI spark_conf: example_value custom_tags: example_value init_scripts: - {} spark_env_vars: example_value enable_elastic_disk: true instance_pool_id: '500123' policy_id: '500123' default_tags: example_value cluster_log_status: last_attempted: 10 last_exception: example_value termination_reason: code: example_value type: example_value parameters: example_value data_security_mode: example_value single_user_name: example_value runtime_engine: example_value disk_spec: disk_count: 10 disk_size: 10 disk_type: {} executors: - {} jdbc_port: 10 cluster_memory_mb: 10 cluster_cores: 42.5 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/pin: post: operationId: pinCluster summary: Azure Databricks Pin a Cluster description: >- Pins a cluster to ensure it is always returned by the list clusters API. Pinning a cluster that is already pinned has no effect. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to pin examples: PinclusterRequestExample: summary: Default pinCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster pinned successfully content: application/json: schema: type: object examples: Pincluster200Example: summary: Default pinCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/unpin: post: operationId: unpinCluster summary: Azure Databricks Unpin a Cluster description: >- Unpins a cluster. Unpinning a cluster that is not pinned has no effect. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to unpin examples: UnpinclusterRequestExample: summary: Default unpinCluster request x-microcks-default: true value: cluster_id: '500123' responses: '200': description: Cluster unpinned successfully content: application/json: schema: type: object examples: Unpincluster200Example: summary: Default unpinCluster 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/events: post: operationId: listClusterEvents summary: Azure Databricks List Cluster Events description: >- Retrieves a list of events about the activity of a cluster. Events are returned in reverse chronological order. This endpoint allows paginating through cluster events using the next_page field. tags: - Clusters requestBody: required: true content: application/json: schema: type: object required: - cluster_id properties: cluster_id: type: string description: ID of the cluster to retrieve events about start_time: type: integer format: int64 description: >- Start timestamp in epoch milliseconds. If empty, returns events starting from the beginning of time. end_time: type: integer format: int64 description: >- End timestamp in epoch milliseconds. If empty, returns events up to the current time. order: type: string enum: - DESC - ASC description: Sort order by timestamp. Default is DESC. event_types: type: array items: type: string enum: - CREATING - DID_NOT_EXPAND_DISK - EXPANDED_DISK - FAILED_TO_EXPAND_DISK - INIT_SCRIPTS_STARTED - INIT_SCRIPTS_FINISHED - STARTING - RESTARTING - TERMINATING - EDITED - RUNNING - RESIZING - UPSIZE_COMPLETED - NODES_LOST - DRIVER_HEALTHY - DRIVER_NOT_RESPONDING - DRIVER_UNAVAILABLE - SPARK_EXCEPTION - PINNED - UNPINNED description: Filter by event types offset: type: integer format: int64 description: Offset for pagination limit: type: integer format: int64 description: >- Maximum number of events to return. Default and maximum value is 50. examples: ListclustereventsRequestExample: summary: Default listClusterEvents request x-microcks-default: true value: cluster_id: '500123' start_time: 10 end_time: 10 order: DESC event_types: - CREATING offset: 10 limit: 10 responses: '200': description: Cluster events retrieved successfully content: application/json: schema: type: object properties: events: type: array items: $ref: '#/components/schemas/ClusterEvent' next_page: type: object description: Parameters for fetching the next page of events total_count: type: integer format: int64 description: Total number of events matching the filter examples: Listclusterevents200Example: summary: Default listClusterEvents 200 response x-microcks-default: true value: events: - cluster_id: '500123' timestamp: 10 type: example_value details: example_value next_page: example_value total_count: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/spark-versions: get: operationId: listSparkVersions summary: Azure Databricks List Available Spark Versions description: >- Returns the list of available Databricks Runtime versions. These versions can be used to launch clusters. tags: - Clusters responses: '200': description: Spark versions retrieved successfully content: application/json: schema: type: object properties: versions: type: array items: type: object properties: key: type: string description: Databricks Runtime version key name: type: string description: Human-readable name for the version examples: Listsparkversions200Example: summary: Default listSparkVersions 200 response x-microcks-default: true value: versions: - key: example_value name: Example Title '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/clusters/list-node-types: get: operationId: listNodeTypes summary: Azure Databricks List Available Node Types description: >- Returns a list of supported Azure VM node types. These node types can be used to launch clusters. tags: - Clusters responses: '200': description: Node types retrieved successfully content: application/json: schema: type: object properties: node_types: type: array items: $ref: '#/components/schemas/NodeType' examples: Listnodetypes200Example: summary: Default listNodeTypes 200 response x-microcks-default: true value: node_types: - node_type_id: '500123' memory_mb: 10 num_cores: 42.5 description: A sample description. instance_type_id: '500123' is_deprecated: true num_gpus: 10 category: example_value '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/create: post: operationId: createJob summary: Azure Databricks Create a New Job description: >- Creates a new job with the provided settings. Returns the job_id of the newly created job. tags: - Jobs requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/JobSettings' examples: CreatejobRequestExample: summary: Default createJob request x-microcks-default: true value: name: Example Title tags: example_value tasks: - task_key: example_value description: A sample description. depends_on: {} existing_cluster_id: '500123' job_cluster_key: example_value notebook_task: {} spark_jar_task: {} spark_python_task: {} spark_submit_task: {} pipeline_task: {} python_wheel_task: {} sql_task: {} dbt_task: {} run_if: ALL_SUCCESS timeout_seconds: 10 max_retries: 10 min_retry_interval_millis: 10 retry_on_timeout: true libraries: {} job_clusters: - job_cluster_key: example_value email_notifications: on_start: - {} on_success: - {} on_failure: - {} on_duration_warning_threshold_exceeded: - {} no_alert_for_skipped_runs: true webhook_notifications: on_start: - {} on_success: - {} on_failure: - {} on_duration_warning_threshold_exceeded: - {} notification_settings: no_alert_for_skipped_runs: true no_alert_for_canceled_runs: true timeout_seconds: 10 max_concurrent_runs: 10 schedule: quartz_cron_expression: example_value timezone_id: '500123' pause_status: PAUSED trigger: file_arrival: url: https://www.example.com min_time_between_triggers_seconds: 10 wait_after_last_change_seconds: 10 continuous: pause_status: PAUSED git_source: git_url: https://www.example.com git_provider: gitHub git_branch: example_value git_tag: example_value git_commit: example_value format: SINGLE_TASK queue: enabled: true parameters: - name: Example Title default: example_value run_as: user_name: example_value service_principal_name: example_value responses: '200': description: Job created successfully content: application/json: schema: type: object properties: job_id: type: integer format: int64 description: Canonical identifier for the newly created job examples: - 11223344 examples: Createjob200Example: summary: Default createJob 200 response x-microcks-default: true value: job_id: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/list: get: operationId: listJobs summary: Azure Databricks List All Jobs description: >- Retrieves a list of jobs defined in the workspace. Results are paginated with a default limit of 20 jobs per page. tags: - Jobs parameters: - name: limit in: query required: false description: >- Number of jobs to return. Default is 20 and maximum is 25. schema: type: integer default: 20 maximum: 25 example: 10 - name: offset in: query required: false description: Offset of the first job to return schema: type: integer default: 0 example: 10 - name: name in: query required: false description: A filter on the list based on the exact (case-insensitive) job name schema: type: string example: Example Title - name: expand_tasks in: query required: false description: Whether to include task and cluster details in the response schema: type: boolean default: false example: true responses: '200': description: Jobs list retrieved successfully content: application/json: schema: type: object properties: jobs: type: array items: $ref: '#/components/schemas/Job' has_more: type: boolean description: Whether there are more jobs to list examples: Listjobs200Example: summary: Default listJobs 200 response x-microcks-default: true value: jobs: - job_id: '500123' creator_user_name: example_value run_as_user_name: example_value created_time: 10 has_more: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/get: get: operationId: getJob summary: Azure Databricks Get a Single Job description: >- Retrieves the details for a single job, including its settings and most recent run information. tags: - Jobs parameters: - name: job_id in: query required: true description: The canonical identifier of the job to retrieve schema: type: integer format: int64 example: '500123' responses: '200': description: Job details retrieved successfully content: application/json: schema: $ref: '#/components/schemas/Job' examples: Getjob200Example: summary: Default getJob 200 response x-microcks-default: true value: job_id: '500123' creator_user_name: example_value run_as_user_name: example_value settings: name: Example Title tags: example_value tasks: - {} job_clusters: - {} notification_settings: no_alert_for_skipped_runs: true no_alert_for_canceled_runs: true timeout_seconds: 10 max_concurrent_runs: 10 trigger: file_arrival: {} continuous: pause_status: PAUSED format: SINGLE_TASK queue: enabled: true parameters: - {} run_as: user_name: example_value service_principal_name: example_value created_time: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/update: post: operationId: updateJob summary: Azure Databricks Partially Update a Job description: >- Adds, changes, or removes specific settings of an existing job. Use reset to overwrite all settings. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - job_id properties: job_id: type: integer format: int64 description: The canonical identifier of the job to update new_settings: $ref: '#/components/schemas/JobSettings' fields_to_remove: type: array items: type: string description: >- Fields to remove from the job settings. Removing nested fields is not supported except for task and job cluster configurations. examples: UpdatejobRequestExample: summary: Default updateJob request x-microcks-default: true value: job_id: '500123' new_settings: name: Example Title tags: example_value tasks: - {} job_clusters: - {} email_notifications: on_start: {} on_success: {} on_failure: {} on_duration_warning_threshold_exceeded: {} no_alert_for_skipped_runs: true webhook_notifications: on_start: {} on_success: {} on_failure: {} on_duration_warning_threshold_exceeded: {} notification_settings: no_alert_for_skipped_runs: true no_alert_for_canceled_runs: true timeout_seconds: 10 max_concurrent_runs: 10 schedule: quartz_cron_expression: example_value timezone_id: '500123' pause_status: PAUSED trigger: file_arrival: url: https://www.example.com min_time_between_triggers_seconds: 10 wait_after_last_change_seconds: 10 continuous: pause_status: PAUSED git_source: git_url: https://www.example.com git_provider: gitHub git_branch: example_value git_tag: example_value git_commit: example_value format: SINGLE_TASK queue: enabled: true parameters: - name: Example Title default: example_value run_as: user_name: example_value service_principal_name: example_value fields_to_remove: - example_value responses: '200': description: Job updated successfully content: application/json: schema: type: object examples: Updatejob200Example: summary: Default updateJob 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/reset: post: operationId: resetJob summary: Azure Databricks Overwrite All Job Settings description: >- Overwrites all settings for a specific job. Use update to change individual settings. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - job_id - new_settings properties: job_id: type: integer format: int64 description: The canonical identifier of the job to reset new_settings: $ref: '#/components/schemas/JobSettings' examples: ResetjobRequestExample: summary: Default resetJob request x-microcks-default: true value: job_id: '500123' new_settings: name: Example Title tags: example_value tasks: - {} job_clusters: - {} email_notifications: on_start: {} on_success: {} on_failure: {} on_duration_warning_threshold_exceeded: {} no_alert_for_skipped_runs: true webhook_notifications: on_start: {} on_success: {} on_failure: {} on_duration_warning_threshold_exceeded: {} notification_settings: no_alert_for_skipped_runs: true no_alert_for_canceled_runs: true timeout_seconds: 10 max_concurrent_runs: 10 schedule: quartz_cron_expression: example_value timezone_id: '500123' pause_status: PAUSED trigger: file_arrival: url: https://www.example.com min_time_between_triggers_seconds: 10 wait_after_last_change_seconds: 10 continuous: pause_status: PAUSED git_source: git_url: https://www.example.com git_provider: gitHub git_branch: example_value git_tag: example_value git_commit: example_value format: SINGLE_TASK queue: enabled: true parameters: - name: Example Title default: example_value run_as: user_name: example_value service_principal_name: example_value responses: '200': description: Job settings overwritten successfully content: application/json: schema: type: object examples: Resetjob200Example: summary: Default resetJob 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/delete: post: operationId: deleteJob summary: Azure Databricks Delete a Job description: >- Deletes a job and sends an email to the addresses specified in email_notifications. No action occurs if the job has already been removed. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - job_id properties: job_id: type: integer format: int64 description: The canonical identifier of the job to delete examples: DeletejobRequestExample: summary: Default deleteJob request x-microcks-default: true value: job_id: '500123' responses: '200': description: Job deleted successfully content: application/json: schema: type: object examples: Deletejob200Example: summary: Default deleteJob 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/run-now: post: operationId: runJobNow summary: Azure Databricks Trigger a New Job Run description: >- Runs the job now and returns the run_id of the triggered run. A job can have at most one active run at a time unless max_concurrent_runs is set. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - job_id properties: job_id: type: integer format: int64 description: The ID of the job to trigger idempotency_token: type: string description: >- Optional token to guarantee idempotency of job run requests. Maximum length is 64 characters. maxLength: 64 notebook_params: type: object additionalProperties: type: string description: >- Map of parameter name-value pairs for notebook tasks. python_params: type: array items: type: string description: Parameters for Python tasks spark_submit_params: type: array items: type: string description: Parameters for Spark submit tasks jar_params: type: array items: type: string description: Parameters for JAR tasks pipeline_params: type: object properties: full_refresh: type: boolean description: Whether to perform a full refresh of the pipeline examples: RunjobnowRequestExample: summary: Default runJobNow request x-microcks-default: true value: job_id: '500123' idempotency_token: example_value notebook_params: example_value python_params: - example_value spark_submit_params: - example_value jar_params: - example_value pipeline_params: full_refresh: true responses: '200': description: Job run triggered successfully content: application/json: schema: type: object properties: run_id: type: integer format: int64 description: Canonical identifier of the triggered run number_in_job: type: integer format: int64 description: Sequence number of this run among all runs of the job examples: Runjobnow200Example: summary: Default runJobNow 200 response x-microcks-default: true value: run_id: '500123' number_in_job: 10 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/submit: post: operationId: submitRun summary: Azure Databricks Submit a One-time Run description: >- Submits a one-time run without creating a job. This endpoint allows you to submit a workload directly without defining a job. Returns the run_id of the submitted run. tags: - Jobs requestBody: required: true content: application/json: schema: type: object properties: run_name: type: string description: Optional name for the run tasks: type: array items: $ref: '#/components/schemas/TaskSettings' description: List of task specifications for the run timeout_seconds: type: integer format: int32 description: >- Timeout in seconds for the run. Default is no timeout. idempotency_token: type: string description: Idempotency token for the run submission maxLength: 64 examples: SubmitrunRequestExample: summary: Default submitRun request x-microcks-default: true value: run_name: example_value tasks: - task_key: example_value description: A sample description. depends_on: - {} existing_cluster_id: '500123' job_cluster_key: example_value notebook_task: notebook_path: example_value base_parameters: example_value source: WORKSPACE spark_jar_task: main_class_name: example_value parameters: {} jar_uri: example_value spark_python_task: python_file: example_value parameters: {} source: WORKSPACE spark_submit_task: parameters: {} pipeline_task: pipeline_id: '500123' full_refresh: true python_wheel_task: package_name: example_value entry_point: example_value parameters: {} named_parameters: example_value sql_task: warehouse_id: '500123' query: {} dashboard: {} alert: {} file: {} dbt_task: commands: {} project_directory: example_value schema: example_value warehouse_id: '500123' profiles_directory: example_value catalog: example_value source: WORKSPACE run_if: ALL_SUCCESS timeout_seconds: 10 max_retries: 10 min_retry_interval_millis: 10 retry_on_timeout: true libraries: - {} timeout_seconds: 10 idempotency_token: example_value responses: '200': description: Run submitted successfully content: application/json: schema: type: object properties: run_id: type: integer format: int64 description: Canonical identifier of the submitted run examples: Submitrun200Example: summary: Default submitRun 200 response x-microcks-default: true value: run_id: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/list: get: operationId: listJobRuns summary: Azure Databricks List Runs for a Job description: >- Lists runs in descending order by start time for a specific job or all jobs. tags: - Jobs parameters: - name: job_id in: query required: false description: Filter runs by the specified job ID schema: type: integer format: int64 example: '500123' - name: active_only in: query required: false description: Show only active (running or pending) runs schema: type: boolean default: false example: true - name: completed_only in: query required: false description: Show only completed runs schema: type: boolean default: false example: true - name: offset in: query required: false description: Offset for pagination schema: type: integer default: 0 example: 10 - name: limit in: query required: false description: Number of runs to return. Maximum is 25. schema: type: integer default: 25 maximum: 25 example: 10 - name: run_type in: query required: false description: Filter by run type schema: type: string enum: - JOB_RUN - WORKFLOW_RUN - SUBMIT_RUN example: JOB_RUN - name: expand_tasks in: query required: false description: Whether to include task details in the response schema: type: boolean default: false example: true - name: start_time_from in: query required: false description: Filter runs starting after this timestamp (epoch ms) schema: type: integer format: int64 example: 10 - name: start_time_to in: query required: false description: Filter runs starting before this timestamp (epoch ms) schema: type: integer format: int64 example: 10 responses: '200': description: Job runs retrieved successfully content: application/json: schema: type: object properties: runs: type: array items: $ref: '#/components/schemas/Run' has_more: type: boolean description: Whether there are more runs to list examples: Listjobruns200Example: summary: Default listJobRuns 200 response x-microcks-default: true value: runs: - run_id: '500123' job_id: '500123' run_name: example_value creator_user_name: example_value number_in_job: 10 tasks: - {} cluster_spec: existing_cluster_id: '500123' cluster_instance: cluster_id: '500123' spark_context_id: '500123' start_time: 10 setup_duration: 10 execution_duration: 10 cleanup_duration: 10 end_time: 10 trigger: PERIODIC run_type: JOB_RUN attempt_number: 10 run_page_url: https://www.example.com format: SINGLE_TASK has_more: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/get: get: operationId: getJobRun summary: Azure Databricks Get a Single Job Run description: >- Retrieves the metadata of a run including its status, timing, cluster information, and task details. tags: - Jobs parameters: - name: run_id in: query required: true description: The canonical identifier of the run schema: type: integer format: int64 example: '500123' - name: include_history in: query required: false description: Whether to include the repair history in the response schema: type: boolean example: true - name: include_resolved_values in: query required: false description: Whether to include resolved parameter values in the response schema: type: boolean example: true responses: '200': description: Run details retrieved successfully content: application/json: schema: $ref: '#/components/schemas/Run' examples: Getjobrun200Example: summary: Default getJobRun 200 response x-microcks-default: true value: run_id: '500123' job_id: '500123' run_name: example_value creator_user_name: example_value number_in_job: 10 state: life_cycle_state: PENDING result_state: SUCCESS state_message: example_value user_cancelled_or_timedout: true tasks: - run_id: '500123' task_key: example_value start_time: 10 setup_duration: 10 execution_duration: 10 cleanup_duration: 10 end_time: 10 attempt_number: 10 schedule: quartz_cron_expression: example_value timezone_id: '500123' pause_status: PAUSED cluster_spec: existing_cluster_id: '500123' new_cluster: cluster_name: example_value spark_version: example_value node_type_id: '500123' driver_node_type_id: '500123' num_workers: 10 spark_conf: example_value ssh_public_keys: {} custom_tags: example_value init_scripts: {} spark_env_vars: example_value enable_elastic_disk: true instance_pool_id: '500123' policy_id: '500123' enable_local_disk_encryption: true runtime_engine: STANDARD data_security_mode: NONE single_user_name: example_value cluster_instance: cluster_id: '500123' spark_context_id: '500123' start_time: 10 setup_duration: 10 execution_duration: 10 cleanup_duration: 10 end_time: 10 trigger: PERIODIC run_type: JOB_RUN attempt_number: 10 run_page_url: https://www.example.com format: SINGLE_TASK '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/cancel: post: operationId: cancelJobRun summary: Azure Databricks Cancel a Job Run description: >- Cancels a run. The run is canceled asynchronously, so when this request completes, the run may still be running. The run is terminated shortly after the cancellation request. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - run_id properties: run_id: type: integer format: int64 description: The ID of the run to cancel examples: CanceljobrunRequestExample: summary: Default cancelJobRun request x-microcks-default: true value: run_id: '500123' responses: '200': description: Run cancellation initiated content: application/json: schema: type: object examples: Canceljobrun200Example: summary: Default cancelJobRun 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/delete: post: operationId: deleteJobRun summary: Azure Databricks Delete a Job Run description: >- Deletes a non-active run. Returns an HTTP 400 error if the run is still active. tags: - Jobs requestBody: required: true content: application/json: schema: type: object required: - run_id properties: run_id: type: integer format: int64 description: The ID of the run to delete examples: DeletejobrunRequestExample: summary: Default deleteJobRun request x-microcks-default: true value: run_id: '500123' responses: '200': description: Run deleted successfully content: application/json: schema: type: object examples: Deletejobrun200Example: summary: Default deleteJobRun 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.1/jobs/runs/get-output: get: operationId: getJobRunOutput summary: Azure Databricks Get Job Run Output description: >- Retrieves the output and metadata of a single task run. When a notebook task returns a value through dbutils.notebook.exit(), this endpoint can be used to retrieve that value. tags: - Jobs parameters: - name: run_id in: query required: true description: The canonical identifier of the run schema: type: integer format: int64 example: '500123' responses: '200': description: Run output retrieved successfully content: application/json: schema: type: object properties: notebook_output: type: object properties: result: type: string description: Value passed to dbutils.notebook.exit() truncated: type: boolean description: Whether the output was truncated error: type: string description: Error message if the run failed error_trace: type: string description: Error stack trace if available metadata: $ref: '#/components/schemas/Run' examples: Getjobrunoutput200Example: summary: Default getJobRunOutput 200 response x-microcks-default: true value: notebook_output: result: example_value truncated: true error: example_value error_trace: example_value metadata: run_id: '500123' job_id: '500123' run_name: example_value creator_user_name: example_value number_in_job: 10 state: life_cycle_state: PENDING result_state: SUCCESS state_message: example_value user_cancelled_or_timedout: true tasks: - run_id: '500123' task_key: example_value start_time: 10 setup_duration: 10 execution_duration: 10 cleanup_duration: 10 end_time: 10 attempt_number: 10 schedule: quartz_cron_expression: example_value timezone_id: '500123' pause_status: PAUSED cluster_spec: existing_cluster_id: '500123' cluster_instance: cluster_id: '500123' spark_context_id: '500123' start_time: 10 setup_duration: 10 execution_duration: 10 cleanup_duration: 10 end_time: 10 trigger: PERIODIC run_type: JOB_RUN attempt_number: 10 run_page_url: https://www.example.com format: SINGLE_TASK '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/list: get: operationId: listWorkspaceObjects summary: Azure Databricks List Workspace Objects description: >- Lists the contents of a directory in the workspace, or the object if it is not a directory. If the input path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. tags: - Workspace parameters: - name: path in: query required: true description: >- The absolute path of the workspace directory to list. A path of / lists the root directory. schema: type: string example: example_value responses: '200': description: Workspace objects listed successfully content: application/json: schema: type: object properties: objects: type: array items: $ref: '#/components/schemas/WorkspaceObject' examples: Listworkspaceobjects200Example: summary: Default listWorkspaceObjects 200 response x-microcks-default: true value: objects: - object_type: NOTEBOOK path: example_value language: SCALA object_id: '500123' created_at: '2026-01-15T10:30:00Z' modified_at: '2026-01-15T10:30:00Z' resource_id: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/get-status: get: operationId: getWorkspaceObjectStatus summary: Azure Databricks Get Workspace Object Status description: >- Gets the status of an object or a directory. If the object is a directory, its contents are not included in the response. tags: - Workspace parameters: - name: path in: query required: true description: The absolute path of the workspace object schema: type: string example: example_value responses: '200': description: Object status retrieved successfully content: application/json: schema: $ref: '#/components/schemas/WorkspaceObject' examples: Getworkspaceobjectstatus200Example: summary: Default getWorkspaceObjectStatus 200 response x-microcks-default: true value: object_type: NOTEBOOK path: example_value language: SCALA object_id: '500123' created_at: '2026-01-15T10:30:00Z' modified_at: '2026-01-15T10:30:00Z' resource_id: '500123' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/mkdirs: post: operationId: createWorkspaceDirectory summary: Azure Databricks Create a Directory description: >- Creates the specified directory and all necessary parent directories if they do not exist. If there is an object (not a directory) at any prefix of the input path, this call returns an error RESOURCE_ALREADY_EXISTS. tags: - Workspace requestBody: required: true content: application/json: schema: type: object required: - path properties: path: type: string description: >- The absolute path of the directory. Directories are created recursively if they do not exist. examples: CreateworkspacedirectoryRequestExample: summary: Default createWorkspaceDirectory request x-microcks-default: true value: path: example_value responses: '200': description: Directory created successfully content: application/json: schema: type: object examples: Createworkspacedirectory200Example: summary: Default createWorkspaceDirectory 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/delete: post: operationId: deleteWorkspaceObject summary: Azure Databricks Delete a Workspace Object description: >- Deletes an object or a directory (and optionally its contents recursively). If the path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. If path is a non-empty directory and recursive is set to false, this call returns an error DIRECTORY_NOT_EMPTY. tags: - Workspace requestBody: required: true content: application/json: schema: type: object required: - path properties: path: type: string description: The absolute path of the workspace object to delete recursive: type: boolean description: >- Whether to recursively delete the directory contents. Required for non-empty directories. default: false examples: DeleteworkspaceobjectRequestExample: summary: Default deleteWorkspaceObject request x-microcks-default: true value: path: example_value recursive: true responses: '200': description: Object deleted successfully content: application/json: schema: type: object examples: Deleteworkspaceobject200Example: summary: Default deleteWorkspaceObject 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/import: post: operationId: importWorkspaceObject summary: Azure Databricks Import a Workspace Object description: >- Imports a notebook or the contents of an entire directory. If the path already exists and overwrite is set to false, this call returns an error RESOURCE_ALREADY_EXISTS. Content can be provided inline as base64-encoded bytes or from a file. tags: - Workspace requestBody: required: true content: application/json: schema: type: object required: - path properties: path: type: string description: >- The absolute path of the object. Importing a directory is only supported for DBC format. format: type: string enum: - SOURCE - HTML - JUPYTER - DBC - R_MARKDOWN - AUTO description: >- Format of the imported content. AUTO will try to detect the format automatically. language: type: string enum: - SCALA - PYTHON - SQL - R description: >- Programming language of the object. Required for SOURCE format. content: type: string description: >- Base64-encoded content. Maximum size is 10 MB. overwrite: type: boolean description: Whether to overwrite existing objects default: false examples: ImportworkspaceobjectRequestExample: summary: Default importWorkspaceObject request x-microcks-default: true value: path: example_value format: SOURCE language: SCALA content: example_value overwrite: true responses: '200': description: Object imported successfully content: application/json: schema: type: object examples: Importworkspaceobject200Example: summary: Default importWorkspaceObject 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /2.0/workspace/export: get: operationId: exportWorkspaceObject summary: Azure Databricks Export a Workspace Object description: >- Exports a notebook or the contents of an entire directory. The notebook is exported in the requested format (default is SOURCE). A directory is always exported as a DBC archive. tags: - Workspace parameters: - name: path in: query required: true description: The absolute path of the object to export schema: type: string example: example_value - name: format in: query required: false description: Format of the exported content schema: type: string enum: - SOURCE - HTML - JUPYTER - DBC - R_MARKDOWN default: SOURCE example: SOURCE - name: direct_download in: query required: false description: >- Whether to download the exported file directly. Default is false. schema: type: boolean default: false example: true responses: '200': description: Object exported successfully content: application/json: schema: type: object properties: content: type: string description: Base64-encoded content of the exported object file_type: type: string description: Type of the exported object examples: Exportworkspaceobject200Example: summary: Default exportWorkspaceObject 200 response x-microcks-default: true value: content: example_value file_type: example_value '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Databricks personal access token. Pass the token in the Authorization header as Bearer . AzureADToken: type: oauth2 description: >- Azure Active Directory token for authenticating with Azure Databricks. Supports both user and service principal authentication. flows: authorizationCode: authorizationUrl: https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/authorize tokenUrl: https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/token scopes: 2ff814a6-3304-4ab8-85cb-cd0e6f879c1d/.default: >- Access Azure Databricks workspace resources schemas: CreateClusterRequest: type: object required: - spark_version properties: cluster_name: type: string description: >- Cluster name requested by the user. Does not have to be unique. If not specified at creation, the cluster name is an empty string. example: example_value spark_version: type: string description: >- The runtime version of the cluster. You can retrieve a list of available runtime versions using the spark-versions endpoint. examples: - "13.3.x-scala2.12" node_type_id: type: string description: >- The node type for the worker nodes. Refer to list-node-types for available node types. examples: - "Standard_DS3_v2" driver_node_type_id: type: string description: >- The node type for the driver node. If unset, the driver node type is set as the same value as node_type_id. example: '500123' num_workers: type: integer format: int32 description: >- Number of worker nodes. For a fixed-size cluster, set this to the desired number of workers. For an autoscaling cluster, this field is ignored in favor of autoscale settings. example: 10 autoscale: $ref: '#/components/schemas/AutoScale' spark_conf: type: object additionalProperties: type: string description: >- Map of Spark configuration key-value pairs. These are passed directly to the Spark driver and executors. example: example_value azure_attributes: $ref: '#/components/schemas/AzureAttributes' ssh_public_keys: type: array items: type: string description: SSH public keys for accessing cluster nodes example: [] custom_tags: type: object additionalProperties: type: string description: >- Custom tags applied to cluster resources. Databricks adds default tags in addition to any custom tags you specify. example: example_value cluster_log_conf: $ref: '#/components/schemas/ClusterLogConf' init_scripts: type: array items: $ref: '#/components/schemas/InitScriptInfo' description: Init scripts to run when the cluster starts example: [] spark_env_vars: type: object additionalProperties: type: string description: >- Map of environment variable key-value pairs for the Spark process. example: example_value enable_elastic_disk: type: boolean description: >- If true, enable autoscaling local storage. When enabled, the amount of disk space used by the cluster auto-adjusts. example: true instance_pool_id: type: string description: >- ID of the instance pool to use for cluster nodes. If specified, the cluster uses the instance pool for both driver and worker nodes. example: '500123' policy_id: type: string description: >- Identifier of the cluster policy used to create the cluster. example: '500123' enable_local_disk_encryption: type: boolean description: Whether to enable local disk encryption for the cluster example: true runtime_engine: type: string enum: - STANDARD - PHOTON description: >- The runtime engine to use. PHOTON provides optimized query execution. example: STANDARD data_security_mode: type: string enum: - NONE - SINGLE_USER - USER_ISOLATION - LEGACY_TABLE_ACL - LEGACY_PASSTHROUGH - LEGACY_SINGLE_USER - LEGACY_SINGLE_USER_STANDARD description: >- Data security mode for the cluster. Determines how data access is controlled. example: NONE single_user_name: type: string description: >- The name of the single user who can execute commands on the cluster. Required when data_security_mode is SINGLE_USER. example: example_value ClusterInfo: type: object properties: cluster_id: type: string description: Canonical identifier for the cluster example: '500123' cluster_name: type: string description: Name of the cluster example: example_value spark_version: type: string description: Databricks Runtime version example: example_value node_type_id: type: string description: Node type for worker nodes example: '500123' driver_node_type_id: type: string description: Node type for the driver node example: '500123' num_workers: type: integer format: int32 description: Number of worker nodes example: 10 autoscale: $ref: '#/components/schemas/AutoScale' state: type: string enum: - PENDING - RUNNING - RESTARTING - RESIZING - TERMINATING - TERMINATED - ERROR - UNKNOWN description: Current state of the cluster example: PENDING state_message: type: string description: Message associated with the current state example: example_value creator_user_name: type: string description: Username of the cluster creator example: example_value start_time: type: integer format: int64 description: Time when the cluster was started (epoch milliseconds) example: 10 terminated_time: type: integer format: int64 description: Time when the cluster was terminated (epoch milliseconds) example: 10 last_state_loss_time: type: integer format: int64 description: >- Time when the cluster driver lost its state (epoch milliseconds) example: 10 last_activity_time: type: integer format: int64 description: >- Time when the cluster last had activity (epoch milliseconds) example: 10 autotermination_minutes: type: integer format: int32 description: >- Automatically terminates the cluster after it is inactive for this time in minutes. 0 indicates no autotermination. example: 10 cluster_source: type: string enum: - UI - API - JOB - MODELS - PIPELINE - PIPELINE_MAINTENANCE - SQL description: Indicates the source that created the cluster example: UI spark_conf: type: object additionalProperties: type: string description: Spark configuration key-value pairs example: example_value azure_attributes: $ref: '#/components/schemas/AzureAttributes' custom_tags: type: object additionalProperties: type: string example: example_value cluster_log_conf: $ref: '#/components/schemas/ClusterLogConf' init_scripts: type: array items: $ref: '#/components/schemas/InitScriptInfo' example: [] spark_env_vars: type: object additionalProperties: type: string example: example_value enable_elastic_disk: type: boolean example: true instance_pool_id: type: string example: '500123' policy_id: type: string example: '500123' default_tags: type: object additionalProperties: type: string description: Tags applied automatically by Databricks example: example_value cluster_log_status: type: object properties: last_attempted: type: integer format: int64 last_exception: type: string example: example_value termination_reason: type: object properties: code: type: string description: Termination reason code type: type: string description: Type of termination parameters: type: object additionalProperties: type: string example: example_value data_security_mode: type: string example: example_value single_user_name: type: string example: example_value runtime_engine: type: string example: example_value disk_spec: type: object properties: disk_count: type: integer disk_size: type: integer disk_type: type: object properties: azure_disk_volume_type: type: string example: example_value executors: type: array items: $ref: '#/components/schemas/SparkNode' example: [] driver: $ref: '#/components/schemas/SparkNode' jdbc_port: type: integer description: Port on which the JDBC/ODBC server is listening example: 10 cluster_memory_mb: type: integer format: int64 description: Total memory in the cluster in megabytes example: 10 cluster_cores: type: number format: float description: Total number of CPU cores in the cluster example: 42.5 AutoScale: type: object properties: min_workers: type: integer format: int32 description: Minimum number of workers example: 10 max_workers: type: integer format: int32 description: Maximum number of workers example: 10 required: - min_workers - max_workers AzureAttributes: type: object description: Attributes specific to Azure Databricks clusters properties: first_on_demand: type: integer format: int32 description: >- The first nodes provisioned as on-demand instances. Remaining nodes will be spot instances. example: 10 availability: type: string enum: - SPOT_AZURE - ON_DEMAND_AZURE - SPOT_WITH_FALLBACK_AZURE description: Azure availability type for cluster nodes example: SPOT_AZURE spot_bid_max_price: type: number format: double description: >- Max price for Azure spot instances. Set to -1 (default) to indicate that the instance should not be evicted based on price. example: 42.5 ClusterLogConf: type: object description: Configuration for delivering Spark logs to a destination properties: dbfs: type: object properties: destination: type: string description: DBFS destination path for logs example: example_value s3: type: object properties: destination: type: string region: type: string endpoint: type: string example: example_value InitScriptInfo: type: object description: Configuration for a cluster init script properties: workspace: type: object properties: destination: type: string description: Workspace path for the init script example: example_value volumes: type: object properties: destination: type: string description: Unity Catalog Volumes path for the init script example: example_value dbfs: type: object properties: destination: type: string description: DBFS path for the init script deprecated: true example: example_value abfss: type: object properties: destination: type: string description: Azure Blob Storage (ABFSS) path for the init script example: example_value SparkNode: type: object properties: private_ip: type: string description: Private IP address of the node example: example_value public_dns: type: string description: Public DNS name of the node example: example_value node_id: type: string description: Unique identifier for the node example: '500123' instance_id: type: string description: Azure instance identifier example: '500123' start_timestamp: type: integer format: int64 description: Start time of the node (epoch milliseconds) example: 10 host_private_ip: type: string description: Private IP address of the host example: example_value NodeType: type: object properties: node_type_id: type: string description: Unique identifier for the node type example: '500123' memory_mb: type: integer format: int32 description: Memory in megabytes example: 10 num_cores: type: number format: float description: Number of CPU cores example: 42.5 description: type: string description: Human-readable description example: A sample description. instance_type_id: type: string description: Azure instance type identifier example: '500123' is_deprecated: type: boolean description: Whether the node type is deprecated example: true num_gpus: type: integer format: int32 description: Number of GPUs available example: 10 category: type: string description: Category of the node type (General Purpose, Memory Optimized, etc.) example: example_value ClusterEvent: type: object properties: cluster_id: type: string description: Cluster ID associated with the event example: '500123' timestamp: type: integer format: int64 description: Timestamp of the event in epoch milliseconds example: 10 type: type: string description: Type of event example: example_value details: type: object description: Event-specific details example: example_value JobSettings: type: object properties: name: type: string description: >- Optional name for the job. Default is Untitled. default: Untitled example: Example Title tags: type: object additionalProperties: type: string description: Map of tags associated with the job example: example_value tasks: type: array items: $ref: '#/components/schemas/TaskSettings' description: >- List of task specifications for the job. A job must contain at least one task. example: [] job_clusters: type: array items: $ref: '#/components/schemas/JobCluster' description: >- A list of job cluster specifications that can be shared and reused by tasks. example: [] email_notifications: $ref: '#/components/schemas/EmailNotifications' webhook_notifications: $ref: '#/components/schemas/WebhookNotifications' notification_settings: type: object properties: no_alert_for_skipped_runs: type: boolean description: Do not send alert for skipped runs no_alert_for_canceled_runs: type: boolean description: Do not send alert for canceled runs example: example_value timeout_seconds: type: integer format: int32 description: >- Timeout in seconds applied to each run of this job. Default is no timeout. default: 0 example: 10 max_concurrent_runs: type: integer format: int32 description: >- Maximum allowed number of concurrent runs of the job. Default is 1. default: 1 example: 10 schedule: $ref: '#/components/schemas/CronSchedule' trigger: type: object properties: file_arrival: type: object properties: url: type: string description: URL of the storage location to monitor min_time_between_triggers_seconds: type: integer format: int32 wait_after_last_change_seconds: type: integer format: int32 description: Trigger settings for file arrival events example: example_value continuous: type: object properties: pause_status: type: string enum: - PAUSED - UNPAUSED description: Settings for continuous job execution example: example_value git_source: $ref: '#/components/schemas/GitSource' format: type: string enum: - SINGLE_TASK - MULTI_TASK description: >- Format of the job. MULTI_TASK is the preferred format for creating jobs with multiple tasks. example: SINGLE_TASK queue: type: object properties: enabled: type: boolean description: Whether to queue the run if the cluster is not available example: example_value parameters: type: array items: type: object properties: name: type: string default: type: string description: Job-level parameters example: [] run_as: type: object properties: user_name: type: string service_principal_name: type: string description: User or service principal to run the job as example: example_value TaskSettings: type: object required: - task_key properties: task_key: type: string description: >- Unique key for the task within the job. Must be unique among all tasks in the same job. maxLength: 100 example: example_value description: type: string description: Optional description for the task example: A sample description. depends_on: type: array items: type: object properties: task_key: type: string description: Key of the task this task depends on outcome: type: string description: Expected outcome of the dependency description: >- Tasks this task depends on. The task will not start until all dependent tasks complete successfully. example: [] existing_cluster_id: type: string description: ID of an existing cluster to use for this task example: '500123' new_cluster: $ref: '#/components/schemas/CreateClusterRequest' job_cluster_key: type: string description: >- Key of a job cluster specification to use. Refers to a cluster defined in the job's job_clusters field. example: example_value notebook_task: type: object properties: notebook_path: type: string description: >- The path of the notebook to run in the Databricks workspace or remote repository base_parameters: type: object additionalProperties: type: string description: Base parameters for the notebook source: type: string enum: - WORKSPACE - GIT description: Location source of the notebook example: example_value spark_jar_task: type: object properties: main_class_name: type: string description: Full name of the main class to execute parameters: type: array items: type: string description: Parameters passed to the main method jar_uri: type: string description: Deprecated. URI of the JAR to execute. deprecated: true example: example_value spark_python_task: type: object properties: python_file: type: string description: URI of the Python file to execute parameters: type: array items: type: string description: Command line parameters for the Python file source: type: string enum: - WORKSPACE - GIT example: example_value spark_submit_task: type: object properties: parameters: type: array items: type: string description: Parameters for spark-submit example: example_value pipeline_task: type: object properties: pipeline_id: type: string description: ID of the Delta Live Tables pipeline full_refresh: type: boolean description: Whether to perform a full refresh example: example_value python_wheel_task: type: object properties: package_name: type: string description: Name of the Python wheel package entry_point: type: string description: Named entry point to use parameters: type: array items: type: string named_parameters: type: object additionalProperties: type: string example: example_value sql_task: type: object properties: warehouse_id: type: string description: ID of the SQL warehouse query: type: object properties: query_id: type: string dashboard: type: object properties: dashboard_id: type: string alert: type: object properties: alert_id: type: string file: type: object properties: path: type: string source: type: string enum: - WORKSPACE - GIT example: example_value dbt_task: type: object properties: commands: type: array items: type: string description: dbt commands to execute project_directory: type: string description: Path to the dbt project directory schema: type: string description: dbt schema name warehouse_id: type: string description: SQL warehouse ID for dbt profiles_directory: type: string catalog: type: string source: type: string enum: - WORKSPACE - GIT example: example_value run_if: type: string enum: - ALL_SUCCESS - AT_LEAST_ONE_SUCCESS - NONE_FAILED - ALL_DONE - AT_LEAST_ONE_FAILED - ALL_FAILED description: Condition for running this task based on dependencies example: ALL_SUCCESS timeout_seconds: type: integer format: int32 description: Timeout in seconds for this individual task example: 10 max_retries: type: integer format: int32 description: Maximum number of retries for this task example: 10 min_retry_interval_millis: type: integer format: int32 description: Minimum interval between retries in milliseconds example: 10 retry_on_timeout: type: boolean description: Whether to retry the task if it times out example: true libraries: type: array items: $ref: '#/components/schemas/Library' description: Libraries to install on the task cluster example: [] JobCluster: type: object required: - job_cluster_key - new_cluster properties: job_cluster_key: type: string description: Unique key identifying this cluster specification example: example_value new_cluster: $ref: '#/components/schemas/CreateClusterRequest' Job: type: object properties: job_id: type: integer format: int64 description: Canonical identifier of the job example: '500123' creator_user_name: type: string description: Username of the job creator example: example_value run_as_user_name: type: string description: User the job runs as example: example_value settings: $ref: '#/components/schemas/JobSettings' created_time: type: integer format: int64 description: Time the job was created (epoch milliseconds) example: 10 Run: type: object properties: run_id: type: integer format: int64 description: Canonical identifier of the run example: '500123' job_id: type: integer format: int64 description: ID of the job this run belongs to example: '500123' run_name: type: string description: Name of the run example: example_value creator_user_name: type: string description: Username of the user who triggered the run example: example_value number_in_job: type: integer format: int64 description: Sequence number of this run among all runs of the job example: 10 state: $ref: '#/components/schemas/RunState' tasks: type: array items: type: object properties: run_id: type: integer format: int64 task_key: type: string state: $ref: '#/components/schemas/RunState' start_time: type: integer format: int64 setup_duration: type: integer format: int64 execution_duration: type: integer format: int64 cleanup_duration: type: integer format: int64 end_time: type: integer format: int64 attempt_number: type: integer format: int32 example: [] schedule: $ref: '#/components/schemas/CronSchedule' cluster_spec: type: object properties: existing_cluster_id: type: string new_cluster: $ref: '#/components/schemas/CreateClusterRequest' example: example_value cluster_instance: type: object properties: cluster_id: type: string spark_context_id: type: string example: example_value start_time: type: integer format: int64 description: Start time of the run (epoch milliseconds) example: 10 setup_duration: type: integer format: int64 description: Time spent setting up the cluster in milliseconds example: 10 execution_duration: type: integer format: int64 description: Time spent executing the run in milliseconds example: 10 cleanup_duration: type: integer format: int64 description: Time spent cleaning up after the run in milliseconds example: 10 end_time: type: integer format: int64 description: End time of the run (epoch milliseconds) example: 10 trigger: type: string enum: - PERIODIC - ONE_TIME - RETRY - RUN_JOB_TASK - FILE_ARRIVAL description: What triggered this run example: PERIODIC run_type: type: string enum: - JOB_RUN - WORKFLOW_RUN - SUBMIT_RUN example: JOB_RUN attempt_number: type: integer format: int32 description: Current attempt number of the run example: 10 run_page_url: type: string description: URL of the run page in the Databricks UI example: https://www.example.com format: type: string enum: - SINGLE_TASK - MULTI_TASK example: SINGLE_TASK RunState: type: object properties: life_cycle_state: type: string enum: - PENDING - QUEUED - RUNNING - TERMINATING - TERMINATED - SKIPPED - INTERNAL_ERROR - BLOCKED - WAITING_FOR_RETRY description: Life cycle state of the run example: PENDING result_state: type: string enum: - SUCCESS - FAILED - TIMEDOUT - CANCELED - MAXIMUM_CONCURRENT_RUNS_REACHED - EXCLUDED - SUCCESS_WITH_FAILURES - UPSTREAM_FAILED - UPSTREAM_CANCELED description: Result state of the run (available after completion) example: SUCCESS state_message: type: string description: Descriptive message for the current state example: example_value user_cancelled_or_timedout: type: boolean description: Whether the run was cancelled by a user or timed out example: true CronSchedule: type: object properties: quartz_cron_expression: type: string description: >- Quartz cron expression for the schedule. See http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html examples: - "0 0 8 * * ?" timezone_id: type: string description: Java timezone ID for the schedule examples: - "America/Los_Angeles" pause_status: type: string enum: - PAUSED - UNPAUSED description: Whether the schedule is paused or active example: PAUSED EmailNotifications: type: object properties: on_start: type: array items: type: string description: Email addresses to notify when a run starts example: [] on_success: type: array items: type: string description: Email addresses to notify when a run succeeds example: [] on_failure: type: array items: type: string description: Email addresses to notify when a run fails example: [] on_duration_warning_threshold_exceeded: type: array items: type: string description: >- Email addresses to notify when a run exceeds the duration warning threshold example: [] no_alert_for_skipped_runs: type: boolean description: Do not send alert for skipped runs example: true WebhookNotifications: type: object properties: on_start: type: array items: type: object properties: id: type: string description: ID of the system notification destination example: [] on_success: type: array items: type: object properties: id: type: string example: [] on_failure: type: array items: type: object properties: id: type: string example: [] on_duration_warning_threshold_exceeded: type: array items: type: object properties: id: type: string example: [] GitSource: type: object required: - git_url - git_provider properties: git_url: type: string description: URL of the Git repository example: https://www.example.com git_provider: type: string enum: - gitHub - bitbucketCloud - azureDevOpsServices - gitHubEnterprise - bitbucketServer - gitLab - gitLabEnterpriseEdition - awsCodeCommit description: Git provider type example: gitHub git_branch: type: string description: Branch to check out example: example_value git_tag: type: string description: Tag to check out example: example_value git_commit: type: string description: Commit hash to check out example: example_value Library: type: object properties: jar: type: string description: URI of the JAR library to install example: example_value egg: type: string description: URI of the egg library to install deprecated: true example: example_value whl: type: string description: URI of the wheel library to install example: example_value pypi: type: object properties: package: type: string description: Name of the PyPI package to install repo: type: string description: Repository URL to install the package from example: example_value maven: type: object properties: coordinates: type: string description: Maven coordinates (group:artifact:version) repo: type: string description: Maven repository URL exclusions: type: array items: type: string description: List of dependencies to exclude example: example_value cran: type: object properties: package: type: string description: Name of the CRAN package repo: type: string description: CRAN repository URL example: example_value requirements: type: string description: >- Path to a requirements.txt file. Only supported on clusters running Databricks Runtime 15.0+. example: example_value WorkspaceObject: type: object properties: object_type: type: string enum: - NOTEBOOK - DIRECTORY - LIBRARY - FILE - REPO - DASHBOARD description: Type of the workspace object example: NOTEBOOK path: type: string description: Absolute path of the object in the workspace example: example_value language: type: string enum: - SCALA - PYTHON - SQL - R description: >- Programming language of the object. Only applicable for notebooks. example: SCALA object_id: type: integer format: int64 description: Unique identifier for the object example: '500123' created_at: type: integer format: int64 description: Creation timestamp in epoch milliseconds example: '2026-01-15T10:30:00Z' modified_at: type: integer format: int64 description: Last modification timestamp in epoch milliseconds example: '2026-01-15T10:30:00Z' resource_id: type: string description: Resource ID for the object example: '500123' Error: type: object properties: error_code: type: string description: >- Databricks error code (e.g., RESOURCE_DOES_NOT_EXIST, INVALID_PARAMETER_VALUE) example: example_value message: type: string description: Human-readable error message example: example_value required: - error_code - message responses: BadRequest: description: The request is malformed or contains invalid parameters content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication credentials are missing or invalid content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The caller does not have permission to perform the operation content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource does not exist content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: The request has been rate-limited content: application/json: schema: $ref: '#/components/schemas/Error' InternalError: description: An internal server error occurred content: application/json: schema: $ref: '#/components/schemas/Error'