Method: instances.getAgentSettings

Full name: projects.locations.instances.getAgentSettings

instances.getAgentSettings gets the agent settings for an instance.

HTTP request

GET https://{endpoint}/v1alpha/{name}

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

Path parameters

Parameters
name

string

Required. The resource name to retrieve the AgentSettings for the instance. Format: projects/{project}/locations/{location}/instances/{instance}/agentSettings

Request body

The request body must be empty.

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

For more information, see the IAM documentation.