{ "opencollection": "1.0.0", "info": { "name": "Databricks REST Clusters Jobs API", "version": "2.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Databricks Create a New Job", "type": "http" }, "http": { "method": "POST", "url": "https://{workspace_host}/api/2.1/jobs/create", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job with the provided settings. The job can be configured with a single task or multiple tasks with dependencies forming a directed acyclic graph (DAG)." }, { "info": { "name": "Databricks List All Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{workspace_host}/api/2.1/jobs/list", "params": [ { "name": "limit", "value": "10", "type": "query", "description": "The number of jobs to return. This value must be greater than 0 and less than or equal to 25. The default value is 20." }, { "name": "offset", "value": "10", "type": "query", "description": "The 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 in the workspace. Results are paginated and can be filtered by name." }, { "info": { "name": "Databricks Get a Job", "type": "http" }, "http": { "method": "GET", "url": "https://{workspace_host}/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 of a single job, including its settings, creator, and run history summary." }, { "info": { "name": "Databricks Partially Update a Job", "type": "http" }, "http": { "method": "POST", "url": "https://{workspace_host}/api/2.1/jobs/update", "body": { "type": "json", "data": "{}" } }, "docs": "Add, update, or remove specific settings of an existing job. Use reset to overwrite all settings." }, { "info": { "name": "Databricks Delete a Job", "type": "http" }, "http": { "method": "POST", "url": "https://{workspace_host}/api/2.1/jobs/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a job and all its associated runs. The job is permanently removed and cannot be recovered." }, { "info": { "name": "Databricks Trigger a Job Run", "type": "http" }, "http": { "method": "POST", "url": "https://{workspace_host}/api/2.1/jobs/run-now", "body": { "type": "json", "data": "{}" } }, "docs": "Triggers an immediate run of a job. One run is triggered for each call. Runs triggered by run-now are considered triggered runs. Parameters can be passed to override the job defaults." }, { "info": { "name": "Databricks List Job Runs", "type": "http" }, "http": { "method": "GET", "url": "https://{workspace_host}/api/2.1/jobs/runs/list", "params": [ { "name": "job_id", "value": "500123", "type": "query", "description": "The job for which to list runs. If omitted, lists runs for all jobs." }, { "name": "active_only", "value": "true", "type": "query", "description": "If true, only active runs are included in the results; otherwise lists both active and completed runs." }, { "name": "completed_only", "value": "true", "type": "query", "description": "If true, only completed runs are included in the results." }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first run to return." }, { "name": "limit", "value": "10", "type": "query", "description": "The number of runs to return (max 25)." }, { "name": "run_type", "value": "JOB_RUN", "type": "query", "description": "The type of runs to return." }, { "name": "expand_tasks", "value": "true", "type": "query", "description": "Whether to include task details in each run." }, { "name": "start_time_from", "value": "10", "type": "query", "description": "Filter runs started after this time (epoch milliseconds)." }, { "name": "start_time_to", "value": "10", "type": "query", "description": "Filter runs started before this time (epoch milliseconds)." } ] }, "docs": "Lists runs from most recently started to least. Results are paginated. Runs can be filtered by job, active state, and completion status." }, { "info": { "name": "Databricks Get a Job Run", "type": "http" }, "http": { "method": "GET", "url": "https://{workspace_host}/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 start time, end time, status, and task details." }, { "info": { "name": "Databricks Cancel a Job Run", "type": "http" }, "http": { "method": "POST", "url": "https://{workspace_host}/api/2.1/jobs/runs/cancel", "body": { "type": "json", "data": "{}" } }, "docs": "Cancels an active run. The run is canceled asynchronously, and the request returns immediately. The canceled run transitions to a TERMINATING state." }, { "info": { "name": "Databricks Get Run Output", "type": "http" }, "http": { "method": "GET", "url": "https://{workspace_host}/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. This endpoint can be used for notebook, JAR, Python, and Spark submit task outputs." } ] } ], "bundled": true }