Method: projects.locations.environments.list

List environments.

HTTP request

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

The URL uses Google API HTTP annotation 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 Google IAM permission on the specified resource parent:

  • composer.environments.list

Query parameters

Parameters
pageSize

number

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

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

The environments in a project and location.

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 Auth Guide.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Google Cloud Composer