Security Deck Alerts API, REST: Comment.List
List comments.
HTTP request
GET https://alert-sink.api.cloud.yandex.net/securitydeck/alerts/v1/alerts/{alertId}/comments
Path parameters
|
Field |
Description |
|
alertId |
string Required field. Alert ID. The maximum string length in characters is 50. |
Query parameters
|
Field |
Description |
|
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. |
Response
HTTP Code: 200 - OK
{
"comments": [
{
"id": "string",
"alertId": "string",
"createdBy": {
// Includes only one of the fields `subject`, `sensor`
"subject": {
"id": "string"
},
"sensor": {
"id": "string"
}
// end of the list of possible fields
},
"createTime": "string",
"updatedBy": {
// Includes only one of the fields `subject`, `sensor`
"subject": {
"id": "string"
},
"sensor": {
"id": "string"
}
// end of the list of possible fields
},
"updateTime": "string",
"text": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
comments[] |
Requested comments. |
|
nextPageToken |
string Token for the next results page. |
Comment
A comment.
|
Field |
Description |
|
id |
string Comment ID. |
|
alertId |
string ID of the alert the comment is for. |
|
createdBy |
Who created the comment. |
|
createTime |
string (date-time) Comment creation date. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedBy |
Who modified the comment last. |
|
updateTime |
string (date-time) When was the comment last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
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. |