Method: collectors.patch

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

Update a collector.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{collector.name}

Path parameters

Parameters
collector.name

string

Immutable. The resource ID of the Collector. Format: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder}/collectors/{collector}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Specifies which collector fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Collector.

Response body

If successful, the response body contains an instance of Collector.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.collectors.update

For more information, see the IAM documentation.