Method: projects.locations.list

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field:

• Global locations: If name is empty, the method lists the public locations available to all projects.
• Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.

For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

HTTP request

Choose a location:

global africa-south1 asia-east1 asia-east2 asia-northeast1 asia-northeast2 asia-northeast3 asia-south1 asia-south2 asia-southeast1 asia-southeast2 asia-southeast3 australia-southeast1 australia-southeast2 europe-central2 europe-north1 europe-north2 europe-southwest1 europe-west1 europe-west10 europe-west12 europe-west2 europe-west3 europe-west4 europe-west6 europe-west8 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast1 northamerica-northeast2 northamerica-south1 southamerica-east1 southamerica-west1 us-central1 us-east1 us-east4 us-east5 us-south1 us-west1 us-west2 us-west3 us-west4 eu us

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

The URLs use 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 Authentication Overview.