Public API documentation

GET /api/config/hosts/address/{address}/
Parameters

  • address (string) –

Query Parameters

  • skip_hostgroup_realms (boolean) – By default, only standard realms are retreived. Setting skip_hostgroup_realms to false will retrieve all the realms, including hostgroup-based realms.

Status Codes
GET /api/config/hosts/host_name/{host_name}/
Parameters

  • host_name (string) –

Query Parameters

  • skip_hostgroup_realms (boolean) – By default, only standard realms are retreived. Setting skip_hostgroup_realms to false will retrieve all the realms, including hostgroup-based realms.

Status Codes
POST /api/config/realm/create-realm/
Request JSON Object

  • activated (boolean) –

  • collectd (string) – (required)

  • display_name (string) – (required)

  • host_groups (string) – Filter realm information by specified hostgroup(s)

  • host_name (string) – (required)

  • import_tool (string) –

  • link (string) – Link to external Wocu apps menu (including NagVis, Panorama, etc.). Leave it blank in case of doubt

  • logger (string) – Logger server for this realm

  • logger_resources[] (string) –

  • metrics (string) – Metrics used by this realm

  • metrics_db (string) – (required)

  • monitoring_ip (string) – (required)

  • monitoring_port (integer) – (required)

  • monitoring_socket (string) – Livestatus socket file, for example: /var/opt/wocu/run/shinken/livestatus.sock

  • origin[] (string) –

  • pnp4nagios_host (string) – IP or host name where PNP4Nagios service is running. If not defined, it will be used Monitoring Host value.

  • pnp4nagios_port (integer) – Port where PNP4Nagios service is running.

  • pnp4nagios_protocol (string) – Protocol used to make requests to PNP4Nagios service.

  • section (string) – (required)

Status Codes
GET /api/config/realm/{realm_name}/active-host-group/{hostgroup_name}/members/
Parameters

  • realm_name (string) –

  • hostgroup_name (string) –

Status Codes
GET /api/config/realm/{realm_name}/active-host-groups-only-names/
Parameters

  • realm_name (string) –

Status Codes
GET /api/config/realm/{realm_name}/hosts/active/

Given an hostname, returns its configuration asking to all realms.

Returns all active hosts in configuration belonging to a given realm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/config/realm/{realm_name}/hosts/pending/

Given an hostname, returns its configuration asking to all realms.

Returns all pending hosts in configuration belonging to a given realm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/config/realm/{realm_name}/hosts/{host_name}/
Parameters

  • realm_name (string) –

  • host_name (string) –

Status Codes
GET /api/config/realms/hosts/
Status Codes
GET /api/device-inventory/realm/{realm_name}/host/{host}/inventory/
Parameters

  • realm_name (string) –

  • host (string) –

Status Codes
GET /api/events/monitoring/kpi/{kpi_id}/
Parameters

  • kpi_id (string) –

Status Codes
GET /api/events/multirealms/{realm_name}/monitoring/

Web service that returns monitoring events from a MultiRealm.

Web service that returns monitoring events from a MultiRealm.

At least one of the filters (parameters named arg_filter, except for hostgroup_filter) must be set to true in order to get any result.

Default time range if no dates are provided is 24 hours from now.

Parameters

  • realm_name (string) –

Query Parameters

  • time_from (string) – More info: https://github.com/sonirico/datetoken#motivation

  • time_to (string) – More info: https://github.com/sonirico/datetoken#motivation

  • hostgroup_filter (string) – Name of hostgroup. To look only for events of hosts and services of a specific hostgroup

  • hosts_filter (string) – Either true or false. Show host related events

  • services_filter (string) – Either true or false. Show service related events

  • notifications_filter (string) – Either true or false. Show notification related events

  • external_commands_filter (string) – Either true or false. Show external command related events

  • flapping_filter (string) – Either true or false. Show host and service flapping related events

  • service_desc (string) – Name of a service. To look only for events of that service

Status Codes
GET /api/events/realms/{realm_name}/hosts/{host}/monitoring/

Web service that returns monitoring events from a host belonging to a Realm

Web service that returns monitoring events from a host belonging to a Realm

At least one of the filters (parameters named arg_filter) must be set to true in order to get any result.

Default time range if no dates are provided is 24 hours from now.

