Security Deck Alerts API, gRPC: AlertService.List
List alerts.
gRPC request
rpc List (ListAlertsRequest) returns (ListAlertsResponse)
ListAlertsRequest
{
"sink_id": "string",
"language_code": "string",
"filter": "string",
"order_by": [
"string"
],
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
sink_id |
string Required field. Alert sink ID. The maximum string length in characters is 50. |
|
language_code |
string Language code. What language should alert texts be in. The maximum string length in characters is 10. |
|
filter |
string Filtering expression. See documentation on filter capabilities and syntax. The maximum string length in characters is 2048. |
|
order_by[] |
string Sorting order. The maximum number of elements is 1. |
|
page_size |
int64 Number of results per page. The maximum value is 1000. |
|
page_token |
string Token for the results page. The maximum string length in characters is 200. |
ListAlertsResponse
{
"alerts": [
{
"id": "string",
"sink_id": "string",
"title": "string",
"description": "string",
"recommendations": "string",
"severity": "Severity",
"status": "Status",
"category": {
"name": "string"
},
"classification": "Classification",
"created_by": {
// Includes only one of the fields `subject`, `sensor`
"subject": {
"id": "string"
},
"sensor": {
"id": "string"
}
// end of the list of possible fields
},
"assignee": {
// Includes only one of the fields `subject`
"subject": {
"id": "string"
}
// end of the list of possible fields
},
"create_time": "google.protobuf.Timestamp",
"update_time": "google.protobuf.Timestamp",
"details": "google.protobuf.Struct"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
alerts[] |
Requested alerts. |
|
next_page_token |
string Token for the next results page. |
Alert
Security Deck alert.
|
Field |
Description |
|
id |
string ID of the alert. |
|
sink_id |
string ID of the alert sink alert is in. |
|
title |
string Alert title. Plain text in requested language. |
|
description |
string Alert description. Yandex Flavored Markdown in requested language. |
|
recommendations |
string Alert recommendations. Yandex Flavored Markdown in requested language. |
|
severity |
enum Severity Alert severity.
|
|
status |
enum Status Alert status.
|
|
category |
Alert category (aka threat type). |
|
classification |
enum Classification Alert classification.
|
|
created_by |
Who created the alert. |
|
assignee |
Who the alert is assigned to. |
|
create_time |
Alert creation time. |
|
update_time |
Alert modification time. |
|
details |
Alert technical details. |
Category
Alert category.
|
Field |
Description |
|
name |
string Alert category name. |
Actor
Information about an entity that performed an action (created an alert, added a comment, etc.).
|
Field |
Description |
|
subject |
Action was performed by a specific Cloud subject. Includes only one of the fields |
|
sensor |
Action was performed by (or on behalf of) an alert provider system (aka sensor) Includes only one of the fields |
Subject
Cloud subject.
|
Field |
Description |
|
id |
string Subject ID. |
Sensor
Alert provider system (aka sensor).
|
Field |
Description |
|
id |
string Sensor ID. |
Assignee
Information about an entity that alert was assigned to.
|
Field |
Description |
|
subject |
Alert is assigned to as specific Cloud subject. Includes only one of the fields |
Subject
Cloud subject.
|
Field |
Description |
|
id |
string Subject ID. |