This is an attempt to standardize on namespacing API routes, for the consistency sake. The rules set here can be changed if there is a god reason for it, otherwise please follow these rules.
Top level routes
Top level routes limited to following ones, no new routes will be added.
- /_config
- /_objects
- /_status
- /_api
- /_runtime
- /
Implemented
"PUT":
- /_status
- /status/:hostname
- /status/:host_name/services
- /status/:host_name/_services/:servicedescription
- /status/:host_name/services/:service_description/returncode/:return_code/plugin_output/:pluginoutput
Deprecated to be removed:
- /host_status/:hostname
Future additions
Host and service properties (notifications, checks enabled/disabled) are nested under the host and service endpoints correspondingly.
Host
- PUT /status/:host_name/active_checks
- PUT /status/:host_name/passive_checks
- PUT /status/:host_name/notifications
Service
PUT /status/:host_name/_services/:servicedescription/_notifications/
- Params
- notifications_enabled
- notification_options
- Params
PUT /status/:host_name/_services/:servicedescription/_active_checks
PUT /status/:host_name/_services/:servicedescription/passivechecks
PUT /status/:host_name/_services/:servicedescription/_flap_detection