cancel
Showing results for 
Search instead for 
Did you mean: 
Community Platform Discussions
Connect with fellow community members to discuss general topics related to the Databricks platform, industry trends, and best practices. Share experiences, ask questions, and foster collaboration within the community.
cancel
Showing results for 
Search instead for 
Did you mean: 

How obtain a list of workflows in Databricks?

VabethRamirez
New Contributor II

I need to obtain a list of my Databricks workflows with their job IDs in a notebook Databricks

1 ACCEPTED SOLUTION

Accepted Solutions

shan_chandra
Esteemed Contributor III
Esteemed Contributor III

@VabethRamirez - Please find the below code snippet. Kindly modify according to your needs.

import requests, json

# Set the Databricks API URL. <eg. dbi.databricks.cloud.com>
api_url = 'https://<URL>/api/2.1'

# Set the Databricks token
token = '<API token>'

# Get a list of all jobs
jobs_endpoint = f"{api_url}/jobs/list"

headers = {
    'Authorization': f"Bearer {token}",
    'Content-Type': 'application/json'
}

response = requests.get(jobs_endpoint, headers=headers)

if response.status_code == 200:
    # Extract the list of jobs
    jobs = response.json()['jobs']
    
    # Print the job names and IDs
    for job in jobs:
        print(f"Job ID: {job['job_id']}, Job Name: {job['settings']['name']}")
else:
    print(f"Failed to retrieve jobs. Status Code: {response.status_code}")

 

View solution in original post

5 REPLIES 5

Lakshay
Esteemed Contributor III
Esteemed Contributor III

shan_chandra
Esteemed Contributor III
Esteemed Contributor III

@VabethRamirez - Please find the below code snippet. Kindly modify according to your needs.

import requests, json

# Set the Databricks API URL. <eg. dbi.databricks.cloud.com>
api_url = 'https://<URL>/api/2.1'

# Set the Databricks token
token = '<API token>'

# Get a list of all jobs
jobs_endpoint = f"{api_url}/jobs/list"

headers = {
    'Authorization': f"Bearer {token}",
    'Content-Type': 'application/json'
}

response = requests.get(jobs_endpoint, headers=headers)

if response.status_code == 200:
    # Extract the list of jobs
    jobs = response.json()['jobs']
    
    # Print the job names and IDs
    for job in jobs:
        print(f"Job ID: {job['job_id']}, Job Name: {job['settings']['name']}")
else:
    print(f"Failed to retrieve jobs. Status Code: {response.status_code}")

 

VabethRamirez
New Contributor II
I managed to solve it with this solution
# Importar la biblioteca de Databricks
from databricks_api import DatabricksAPI
# Configurar el token de acceso a la API de Databricks
token = "<token>"
host = "<url_your_databricks_host>"

 

# Crear una instancia de la API de Databricks
db = DatabricksAPI(host=host, token=token)

 

# Obtener una lista de todos los workflows en Databricks
jobs_list = jobs['jobs']

 

# Iterar sobre los trabajos y obtener información detallada, incluyendo Job ID
for job in jobs_list:
    job_id = job['job_id']
    job_name = job['settings']['name']
    print(f"Job Name: {job_name}, Job ID: {job_id}")






 

Lakshay
Esteemed Contributor III
Esteemed Contributor III

Thank you for sharing!

artsheiko
Esteemed Contributor III
Esteemed Contributor III

Hi @VabethRamirez ,

Also, instead of using directly the API, you can use databricks Python sdk : 

%pip install databricks-sdk --upgrade
dbutils.library.restartPython()
from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
job_list = w.jobs.list(expand_tasks=False)

 Additional examples : https://github.com/databricks/databricks-sdk-py/tree/main/examples 

Connect with Databricks Users in Your Area

Join a Regional User Group to connect with local Databricks users. Events will be happening in your city, and you won’t want to miss the chance to attend and share knowledge.

If there isn’t a group near you, start one and help create a community that brings people together.

Request a New Group