Cloud Composer API
Manages Apache Airflow environments on Google Cloud Platform.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manages Apache Airflow environments on Google Cloud Platform.
Endpoints 24
projects.locations.environments
- POSTCheck if an upgrade operation on the environment will succeed
/v1/:environment:checkUpgradeCheck if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation. - GETList environments.
/v1/:parent/environments?pageSize=0&pageToken=stringList environments. - POSTCreate a new environment.
/v1/:parent/environmentsCreate a new environment. - POSTTriggers database failover (only for highly resilient environments).
/v1/:environment:databaseFailoverTriggers database failover (only for highly resilient environments). - PATCHUpdate an environment.
/v1/:name?updateMask=stringUpdate an environment. - POSTExecutes Airflow CLI command.
/v1/:environment:executeAirflowCommandExecutes Airflow CLI command. - GETFetches database properties.
/v1/:environment:fetchDatabasePropertiesFetches database properties. - POSTHibernates (pauses) a running environment
/v1/:name:hibernateHibernates (pauses) a running environment. It requests the environment to switch to the HIBERNATED state, keeping its data and minimizing cost, but not… - POSTLoads a snapshot of a Cloud Composer environment
/v1/:environment:loadSnapshotLoads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into… - POSTPolls Airflow CLI command execution and fetches logs.
/v1/:environment:pollAirflowCommandPolls Airflow CLI command execution and fetches logs. - POSTRestart Airflow web server.
/v1/:name:restartWebServerRestart Airflow web server. - POSTResumes (unpauses) a hibernated environment
/v1/:name:resumeResumes (unpauses) a hibernated environment. It requests the environment to switch to the RUNNING state, so that it is ready to use and run DAGs. This method… - POSTCreates a snapshots of a Cloud Composer environment
/v1/:environment:saveSnapshotCreates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the… - POSTStops Airflow CLI command execution.
/v1/:environment:stopAirflowCommandStops Airflow CLI command execution.
projects.locations.operations
- GETGets the latest state of a long-running operation
/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.environments.userWorkloadsSecrets
- PUTUpdates a user workloads Secret
/v1/:nameUpdates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. - GETLists user workloads Secrets
/v1/:parent/userWorkloadsSecrets?pageSize=0&pageToken=stringLists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. - POSTCreates a user workloads Secret
/v1/:parent/userWorkloadsSecretsCreates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
projects.locations.environments.userWorkloadsConfigMaps
- GETLists user workloads ConfigMaps
/v1/:parent/userWorkloadsConfigMaps?pageSize=0&pageToken=stringLists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. - POSTCreates a user workloads ConfigMap
/v1/:parent/userWorkloadsConfigMapsCreates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.
projects.locations.environments.workloads
- GETLists workloads in a Cloud Composer environment
/v1/:parent/workloads?filter=string&pageSize=0&pageToken=stringLists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer…
projects.locations.imageVersions
- GETList ImageVersions for provided location.
/v1/:parent/imageVersions?includePastReleases=true&pageSize=0&pageToken=stringList ImageVersions for provided location.
API details
- Base URL
https://composer.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter - Operations
- 24 operations on 18 pathsPOST 13GET 8PUT 1PATCH 1DELETE 1
- Main resources
- projects.locations.environments 14projects.locations.environments.userWorkloadsSecrets 3projects.locations.operations 3projects.locations.environments.userWorkloadsConfigMaps 2projects.locations.environments.workloads 1projects.locations.imageVersions 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Composer API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Composer API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Check if an upgrade operation on the environment will succeed” (POST /v1/:environment:checkUpgrade), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Composer API?
Manages Apache Airflow environments on Google Cloud Platform. It is listed under Developer tools and has 24 endpoints.
Who publishes the Cloud Composer API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Composer API?
Requests go to https://composer.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Composer API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Composer API have?
24 operations on 18 paths (13 POST, 8 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are projects.locations.environments, projects.locations.environments.userWorkloadsSecrets, projects.locations.operations, projects.locations.environments.userWorkloadsConfigMaps.
Is forking the Cloud Composer API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.