Method: forwarders.list

Full name: projects.locations.instances.forwarders.list

List all forwarders for the instance.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent resource where the Forwarder is located. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

The maximum number of forwarders to return, though the service may return fewer than this value. If unspecified, at most 50 forwarders will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous forwarders.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

forwarders.list response message. NEXT TAG: 3

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

JSON representation 
{
  "forwarders": [
    {
      object (Forwarder)
    }
  ],
  "nextPageToken": string
}
Fields
forwarders[]

object (Forwarder)

List of forwarders.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.forwarders.list

For more information, see the IAM documentation.