Security Deck Alerts API, REST: Alert.List

Field

Description

sinkId

string

Required field. Alert sink ID.

The maximum string length in characters is 50.

Field

Description

languageCode

string

Language code. What language should alert texts be in.
Supported values: "en_US" for English, "ru_RU" for Russian.
If requested language is unavailable, language-dependent fields will be omitted.
Optional. Defaults to "en_US" if not specified.

The maximum string length in characters is 10.

filter

string

Filtering expression. See documentation on filter capabilities and syntax.
Optional. Not filtering if not specified.

The maximum string length in characters is 2048.

orderBy[]

string

Sorting order.
Element format: "<field_name> [asc|desc]".
Optional. Defaults to "create_time desc" if not specified.

The maximum number of elements is 1.

pageSize

string (int64)

Number of results per page.

The maximum value is 1000.

pageToken

string

Token for the results page.

The maximum string length in characters is 200.

Field

Description

alerts[]

Alert

Requested alerts.
Only a subset of fields that makes sense for listing is returned (e.g. description, recommendations and details are omitted).

nextPageToken

string

Token for the next results page.

Field

Description

id

string

ID of the alert.

sinkId

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.
Optional. Only present in Get method response.
May be absent in Get method response if description is not available in requested language.

recommendations

string

Alert recommendations. Yandex Flavored Markdown in requested language.
Optional. Only present in Get method response.
May be absent in Get method response if recommendations are not available in requested language.

severity

enum (Severity)

Alert severity.

• INFO: Informational severity
• LOW: Low severity
• MEDIUM: Medium severity
• HIGH: High severity

status

enum (Status)

Alert status.

• OPEN: Status is "open". Alert is not being currently processed.
• IN_PROGRESS: Status is "in progress". Alert assignee is currently processing the alert.
• NEED_INFO: Status is "need info". Alert assignee cannot currently process the alert and requires additional information.
• RESOLVED: Status is "resolved". Alert processing has concluded.

category

Category

Alert category (aka threat type).

classification

enum (Classification)

Alert classification.
Optional. Can be assigned after creation.

• TRUE_POSITIVE: Alert represents an actual problem that needs to be mitigated.
• BENIGN_POSITIVE: Alert represents a legitimate problem but does not require attention.
• FALSE_POSITIVE: Alert represents something that's not an issue.
• UNDETERMINED: Alert relevance cannot be determined.

createdBy

Actor

Who created the alert.

assignee

Assignee

Who the alert is assigned to.
Optional. Can be assigned after creation.

createTime

string (date-time)

Alert creation time.
This time is reported by alert creator and can generally be different from the moment the alert record was created.
E.g. a security event occurred at time A and it took B amount of time to deliver the alert to the Alert Sink.
This time is the A and not the A+B.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updateTime

string (date-time)

Alert modification time.
Represents last time alert record itself was modified, not including anything alert-related (comments, etc.)
Equals to create_time immediately after creation.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

details

object

Alert technical details.
Optional. Only present in Get method response.

Field

Description

name

string

Alert category name.

Field

Description

subject

Subject

Action was performed by a specific Cloud subject.

Includes only one of the fields subject, sensor.

sensor

Sensor

Action was performed by (or on behalf of) an alert provider system (aka sensor)

Includes only one of the fields subject, sensor.

Field

Description

id

string

Subject ID.

Field

Description

id

string

Sensor ID.

Field

Description

subject

Subject

Alert is assigned to as specific Cloud subject.

Includes only one of the fields subject.

Field

Description

id

string

Subject ID.