Method: collectors.list

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

List all collectors for the forwarder.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}/collectors

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

The maximum number of collectors to return, though the service may return fewer than this value. If unspecified, at most 50 collectors 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 ListCollectors call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

ListCollectors response message. NEXT TAG: 3

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

JSON representation 
{
  "collectors": [
    {
      object (Collector)
    }
  ],
  "next_page_token": string
}
Fields
collectors[]

object (Collector)

List of collectors.
next_page_token

string

A token, which can be sent as page_token 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.collectors.list

For more information, see the IAM documentation.