{ "opencollection": "1.0.0", "info": { "name": "Nagios XI REST Config Objects API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "items": [ { "info": { "name": "Objects", "type": "folder" }, "items": [ { "info": { "name": "List Host Objects", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/host", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." }, { "name": "host_name", "value": "", "type": "query", "description": "Filter by host name (supports `name-lk=` modifier for substring match)." }, { "name": "records", "value": "", "type": "query", "description": "Pagination, format `count` or `count:startingAt`." }, { "name": "orderby", "value": "", "type": "query", "description": "Order by column, `:a` ascending or `:d` descending." } ] }, "docs": "List Host Objects" }, { "info": { "name": "List Host Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/hoststatus", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." }, { "name": "host_name", "value": "", "type": "query" } ] }, "docs": "List Host Statuses" }, { "info": { "name": "List Service Objects", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/service", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." }, { "name": "host_name", "value": "", "type": "query" }, { "name": "service_description", "value": "", "type": "query" } ] }, "docs": "List Service Objects" }, { "info": { "name": "List Service Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/servicestatus", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." }, { "name": "host_name", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query", "description": "Service description (with optional `-lk` modifier)." } ] }, "docs": "List Service Statuses" }, { "info": { "name": "List Host Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/hostgroup", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Host Groups" }, { "info": { "name": "List Service Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/servicegroup", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Service Groups" }, { "info": { "name": "List Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/contact", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Contacts" }, { "info": { "name": "List Contact Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/contactgroup", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Contact Groups" }, { "info": { "name": "List Time Periods", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/timeperiod", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Time Periods" }, { "info": { "name": "List Commands", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/command", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Commands" }, { "info": { "name": "List Scheduled Downtime", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/downtime", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." } ] }, "docs": "List Scheduled Downtime" }, { "info": { "name": "List State History", "type": "http" }, "http": { "method": "GET", "url": "https://{nagiosXiHost}/nagiosxi/api/v1/objects/statehistory", "params": [ { "name": "pretty", "value": "", "type": "query", "description": "Set to 1 to return human-readable formatted JSON." }, { "name": "starttime", "value": "", "type": "query", "description": "Unix timestamp (default 24 hours ago)." }, { "name": "endtime", "value": "", "type": "query", "description": "Unix timestamp (default now)." } ] }, "docs": "List State History" } ] } ], "bundled": true }