Parameters

  • realm_name (string) –

  • host (string) –

Query Parameters

  • time_from (string) – More info: https://github.com/sonirico/datetoken#motivation

  • time_to (string) – More info: https://github.com/sonirico/datetoken#motivation

  • hostgroup_filter (string) – Name of hostgroup. To look only for events of hosts and services of a specific hostgroup

  • hosts_filter (string) – Either true or false. Show host related events

  • services_filter (string) – Either true or false. Show service related events

  • notifications_filter (string) – Either true or false. Show notification related events

  • external_commands_filter (string) – Either true or false. Show external command related events

  • flapping_filter (string) – Either true or false. Show host and service flapping related events

  • service_desc (string) – Name of a service. To look only for events of that service

Status Codes
GET /api/events/realms/{realm_name}/monitoring/

Web service that returns monitoring events from a Realm.

Web service that returns monitoring events from a Realm.

At least one of the filters (parameters named arg_filter, except for hostgroup_filter) must be set to true in order to get any result.

Default time range if no dates are provided is 24 hours from now.

Parameters

  • realm_name (string) –

Query Parameters

  • time_from (string) – More info: https://github.com/sonirico/datetoken#motivation

  • time_to (string) – More info: https://github.com/sonirico/datetoken#motivation

  • hostgroup_filter (string) – Name of hostgroup. To look only for events of hosts and services of a specific hostgroup

  • hosts_filter (string) – Either true or false. Show host related events

  • services_filter (string) – Either true or false. Show service related events

  • notifications_filter (string) – Either true or false. Show notification related events

  • external_commands_filter (string) – Either true or false. Show external command related events

  • flapping_filter (string) – Either true or false. Show host and service flapping related events

  • service_desc (string) – Name of a service. To look only for events of that service

Status Codes
GET /api/events/{realm_type}/{realm_name}/monitoring/kpi/hosts/
Parameters

  • realm_type (string) –

  • realm_name (string) –

