Method: projects.locations.environments.list

Lists environments in a project.

HTTP request

GET https://notebooks.googleapis.com/v1/{parent}/environments

Path parameters

Parameters
parent

string

Required. Format: projects/{project_id}/locations/{location}

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

  • notebooks.environments.list

Query parameters

Parameters
pageSize

integer

Maximum return size of the list call.

pageToken

string

A previous returned page token that can be used to continue listing from the last result.

Request body

The request body must be empty.

Response body

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

Response for listing environments.

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

object (Environment)

A list of returned environments.

nextPageToken

string

A page token that can be used to continue listing from the last result in the next list call.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.