Endpoint for summary of Hashtags information
Access required: VIEWPORTACCESS, VIEWSOME or VIEWALL
Any public hashtags will be included in object permissions.
Request URL: /rest/status/viewport
- GET - lists summarised information about hashtags
- PUT, POST, DELETE - unimplemented
URL parameters:
- keyword - filter by these hashtags/keywords. Can be repeated.
- single_hashtag - if set, this is effectively the same as
/rest/status/viewport/SINGLE_HASHTAG. - host - filter hosts by this host name. Can be repeated.
- servicecheck - filter services by this service check name. Can be repeated.
- filter - either handled or unhandled. Filters services by this condition.
- host_filter - either handled or unhandled. Filters host by this condition.
- state - filters by services in this state. Expects the numeric id for state. Can be repeated.
- host_state - filters by hosts in this state. Expects the numeric id for state. Can be repeated.
- rows - Use this to restrict the number of hashtags returned in the list. If not specified, will return all results. NOTE: The summary hash in the response will give the information for the entire list of hashtags, not just the ones returned with rows - this is liable to change so do not depend on it
Example response:
{
"summary" : {
"handled" : "15",
"unhandled" : "31",
"service" : {
"handled" : "3",
"unhandled" : "31",
"unknown" : "34",
"total" : "34"
},
"total" : "46",
"host" : {
"handled" : "12",
"unhandled" : "0",
"down" : "1",
"up" : "11",
"total" : "12"
}
},
"list" : [
{
"hosts" : {
"handled" : "1",
"unhandled" : "0",
"down" : {
"handled" : "1"
},
"total" : "1"
},
"services" : {
"handled" : "1",
"computed_state" : "unknown",
"unhandled" : "0",
"unknown" : {
"handled" : "1"
},
"total" : "1"
},
"computed_state" : "critical",
"downtime" : null,
"name" : "allhandled",
"description" : "All services handled"
},
{
...
}
]
}
Note: The computed_state keyword represents the highest state based on host state and service state. Specifically, this will return critical if the host is down or unreachable otherwise the service computed_state.