astro api registry

Make HTTP requests to the Airflow Provider Registry API. No authentication is required. The argument can be either:

A path of a registry API endpoint, such as /providers.json or /providers/amazon/modules.json
An operation ID from the API spec, such as listProviders or getProviderModulesLatest

The /api prefix is added automatically to paths. Use astro api registry ls to discover all available endpoints and operation IDs.

Usage

astro api registry <endpoint | operation-id> [flags]

Commands

Command	Description
`ls`	List all available registry API endpoints. Supports an optional filter argument
`describe <endpoint>`	Show details about an endpoint, including path parameters and response schema

Options

Option	Description	Possible Values
`-F`, `--field`	Add a typed parameter in `key=value` format.	Any valid key-value pair
`--generate`	Print the equivalent `curl` command instead of executing the request.	None
`-H`, `--header`	Add an HTTP request header in `key:value` format.	Any valid header
`-i`, `--include`	Include HTTP response status line and headers in the output.	None
`--input`	The file to use as the body for the HTTP request. Use `-` for stdin.	A valid file path
`-q`, `--jq`	Apply a `jq` filter to the response output.	Any valid `jq` expression
`-X`, `--method`	The HTTP method for the request. The default is `GET`.	Any valid HTTP method
`-p`, `--path-param`	Override a path parameter in `key=value` format. For use with operation IDs.	A key-value pair such as `providerId=amazon`
`-f`, `--raw-field`	Add a string parameter in `key=value` format.	Any valid key-value pair
`--registry-url`	Override the registry base URL. Can also be set with the `ASTRO_REGISTRY_URL` environment variable.	A valid URL
`--silent`	Suppress response output.	None
`-t`, `--template`	Format the response using a Go template.	Any valid Go template string
`--verbose`	Include full HTTP request and response in the output.	None

Examples

# List all available registry API endpoints
astro api registry ls

# Filter endpoints by keyword
astro api registry ls providers

# Query by operation ID with path parameters
astro api registry getProviderModulesLatest -p providerId=amazon

# Query by path
astro api registry /providers.json

# Use jq filter on response
astro api registry /providers.json --jq '.providers[0].id'

# Use Go template for output
astro api registry listProviders \
  --template '{{range .providers}}{{.id}}{{"\n"}}{{end}}'

# Generate curl command instead of executing
astro api registry /providers.json --generate

# Show full request and response details
astro api registry /providers.json --verbose

Overview

Install the CLI

Develop with the CLI

Configure the CLI

Release information

Archived versions

Usage

Commands

Options

Examples

​Usage

​Commands

​Options

​Examples

​Related commands

Usage

Commands

Options

Examples

Related commands