Method: legacy.legacyGetAlert

Full name: projects.locations.instances.legacy.legacyGetAlert

RPC for fetching an alert based on its Alert Id.

HTTP request


Path parameters

Parameters
instance

string

Required. Chronicle instance this request is sent to. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
alertId

string

Required. The ID of the collection to return.
includeDetections

boolean

Optional. If set to true, response will include non-alerting detections.

Request body

The request body must be empty.

Response body

Returns Alert for a given Collection Id. NEXT TAG: 2

If successful, the response body contains data with the following structure:

JSON representation 
{
  "alert": {
    object (Collection)
  }
}
Fields
alert

object (Collection)

Alert as Collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacies.legacyGetAlert

For more information, see the IAM documentation.