notices/delete_comment

Namespace Name Admin Only Log Summary Generates Event Version Added
notices delete yes no yes 1

Description

Delete a comment from an alert notice. This can be done for any notice, even ones that have been marked as resolved.

Administrator Access Only : This change is permanent and cannot be undone.

Input Arguments

  • Required inputs:
    • “aid” : (string) ID for the alert notice to comment on
    • “comment” : (JSON array of strings) Each item in the array should contain the preamble to the comment which needs to be deleted.

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "aid" : "3",
  "comment" : ["[20180102T15:32:55Z](admin_1)"]
}

Reply Example

{
  "3" : {
    "aid" : "3",
    "caid" : "alert_rule_4",
    "tvid" : "server_id_1",
    "source" : "memory",
    "resolved" : false,
    "resolved_by" : "",
    "resolved_time" : "",
    "priority" : "warning",
    "system_time_triggered" : [1104541261]
    "alert_rule" : {
      "caid" : "alert_rule_4",
      "tvid" : "",
      "source" : "memory",
      "type" : "memory-free",
      "dataset" : "value",
      "alerttype" : "less_than",
      "value" : "20%",
      "priority" : "warning",
      "isactive" : true
    },
    "comments" : []
  }
}

Events

Events from this change will be sent to all administrators and any user with read access to impacted server(s).

Example:

{
  "namespace" : "event",
  "name" : "",
  "id" : "event",
  "args" : {

  }
}

Log Summary

This API call does not generate a detailed log summary item

See Also