Nagios Config API
Admin-only endpoints to add, modify, and delete hosts and services.
Nagios Config 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 Config. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
This API exposes 4 operations across 2 paths, and defines 4 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 Config 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 4
Across 2 paths, the API surfaces 4 operations — 2 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Admin-only endpoints to add, modify, and delete hosts and services.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ServiceInput (14 properties), HostInput (13 properties), MutationError (2 properties), MutationResult (1 property). 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.