Retrieve monitors with specific alert severity

GET 
/query/objects/severity

Call this API to obtain a list of monitors that have alerts matching the severity level specified in the severity parameter.

Request

Query Parameters

severity stringrequired

Specifies the severity of alerts to filter the list of monitors. Only monitors with alerts matching the provided severity will be returned. Valid values include the various alert's severity levels. The possible values for severity are as follows: 'Clear','Major','Warning','Critical','Down', and 'Unreachable'

Responses

200

Successful response. The request was successful and the response contains a list of monitors with the specified alert severity.

application/json

Schema

Schema

result object[]
Array [
id integer
object.name integer
severity string
]

Example (from schema)

{
  "result": [
    {
      "id": 1722858880,
      "object.name": "core.switch",
      "severity": "clear"
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

Request Forbidden. The client does not have permission to access this resource. This could be due to insufficient privileges.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request. This may indicate a problem on the server side.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...