Security Deck Alerts API, gRPC: CommentService.List
List comments.
gRPC request
rpc List (ListCommentsRequest) returns (ListCommentsResponse)
ListCommentsRequest
{
"alert_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
alert_id |
string Required field. Alert ID. The maximum string length in characters is 50. |
|
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. |
ListCommentsResponse
{
"comments": [
{
"id": "string",
"alert_id": "string",
"created_by": {
// Includes only one of the fields `subject`, `sensor`
"subject": {
"id": "string"
},
"sensor": {
"id": "string"
}
// end of the list of possible fields
},
"create_time": "google.protobuf.Timestamp",
"updated_by": {
// Includes only one of the fields `subject`, `sensor`
"subject": {
"id": "string"
},
"sensor": {
"id": "string"
}
// end of the list of possible fields
},
"update_time": "google.protobuf.Timestamp",
"text": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
comments[] |
Requested comments. |
|
next_page_token |
string Token for the next results page. |
Comment
A comment.
|
Field |
Description |
|
id |
string Comment ID. |
|
alert_id |
string ID of the alert the comment is for. |
|
created_by |
Who created the comment. |
|
create_time |
Comment creation date. |
|
updated_by |
Who modified the comment last. |
|
update_time |
When was the comment last modified. |
|
text |
string The comment contents. Yandex Flavored Markdown. |
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. |