> ## Documentation Index
> Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# astro api cloud

Make authenticated requests to the [Astro platform API](https://www.astronomer.io/docs/astro/api/v-1/overview) using the current context's bearer token.

## Usage

```bash wrap theme={null}
astro api cloud [command] [flags]
```

## Commands

| Command                                | Description                                                               |
| -------------------------------------- | ------------------------------------------------------------------------- |
| `ls`                                   | List all available Astro API endpoints.                                   |
| `describe <operation-id>`              | Show details about an endpoint, including parameters and response schema. |
| `<operation-id> [request-body-fields]` | Call an endpoint by its operation ID.                                     |

## Options

| Option                     | Description                                                                                                                                                              | Possible Values                                    |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
| `--generate`               | Print the equivalent `curl` command instead of executing the request.                                                                                                    | None                                               |
| `--jq <filter>`            | Apply a `jq` filter to the response output.                                                                                                                              | Any valid `jq` expression                          |
| `--path-param <key=value>` | Override a path parameter in the request URL.                                                                                                                            | A key-value pair such as `organizationId=<org-id>` |
| `--silent`                 | Suppress response output.                                                                                                                                                | None                                               |
| `--slurp`                  | Collect all paginated results into a single array instead of streaming pages.                                                                                            | None                                               |
| `--spec-url`               | An OpenAPI spec source. Supports HTTP URLs as well as local file paths (absolute, relative, `~/`, or `file://`). Local specs are read fresh on every command invocation. | A valid HTTP URL or local file path                |
| `--spec-token-env-var`     | The name of an environment variable that holds a bearer token used to fetch a remote spec. Ignored when `--spec-url` is a local file path.                               | Any valid environment variable name                |
| `--template <template>`    | Format the response using a Go template.                                                                                                                                 | Any valid Go template string                       |

## Examples

```bash wrap theme={null}
# List all available Astro API endpoints
$ astro api cloud ls

# Show details about the list-deployments endpoint
$ astro api cloud describe list-deployments

# List Deployments for an organization
$ astro api cloud list-deployments --path-param organizationId=<org-id>

# Filter the response with jq
$ astro api cloud list-deployments --path-param organizationId=<org-id> --jq '.deployments[].name'

# Print the equivalent curl command for a request
$ astro api cloud list-deployments --path-param organizationId=<org-id> --generate
```

## Related commands

* [`astro api airflow`](/docs/cli/v1.42/astro-api-airflow)