- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
Lists information about the supported locations for this service.
HTTP request
The URLs use gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name
|
The resource that owns the locations collection, if applicable. |
Query parameters
| Parameters | |
|---|---|
filter
|
A filter to narrow down results to a preferred subset. The filtering language accepts strings like |
pageSize
|
The maximum number of results to return. If not set, the service selects a default. |
pageToken
|
A page token received from the |
extraLocationTypes[]
|
Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. |
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 (
|
| Fields | |
|---|---|
locations[]
|
A list of locations that matches the specified filter in the request. |
nextPageToken
|
The standard List next-page token. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the Authentication Overview .

