Failed Runbooks

To get a list of top k runbooks that failed during execution.

API Failed Runbooks
Purpose Get a list of runbooks that failed during execution
API URL

https://<API URL>:<API Port>/v2/incident/failedRunbooks/{orgentityid}/count/{count}

Authentication type Basic/Token
Method Type GET
Input Params in Query String:

You can pass the following filters in the URL to get desired data:

  • orgentityid
  • count

Parameters Required in Request body of API

Column Column type Remarks
orgentityid string The organization entity ID.
count integer It defines how many results should be retrieved.

Output:

{
 "Count": 2,
 "Result": [
 "Check_Service_Windows", "Cpu_utilization_high"
 ],
 "Status": "Success",
 "Message": "Success"
}

Parameters Returned in Response of API

Column Column type Value Remarks
Count int count This field contains count of failed runbooks
Result array List List of failed runbooks
Status string Success/Fail This field provides status
Message string Message This field provides Message