Method: instances.updateAgentSettings

Full name: projects.locations.instances.updateAgentSettings

instances.updateAgentSettings updates the agent settings for an instance.

HTTP request

PATCH https://{endpoint}/v1alpha/{agentSettings.name}

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
agentSettings.name

string

Identifier. The resource name of the AgentSettings. Format: projects/{project}/locations/{location}/instances/{instance}/agentSettings

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to be updated.

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 AgentSettings.

Response body

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

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.agentSettings.update

For more information, see the IAM documentation.