{ "opencollection": "1.0.0", "info": { "name": "Azure Databricks REST API", "version": "2.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Clusters", "type": "folder" }, "items": [ { "info": { "name": "Azure Databricks Create a New Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/create", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Edit a Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/edit", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Start a Terminated Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/start", "body": { "type": "json", "data": "{}" } }, "docs": "Starts a terminated cluster given its ID. Works only for clusters in a TERMINATED state. Uses the last specified cluster configuration." }, { "info": { "name": "Azure Databricks Restart a Running Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/restart", "body": { "type": "json", "data": "{}" } }, "docs": "Restarts a running cluster given its ID. The cluster must be in a RUNNING state." }, { "info": { "name": "Azure Databricks Terminate a Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/delete", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Permanently Delete a Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/permanent-delete", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Get Cluster Information", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/get", "params": [ { "name": "cluster_id", "value": "500123", "type": "query", "description": "The cluster about which to retrieve information" } ] }, "docs": "Retrieves the information for a cluster given its identifier. Returns the current state, configuration, and metadata for the cluster." }, { "info": { "name": "Azure Databricks List All Clusters", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/list", "params": [ { "name": "can_use_client", "value": "example_value", "type": "query", "description": "Filter clusters based on what type of client can use the cluster. Possible values are NOTEBOOKS and JOBS." } ] }, "docs": "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." }, { "info": { "name": "Azure Databricks Pin a Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/pin", "body": { "type": "json", "data": "{}" } }, "docs": "Pins a cluster to ensure it is always returned by the list clusters API. Pinning a cluster that is already pinned has no effect." }, { "info": { "name": "Azure Databricks Unpin a Cluster", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/unpin", "body": { "type": "json", "data": "{}" } }, "docs": "Unpins a cluster. Unpinning a cluster that is not pinned has no effect." }, { "info": { "name": "Azure Databricks List Cluster Events", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/events", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks List Available Spark Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/spark-versions" }, "docs": "Returns the list of available Databricks Runtime versions. These versions can be used to launch clusters." }, { "info": { "name": "Azure Databricks List Available Node Types", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/clusters/list-node-types" }, "docs": "Returns a list of supported Azure VM node types. These node types can be used to launch clusters." } ] }, { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Azure Databricks Create a New Job", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/create", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job with the provided settings. Returns the job_id of the newly created job." }, { "info": { "name": "Azure Databricks List All Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/list", "params": [ { "name": "limit", "value": "10", "type": "query", "description": "Number of jobs to return. Default is 20 and maximum is 25." }, { "name": "offset", "value": "10", "type": "query", "description": "Offset of the first job to return" }, { "name": "name", "value": "Example Title", "type": "query", "description": "A filter on the list based on the exact (case-insensitive) job name" }, { "name": "expand_tasks", "value": "true", "type": "query", "description": "Whether to include task and cluster details in the response" } ] }, "docs": "Retrieves a list of jobs defined in the workspace. Results are paginated with a default limit of 20 jobs per page." }, { "info": { "name": "Azure Databricks Get a Single Job", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/get", "params": [ { "name": "job_id", "value": "500123", "type": "query", "description": "The canonical identifier of the job to retrieve" } ] }, "docs": "Retrieves the details for a single job, including its settings and most recent run information." }, { "info": { "name": "Azure Databricks Partially Update a Job", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/update", "body": { "type": "json", "data": "{}" } }, "docs": "Adds, changes, or removes specific settings of an existing job. Use reset to overwrite all settings." }, { "info": { "name": "Azure Databricks Overwrite All Job Settings", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/reset", "body": { "type": "json", "data": "{}" } }, "docs": "Overwrites all settings for a specific job. Use update to change individual settings." }, { "info": { "name": "Azure Databricks Delete a Job", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a job and sends an email to the addresses specified in email_notifications. No action occurs if the job has already been removed." }, { "info": { "name": "Azure Databricks Trigger a New Job Run", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/run-now", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Submit a One-time Run", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/submit", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks List Runs for a Job", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/list", "params": [ { "name": "job_id", "value": "500123", "type": "query", "description": "Filter runs by the specified job ID" }, { "name": "active_only", "value": "true", "type": "query", "description": "Show only active (running or pending) runs" }, { "name": "completed_only", "value": "true", "type": "query", "description": "Show only completed runs" }, { "name": "offset", "value": "10", "type": "query", "description": "Offset for pagination" }, { "name": "limit", "value": "10", "type": "query", "description": "Number of runs to return. Maximum is 25." }, { "name": "run_type", "value": "JOB_RUN", "type": "query", "description": "Filter by run type" }, { "name": "expand_tasks", "value": "true", "type": "query", "description": "Whether to include task details in the response" }, { "name": "start_time_from", "value": "10", "type": "query", "description": "Filter runs starting after this timestamp (epoch ms)" }, { "name": "start_time_to", "value": "10", "type": "query", "description": "Filter runs starting before this timestamp (epoch ms)" } ] }, "docs": "Lists runs in descending order by start time for a specific job or all jobs." }, { "info": { "name": "Azure Databricks Get a Single Job Run", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/get", "params": [ { "name": "run_id", "value": "500123", "type": "query", "description": "The canonical identifier of the run" }, { "name": "include_history", "value": "true", "type": "query", "description": "Whether to include the repair history in the response" }, { "name": "include_resolved_values", "value": "true", "type": "query", "description": "Whether to include resolved parameter values in the response" } ] }, "docs": "Retrieves the metadata of a run including its status, timing, cluster information, and task details." }, { "info": { "name": "Azure Databricks Cancel a Job Run", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/cancel", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Delete a Job Run", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a non-active run. Returns an HTTP 400 error if the run is still active." }, { "info": { "name": "Azure Databricks Get Job Run Output", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.1/jobs/runs/get-output", "params": [ { "name": "run_id", "value": "500123", "type": "query", "description": "The canonical identifier of the run" } ] }, "docs": "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." } ] }, { "info": { "name": "Workspace", "type": "folder" }, "items": [ { "info": { "name": "Azure Databricks List Workspace Objects", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/list", "params": [ { "name": "path", "value": "example_value", "type": "query", "description": "The absolute path of the workspace directory to list. A path of / lists the root directory." } ] }, "docs": "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." }, { "info": { "name": "Azure Databricks Get Workspace Object Status", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/get-status", "params": [ { "name": "path", "value": "example_value", "type": "query", "description": "The absolute path of the workspace object" } ] }, "docs": "Gets the status of an object or a directory. If the object is a directory, its contents are not included in the response." }, { "info": { "name": "Azure Databricks Create a Directory", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/mkdirs", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Delete a Workspace Object", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/delete", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Import a Workspace Object", "type": "http" }, "http": { "method": "POST", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/import", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Azure Databricks Export a Workspace Object", "type": "http" }, "http": { "method": "GET", "url": "https://{databricks_instance}.azuredatabricks.net/api/2.0/workspace/export", "params": [ { "name": "path", "value": "example_value", "type": "query", "description": "The absolute path of the object to export" }, { "name": "format", "value": "SOURCE", "type": "query", "description": "Format of the exported content" }, { "name": "direct_download", "value": "true", "type": "query", "description": "Whether to download the exported file directly. Default is false." } ] }, "docs": "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." } ] } ], "bundled": true }