Query Parameters

  • time_from (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • time_to (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • hostgroup_filter (string) – Name of hostgroup. To look only for events of hosts and services of a specific hostgroup

Status Codes
GET /api/events/{realm_type}/{realm_name}/monitoring/kpi/services/
Parameters

  • realm_type (string) –

  • realm_name (string) –

Query Parameters

  • time_from (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • time_to (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • hostgroup_filter (string) – Name of hostgroup. To look only for events of hosts and services of a specific hostgroup

Status Codes
GET /api/health/aggregator/

Web service that returns the global state of a MultiRealm.

Web service that returns the global state of a MultiRealm.

Status Codes
GET /api/health/import-tool/realm/{realm_name}/

Web service that returns the global state of a MultiRealm.

Web service that returns the global state of a MultiRealm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/health/import-tools/

Web service that returns the global state of a MultiRealm.

Web service that returns the global state of a MultiRealm.

Status Codes
GET /api/infrastructure/engine-info/
Status Codes
GET /api/infrastructure/realm/{realm_name}/engine-info/

Endpoint to get the WOCU infrastructure for a specific realm

Endpoint to get the WOCU infrastructure for a specific realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/infrastructure/realm/{realm_name}/engine_ips/

Endpoint to get the WOCU infrastructure with only the information of

Endpoint to get the WOCU infrastructure with only the information of impor-tool and the satellites for a specific realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/reports/info/{realm_type}/{realm_name}/
Parameters

  • realm_type (string) –

  • realm_name (string) –

Status Codes
GET /api/stats/get-all-users/

Web service that returns all users.

Web service that returns all users.

Status Codes
GET /api/stats/get-users-and-sessions/

Web service that returns the number of logged users and the number of

Web service that returns the number of logged users and the number of active sessions.

Status Codes
GET /api/stats/origins/realms/{realm_name}/
Parameters

  • realm_name (string) –

Status Codes
GET /api/stats/realms/

Web service that returns the config of every single realm.

Web service that returns the config of every single realm.

Status Codes
GET /api/stats/realms/{user_name}/

Web service that returns all Realms y MultiRealms associated to an User.

Web service that returns all Realms y MultiRealms associated to an User.

Parameters

  • user_name (string) –

Status Codes
DELETE /api/stats/user/{user_name}/

Web service that operate over a specific user.

Web service that operate over a specific user.

Parameters

  • user_name (string) –

Status Codes
GET /api/stats/{id_origin}/realms/

Web service that returns all Realms associated to an Origin.

Web service that returns all Realms associated to an Origin.

Parameters

  • id_origin (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/

Web service that returns the global state of a MultiRealm.

Web service that returns the global state of a MultiRealm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/business_processes/

Returns the BP assets and info on them, in a MultiRealm.

Returns the BP assets and info on them, in a MultiRealm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/host/{host}/services/

Returns the services and their status, of a host in a Realm.

Returns the services and their status, of a host in a Realm.

Parameters

  • realm_name (string) –

  • host (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/hostgroups/

Returns the status of hosts and services in a hostgroup, in a MultiRealm.

Returns the status of hosts and services in a hostgroup, in a MultiRealm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/hostgroups/{hostgroup_name}/hosts/

Web service that returns all hosts and their status, of a hostgroup in a MultiRealm.

Web service that returns all hosts and their status, of a hostgroup in a MultiRealm.

Parameters

  • realm_name (string) –

  • hostgroup_name (string) –

Status Codes
GET /api/status/multirealms/{realm_name}/hosts/

Web service that returns all the hosts, and their status, of a MultiRealm.

Web service that returns all the hosts, and their status, of a MultiRealm.

Parameters

  • realm_name (string) –

Query Parameters

  • macros (boolean) –

Status Codes
GET /api/status/realms/service-status/

Returns the status of hosts and services in a hostgroup, in a Realm.

Returns the services and their status, of a host in a Realm.

Status Codes
GET /api/status/realms/{realm_name}/

Web service that returns the global state of a Realm.

Web service that returns the global state of a Realm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/realms/{realm_name}/business_processes/

Returns the BP assets and info on them, in a Realm.

Returns the BP assets and info on them, in a Realm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/realms/{realm_name}/host/{host}/services/

Returns the services and their status, of a host in a Realm.

Returns the services and their status, of a host in a Realm.

Parameters

  • realm_name (string) –

  • host (string) –

Status Codes
GET /api/status/realms/{realm_name}/hostgroups/

Returns the status of hosts and services in a hostgroup, in a Realm.

Returns the status of hosts and services in a hostgroup, in a Realm.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/realms/{realm_name}/hostgroups/{hostgroup_name}/hosts/

Web service that returns all hosts and their status, of a hostgroup in a Realm.

Web service that returns all hosts and their status, of a hostgroup in a Realm.

Parameters

  • realm_name (string) –

  • hostgroup_name (string) –

Status Codes
GET /api/status/realms/{realm_name}/hosts-grouped-by-pack/

Web service that returns all host names grouped by assigned pack.

Web service that returns all host names grouped by assigned pack.

Parameters

  • realm_name (string) –

Status Codes
GET /api/status/realms/{realm_name}/hosts/

Web service that returns all the hosts, and their status, of a Realm.

Web service that returns all the hosts, and their status, of a Realm.

Parameters

  • realm_name (string) –

Query Parameters

  • macros (boolean) –

Status Codes
GET /api/status/realms/{realm_name}/hosts/{host}/

Web service that returns the state of a host belonging to a Realm.

Web service that returns the state of a host belonging to a Realm.

Parameters

  • realm_name (string) –

  • host (string) –

Status Codes
GET /api/status/{realm_type}/{realm_name}/host/availability/{host}/

Web service that returns Availability info of unique host.

Web service that returns Availability info of unique host.

Parameters

  • realm_type (string) –

  • realm_name (string) –

  • host (string) –

Query Parameters

  • time_from (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • time_to (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • threshold (integer) – Min: 0 - Max: 100

  • h_unavailable_states (array) – Comma-separated list of states. Available options: - UP - PENDING - UNREACHABLE - DOWN

  • hostgroup (string) – Name of a hostgroup

Status Codes
GET /api/status/{realm_type}/{realm_name}/hosts-grouped-by-pack/

Web service that returns all host names grouped by assigned pack.

Web service that returns all host names grouped by assigned pack.

Parameters

  • realm_type (string) –

  • realm_name (string) –

Status Codes
GET /api/status/{realm_type}/{realm_name}/hosts/availability/

Web service that returns Availability info of hosts of Realm.

Web service that returns Availability info of hosts of Realm.

Parameters

  • realm_type (string) –

  • realm_name (string) –

Query Parameters

  • time_from (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • time_to (string) – Format: YYYY-MM-DDThh:mm:ssTZD. More info: https://www.w3.org/TR/NOTE-datetime

  • threshold (integer) – Min: 0 - Max: 100

  • h_unavailable_states (array) – Comma-separated list of states. Available options: - UP - PENDING - UNREACHABLE - DOWN

  • hostgroup (string) – Name of a hostgroup

Status Codes
GET /api/summary/assets-state/duplicated-by-ip/

Duplicated hosts by IP

Duplicated hosts by IP

This query can only work if the collector is enabled and filled with data.

Example return: {

“0.0.0.0”: 2 “0.0.0.1”: 5

}

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/assets-state/duplicated-by-name/

Duplicated hosts by name

Duplicated hosts by name

This query can only work if the collector is enabled and filled with data.

Example return: {

“testduplicate”: 2

}

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/assets-state/hosts-by-state/

Hosts grouped by state

Hosts grouped by state

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/assets-state/long-time-down/

Get hosts that have been down for more than X days

Get hosts that have been down for more than X days

Query Parameters

  • category (string) – Filter by realm category

  • days (integer) – Number of days to filter from - default 15

Status Codes
GET /api/summary/assets-state/with-checks-disabled/

Hosts with checks disabled

Hosts with checks disabled

Query Parameters

  • category (string) – Filter by realm category

  • days (integer) – Number of days to filter from - default 15

Status Codes
GET /api/summary/assets-state/{realm_name}/hosts-by-state/

Hosts grouped by state per realm

Hosts grouped by state per realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/summary/assets-state/{realm_name}/long-time-down/

Get hosts that have been down for more than X days, per realm

Get hosts that have been down for more than X days, per realm

Parameters

  • realm_name (string) –

Query Parameters

  • days (integer) – Number of days to filter from - default 15

Status Codes
GET /api/summary/assets-state/{realm_name}/with-checks-disabled/

Hosts with checks disabled, per realm

Hosts with checks disabled, per realm

Parameters

  • realm_name (string) –

Query Parameters

  • days (integer) – Number of days to filter from - default 15

Status Codes
GET /api/summary/hosts-by-pack-state/with-packs-configured/

Hosts with and without *any* packs configured

Hosts with and without any packs configured

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/hosts-by-pack-state/with-specific-pack/

Hosts with and without a specific pack configured

Hosts with and without a specific pack configured

Query Parameters

  • category (string) – Filter by realm category

  • pack_name (string) – Filter by pack name - default ‘networkdevice-traffic’

Status Codes
GET /api/summary/hosts-by-pack-state/{realm_name}/with-packs-configured/

Hosts with and without *any* packs configured, per realm

Hosts with and without any packs configured, per realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/summary/hosts-by-pack-state/{realm_name}/with-specific-pack/

Hosts with and without a specific pack configured, per realm

Hosts with and without a specific pack configured, per realm

Parameters

  • realm_name (string) –

Query Parameters

  • pack_name (string) – Filter by pack name - default ‘networkdevice-traffic’

Status Codes
GET /api/summary/realms/connected/

Realms and multirealms by connectivity

Realms and multirealms by connectivity

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/realms/hostgroups/

Hostgroups and standard realms

Hostgroups and standard realms

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/realms/realms/

Realms and multirealms

Realms and multirealms

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/services/long-time-down/

Services that have been down for more than X days

Services that have been down for more than X days

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/services/services-by-state/

Services by state

Services by state

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/services/with-checks-disabled/

Services with checks disabled

Services with checks disabled

Query Parameters

  • category (string) – Filter by realm category

Status Codes
GET /api/summary/services/{realm_name}/long-time-down/

Services that have been down for more than X days, per realm

Services that have been down for more than X days, per realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/summary/services/{realm_name}/services-by-state/

Services by state, per realm

Services by state, per realm

Parameters

  • realm_name (string) –

Status Codes
GET /api/summary/services/{realm_name}/with-checks-disabled/

Services with checks disabled, per realm

Services with checks disabled, per realm

Parameters

  • realm_name (string) –

Status Codes