Method: legacySdk.legacyGetAgentById

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Full name: projects.locations.instances.legacySdk.legacyGetAgentById

Returns the technical configuration and operational health status for a specific remote agent. Use this method to monitor the connectivity and execution state of off-premise investigative components.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySdk:legacyGetAgentById

Path parameters

Parameters
instance	string Required. The GetAgentById request. Format: projects/{project}/locations/{location}/instances/{instance}/legacySdk:getAgentById

Query parameters

Parameters
agentId	string Required. The agent id.
format	string Optional. The format of the field names in the response. Could be snake or camel.

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

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 instance resource:

• chronicle.legacySdk.get

For more information, see the IAM documentation.