Hey! These docs are for version 6.3, which is no longer officially supported. Click here for the latest version, 6.7!

Endpoint for setting the status of a Servicecheck on a Host

URL: /rest/status

  • POST - submits the new status of services
  • GET, PUT, DELETE - unimplemented

Filter parameters are noted above in Filtering Service Objects.

Other parameters are:

  • state - the state that should be applied to the services listed in service_selection. Expects the numeric ID for state.
  • comment - free text comment that should be given to the state change.

Example input: /rest/status?svc.serviceid=1&svc.serviceid=2

{
   "new_state" : "0",
   "comment" : "This is a known unknown"
}

Example output:

{
   "summary" : {
      "num_services" : "2",
      "num_hosts" : "0"
   },
   "list" : {
      "hosts" : [],
      "services" : [
         {
            "id" : "1",
            "hostname" : "host1",
            "servicename" : "service on host1"
         },
         {
            "id" : "2",
            "hostname" : "host2",
            "servicename" : "service on host2"
         }
      ]
   }
}