Method: projects.locations.list

Lists information about the supported locations for this service. This method can be called in two ways:

  • List all public locations: Use the pathGET /v1/locations.
  • List project-visible locations: Use the pathGET /v1/projects/{projectId}/locations. This may include public locations as well as private or other locations specifically visible to the project.

HTTP request

GET https://vectorsearch.googleapis.com/v1/{name}/locations

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 inAIP-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 thenextPageToken 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

If successful, the response body contains an instance ofListLocationsResponse.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

  • vectorsearch.locations.list

For more information, see theIAM documentation.

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

Last updated 2026-01-29 UTC.