Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Make authenticated requests to the Airflow REST API.
astro api airflow [command] [flags]
| Command | Description |
|---|---|
ls | List all available Airflow REST API endpoints. |
describe <operation-id> | Show details about an endpoint, including parameters and a fully expanded response schema. |
<operation-id> [request-body-fields] | Call an endpoint by its operation ID. |
-d flag with a Deployment ID.
| Option | Description | Possible Values |
|---|---|---|
--generate | Print the equivalent curl command instead of executing the request. | None |
-d, --deployment-id | The ID of an Astro Deployment to send the request to. | Any valid Deployment ID |
--jq <filter> | Apply a jq filter to the response output. | Any valid jq expression |
--json | Output the ls or describe result as JSON instead of a formatted table. | None |
--path-param <key=value> | Override a path parameter in the request URL. | A key-value pair such as dagId=my_dag |
--silent | Suppress response output. | None |
--slurp | Collect all paginated results into a single array instead of streaming pages. | None |
--template <template> | Format the response using a Go template. | Any valid Go template string |
# List all available Airflow REST API endpoints for a local environment
$ astro api airflow ls
# Show details about the get_dags endpoint
$ astro api airflow describe get_dags
# Call the get_health endpoint on a local Airflow instance
$ astro api airflow get_health
# Call the get_dags endpoint on a deployed Airflow instance
$ astro api airflow get_dags -d <deployment-id>
# Call an endpoint and filter the response with jq
$ astro api airflow get_dags --jq '.dags[].dag_id'
# Print the equivalent curl command for a request
$ astro api airflow get_health --generate
Was this page helpful?