Home » Categories » Products » Nagios XI » Troubleshooting » Common Problems

API changes in Nagios XI 5.7

In Nagios XI versions prior to 5.7, there was an API issue as described below:

The JSON returned from the API returns inconsistent types depending on whether single or multiple results are returned.

As an example, requesting the status of a single host returns an object but requesting the status of multiple hosts returns an array of objects.

Single result (no array) 

{
   "recordcount": "1",
   "hoststatus": {
      "@attributes": {
         "id": "737359"
      },
      "instance_id": "1",
      "host_id": "5154",
      "name": "hosta"
   }
}

Multiple results are within an array

{
  "recordcount": "2",
  "hoststatus": [
    {
      "@attributes": {
        "id": "737359"
      },
      "instance_id": "1",
      "host_id": "5154",
      "name": "hosta"
    },
    {
      "@attributes": {
        "id": "737358"
      },
      "instance_id": "1",
      "host_id": "5153",
      "name": "hostb"
    }
  ]
}

This was due to the fact that the original results were being given in XML and converted to JSON for our API. The decision was made that the output should stay as an array no matter how many of the objects are returned.

The solution in Nagios XI 5.7+

Updated all data to be sent out as JSON and no longer gets turned into XML and then converted to JSON like it had before. This extra step was CPU intensive so this may actually improve the speed of the API on large systems.

When a single object is returned it will now return as an array of objects with just one object in it.

To Consider

Keep in mind that returned single objects will now be in an array. Also, there were some name changes in the API:

Changed the service_id to service_object_id in the API objects/servicestatus and host__id to host_object_id in the objects/hoststatus endpoint.

0 (0)
Article Rating (No Votes)
Rate this article
  • Icon PDFExport to PDF
  • Icon MS-WordExport to MS Word
Attachments Attachments
There are no attachments for this article.
Related Articles RSS Feed
Nagios XI - Configuration Applies, but still get "Configuration File Is Out Of Date" Error
Viewed 2503 times since Tue, Jan 26, 2016
Nagios XI - Empty Screen for Wizard, Component, Dashlet
Viewed 3677 times since Wed, Jan 27, 2016
Nagios XI - Status Information Cut Off At 256 Characters
Viewed 3984 times since Thu, Feb 25, 2016
Nagios XI - Unable to Delete Host
Viewed 9270 times since Tue, Dec 16, 2014
Nagios XI - Defining Global Environment Variables
Viewed 5711 times since Thu, Mar 17, 2016
Nagios XI - Configuration Applies, No Changes Take Place
Viewed 3492 times since Tue, Jan 27, 2015
Nagios XI - Uploaded plugin returns "/bin/bash^M: bad interpreter: No such file or directory"
Viewed 3917 times since Thu, Feb 25, 2016
XI 5.4 monitoring engine not running
Viewed 5850 times since Mon, Feb 6, 2017
Nagios XI - Reset Upgrade Status In Web Interface
Viewed 6259 times since Tue, May 7, 2019
Slack Notifications Stopped Working
Viewed 2097 times since Wed, Mar 18, 2020