On September 15, 2026, all Cloud Composer 1 versions and versions 2.0.x of Cloud Composer 2 will reach their planned end of life. You will not be able to use environments with these versions. We recommend planning migration to Cloud Composer 3. Cloud Composer 2 versions 2.1.x and later are still supported and are not impacted by this change.

Method: projects.locations.environments.list

List environments.

HTTP request

GET https://composer.googleapis.com/v1/{parent=projects/*/locations/*}/environments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"

Authorization requires the following IAM permission on the specified resource parent:

  • composer.environments.list

Query parameters

Parameters
pageSize

integer

The maximum number of environments to return.
pageToken

string

The nextPageToken value returned from a previous List request, if any.

Request body

The request body must be empty.

Response body

The environments in a project and location.

If successful, the response body contains data with the following structure:

JSON representation 
{
 "environments": [
 {
 object (Environment )
 }
 ],
 "nextPageToken": string
}
Fields
environments[]

object (Environment )

The list of environments returned by a ListEnvironmentsRequest.
nextPageToken

string

The page token used to query for the next page if one exists.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年06月30日 UTC.