Method: legacySdk.legacyGetSyncAlerts

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

Legacy RPC for getting sync alerts.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance of the legacy sdk. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "alertGroupIds": [
    string
  ]
}
Fields
alertGroupIds[]

string

Required. The alerts to sync request data.

Response body

The LegacySdkGetSyncAlertsResponse message.

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

JSON representation 
{
  "payload": [
    {
      object (ApiSyncAlert)
    }
  ]
}
Fields
payload[]

object (ApiSyncAlert)

The sync alerts.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ApiSyncAlert

ApiSyncAlert message.

JSON representation 
{
  "groupId": string,
  "id": string,
  "caseId": string,
  "environment": string,
  "priority": enum (ApiSyncAlertPriority),
  "status": enum (ApiSyncAlertStatus),
  "ticketId": string,
  "creationTimeUnixTimeInMs": string,
  "closeComment": string,
  "closeRootCause": string,
  "siemAlertId": string,
  "closeReason": enum (ApiSyncAlertCloseReason),
  "closeUsefulness": enum (ApiSyncAlertUsefulness)
}
Fields
groupId

string

Alert group identifier.
id

string

Alert identifier.
caseId

string (int64 format)

Case identifier.
environment

string

Environment name which the alert is associated with.
priority

enum (ApiSyncAlertPriority)

Alert priority.
status

enum (ApiSyncAlertStatus)

Alert status.
ticketId

string

Original identifier of the alert in its source system.
creationTimeUnixTimeInMs

string (int64 format)

Alert creation time in unix format as milliseconds.
closeComment

string

Close comment.
closeRootCause

string

Close root cause.
siemAlertId

string

Chronicle SIEM alert identifier.
closeReason

enum (ApiSyncAlertCloseReason)

Close reason.
closeUsefulness

enum (ApiSyncAlertUsefulness)

Close usefulness.

ApiSyncAlertPriority

ApiSyncAlertPriority enum.

Enums
INFORMATIVE Informative.
UNCHANGED Unchanged.
LOW Low.
MEDIUM Medium.
HIGH High.
CRITICAL Critical.

ApiSyncAlertStatus

ApiSyncAlertStatus enum.

Enums
OPENED Opened.
CLOSED Closed.

ApiSyncAlertCloseReason

ApiSyncAlertCloseReason enum.

Enums
MALICIOUS Malicious.
NOT_MALICIOUS Not malicious.
MAINTENANCE Maintenance.
INCONCLUSIVE Inconclusive.
UNKNOWN Unknown.

ApiSyncAlertUsefulness

ApiSyncAlertUsefulness enum.

Enums
NONE None.
NOT_USEFUL Not useful.
USEFUL Useful.