Nagios Objects API
Read-only backend for hosts, services, host groups, contacts, downtime, history, and other monitored objects.
Nagios Objects API is one of 13 APIs that Nagios publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
This API exposes 12 operations across 12 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.
Requests are made against a single base URL, https://{nagiosXiHost}/nagiosxi/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Nagios Objects API declares
2 security schemes
for authenticating requests.
An API key is passed in the query as apikey (ApiKeyQuery).
An API key is passed in the header as X-API-KEY (ApiKeyHeader).
By default, every request must be authenticated.
Paths & Operations 12
Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.
Read-only backend for hosts, services, host groups, contacts, downtime, history, and other monitored objects.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Host (13 properties), Service (11 properties), HostStatus (11 properties), ServiceStatus (8 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nagios 12
Other APIs Nagios publishes across the network.