# Cloud Composer API API

> Cloud Composer API API on Apizie: 22 endpoints (Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be…, List environments., Create a new environment., Triggers database failover (only for highly resilient environments)., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/analytics:googleapis-composer/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-composer`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/composer/
- Page: https://zieapi.vercel.app/api/analytics/googleapis-composer
- OpenAPI: https://zieapi.vercel.app/api/analytics/googleapis-composer/openapi.json

Manages Apache Airflow environments on Google Cloud Platform.

## Endpoints

### Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-check-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | Required. The resource name of the environment to check upgrade for, in the form:… |
| body | object | yes | JSON request body |

### List environments.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of environments to return. |
| pageToken | string | no | The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" |

### Create a new environment.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | The parent must be of the form "projects/{projectId}/locations/{locationId}". |
| body | object | yes | JSON request body |

### Triggers database failover (only for highly resilient environments).
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-database-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| body | object | yes | JSON request body |

### Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-operations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource. |

### Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-user-workloads-secr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Identifier. The resource name of the Secret, in the form:… |
| body | object | yes | JSON request body |

### Update an environment.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The relative resource name of the environment to update, in the form:… |
| updateMask | string | no | Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn… |
| body | object | yes | JSON request body |

### Deletes a long-running operation. This method indicates that the client is no longer interested in the…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-operations-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be deleted. |

### Executes Airflow CLI command.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-execute-airflow-com` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". |
| body | object | yes | JSON request body |

### Fetches database properties.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-fetch-database-prop` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |

### Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-load-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| body | object | yes | JSON request body |

### Polls Airflow CLI command execution and fetches logs.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-poll-airflow-comman` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| body | object | yes | JSON request body |

### Restart Airflow web server.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-restart-web-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the environment to restart the web server for, in the form:… |
| body | object | yes | JSON request body |

### Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-save-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| body | object | yes | JSON request body |

### Stops Airflow CLI command execution.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-stop-airflow-comman` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| environment | string | yes | The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". |
| body | object | yes | JSON request body |

### Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-user-workloads-conf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. The maximum number of ConfigMaps to return. |
| pageToken | string | no | Optional. The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. List ConfigMaps in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |

### Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-user-workloads-conf-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The environment name to create a ConfigMap for, in the form:… |
| body | object | yes | JSON request body |

### Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-user-workloads-secr-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. The maximum number of Secrets to return. |
| pageToken | string | no | Optional. The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. List Secrets in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |

### Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-user-workloads-secr-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The environment name to create a Secret for, in the form:… |
| body | object | yes | JSON request body |

### Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component.…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-workloads-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression… |
| pageSize | integer | no | Optional. The maximum number of environments to return. |
| pageToken | string | no | Optional. The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |

### List ImageVersions for provided location.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-image-versions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| includePastReleases | boolean | no | Whether or not image versions from old releases should be included. |
| pageSize | integer | no | The maximum number of image_versions to return. |
| pageToken | string | no | The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

## Example
```
curl "https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-check-upgrade" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Cloud Composer API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/analytics:googleapis-composer/composer-projects-locations-environments-check-upgrade with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Cloud Composer API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Cloud Composer API itself also needs your own key from googleapis.com.

### Can AI agents use the Cloud Composer API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-composer.

### What is the status of the Cloud Composer API API?
Needs your own provider key (bring your own key)