question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

API Endpoint for Airflow V1 - DAGs details

See original GitHub issue

Description

We need to have the endpoint in Airflow V1 to retrieve details of existing DAG, e.g. GET /dags/{dag_id}/details

Use case / motivation

We want to be able to retrieve/discover the parameters that a DAG accepts. We can see that you pass parameters when you execute a dag via the conf object. We can also see that you explicitly declare parameters that a DAG accepts via the params argument when creating the DAG. However, we can’t see anywhere via either the REST API or CLI that allows you to retrieve this information from a DAG (note that we are not saying a DAG run). It doesn’t even look like version 2 API supports this although the OpenAPI spec mentions a dags/{dag_id}/details endpoint but this is not documented. We found the related GitHub issue for this new endpoint and it is done but looks like documentation isn’t yet updated. Please can you:

  1. Provide the response for the v2 details endpoint
  2. Advise when v2 documentation will be updated with the details endpoint.
  3. Advise if there is a workaround for us doing this on v1.1

Related Issues

#8138

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:22 (12 by maintainers)

github_iconTop GitHub Comments

4reactions
vemikhaylovcommented, Jan 19, 2021

I’d like to implement this if nobody minds

0reactions
mik-lajcommented, Jan 20, 2021

I agree. The DAG.params attribute should be available through the API.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Airflow REST API
To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects. This section provides an overview of the API...
Read more >
Airflow REST API: The Ultimate Guide for 2022 - Hevo Data
Apache Airflow has an API interface that can help you to perform tasks like getting information about tasks and DAGs, getting Airflow ......
Read more >
Trigger Airflow DAGs via the REST API | Enrollment Nerdery
Trigger Airflow DAGs via the REST API · Step 1 - Enable the REST API · Step 2: Test the API by Listing...
Read more >
Airflow API : The guide to get started now! - Marc Lamberti
The Airflow Stable REST API ... The Stable REST API meets the following requirements: ... To sum up, this new version makes for...
Read more >
Access the Airflow REST API | Cloud Composer - Google Cloud
Apache Airflow has a REST API interface that you can use to perform tasks such as getting information about DAG runs and tasks,...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found