Method: projects.locations.gateways.list

Lists Gateways in a given project and location.

HTTP request

GET https://apigateway.googleapis.com/v1/{parent=projects/*/locations/*}/gateways

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource of the Gateway, of the form: projects/*/locations/*

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

  • apigateway.locations.get

Query parameters

Parameters
pageSize

integer

Page size.

pageToken

string

Page token.

filter

string

Filter.

orderBy

string

Order by parameters.

Request body

The request body must be empty.

Response body

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

Response message for ApiGatewayService.ListGateways

JSON representation
{
  "gateways": [
    {
      object (Gateway)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
gateways[]

object (Gateway)

Gateways.

nextPageToken

string

Next page token.

unreachableLocations[]

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.