Method: collectors.patch

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

Update a collector.

HTTP request


Path parameters



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

Query parameters


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 the following OAuth scope:


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.