Method: projects.locations.list

Lists information about the supported locations for this service.

HTTP request

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The resource that owns the locations collection, if applicable.

Query parameters

Parameters
filter

string

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
pageSize

integer

The maximum number of results to return. If not set, the service selects a default.
pageToken

string

A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
extraLocationTypes[]

string

Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

Request body

The request body must be empty.

Response body

The response message for Locations.ListLocations.

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

JSON representation 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
Fields
locations[]

object (Location)

A list of locations that matches the specified filter in the request.
nextPageToken

string

The standard List next-page token.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.