Public API documentation
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- POST /api/v1/config/import_tool/by_ip/{it_address}/hosts/create/
Creates a host in the given import tool ip.
Creates a host in the given import tool ip.
- Parameters
it_address (string) –
- Request JSON Object
address (string) – (required)
business_impact (integer) –
check_interval (integer) –
contact_groups (string) –
contacts (string) –
host_name (string) – (required)
hostgroups[] (string) –
latitude (number) –
longitude (number) –
max_check_attempts (integer) –
notifications_enabled (boolean) –
parents (string) –
poller_tag (string) –
retry_interval (integer) –
service_excludes[] (string) –
service_overrides (string) –
use_templates[] (string) –
- Status Codes
- DELETE /api/v1/config/import_tool/by_ip/{it_address}/hosts/delete/{host_name}/
Deletes a host from the given import tool ip by host id.
Deletes a host from the given import tool ip by host id.
- Parameters
it_address (string) –
host_name (string) –
- Status Codes
- POST /api/v1/config/realm/create-realm/
- Request JSON Object
activated (boolean) –
backend_technology (string) – Select backend backend technologies
collectd (string) –
created_at (string) –
display_name (string) – (required)
elasticsearch_backend (integer) – Unified Elasticsearch backend for ALL systems (metrics, monitoring events, logs, collectd)
elasticsearch_logger_resources[] (string) –
header_image (integer) –
host_groups (string) – Filter realm information by specified hostgroup(s)
host_name (string) –
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) –
metrics_index (string) – Elasticsearch index/pattern for metrics data (without index metrics-wocu-* prefix)
monitoring_events_index (string) – Elasticsearch index/pattern for monitoring events (without index monitoring-events-* prefix)
monitoring_ip (string) –
monitoring_port (integer) –
monitoring_socket (string) – Livestatus socket file, for example: /var/opt/wocu/run/shinken/livestatus.sock
observability (boolean) – Enable Observability for this realm.
origin[] (string) –
section (string) – (required)
- Status Codes
- GET /api/v1/config/realm/{realm_name}/active-host-group/{hostgroup_name}/members/
- Parameters
realm_name (string) –
hostgroup_name (string) –
- Status Codes
200 OK –
- GET /api/v1/config/realm/{realm_name}/active-host-groups-only-names/
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- POST /api/v1/config/realm/{realm_name}/hosts/create/
Creates a host in the given realm by realm name.
Creates a host in the given realm by realm name.
- Parameters
realm_name (string) –
- Request JSON Object
address (string) – (required)
business_impact (integer) –
check_interval (integer) –
contact_groups (string) –
contacts (string) –
host_name (string) – (required)
hostgroups[] (string) –
latitude (number) –
longitude (number) –
max_check_attempts (integer) –
notifications_enabled (boolean) –
parents (string) –
poller_tag (string) –
retry_interval (integer) –
service_excludes[] (string) –
service_overrides (string) –
use_templates[] (string) –
- Status Codes
- DELETE /api/v1/config/realm/{realm_name}/hosts/delete/{host_name}/
Deletes a host from the given realm name by id.
Deletes a host from the given realm name by id.
- Parameters
realm_name (string) –
host_name (string) –
- Status Codes
- GET /api/v1/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
200 OK –
- GET /api/v1/config/realm/{realm_name}/hosts/{host_name}/
- Parameters
realm_name (string) –
host_name (string) –
- Status Codes
200 OK –
- GET /api/v1/device-inventory/realm/{realm_name}/host/{host}/inventory/
- Parameters
realm_name (string) –
host (string) –
- Status Codes
200 OK –
- GET /api/v1/events/monitoring/kpi/{kpi_id}/download/
- Parameters
kpi_id (string) –
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/events/realms/{realm_name}/
Public API endpoint that queries monitoring events from the realm’s
Public API endpoint that queries monitoring events from the realm’s dedicated Elasticsearch index.
Both Elasticsearch 7 and Elasticsearch 9 backends are supported.
Note - To apply filtering by date range (time-from/time-to) then is required to send the value for
host_nameordisplay_namefield.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Filter by host name. Mutually exclusive with display_name.Required if wanted to filter by date range
display_name (string) – Filter by host display name. Mutually exclusive with host_name.Required if wanted to filter by date range
service (string) – Filter by service description
contact_name (string) – Filter by contact name
host_check_command (string) – Filter by host check command
message (string) – Filter by message (case-insensitive substring)
state_type (string) – Filter by state type (e.g. HARD, SOFT)
state (integer) – Filter by state (integer)
type (string) – Filter by event type (e.g. HOST ALERT)
service_display_name (string) – Filter by service display name
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when host_name or display_name is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when host_name or display_name is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
size (integer) – Maximum events to return (default: 10, max: 10000)
sort (string) – Sort field (default: “-time”)
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp returns an OpenTelemetry OTLP JSON LogsData document, with the total count in the X-Total-Count header; otlp-ndjson returns the same data as one LogsData document with a single log record per line
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/events/realms/{realm_name}/syslogs/
Public API endpoint that queries syslog events belonging to the realm
Public API endpoint that queries syslog events belonging to the realm
Note - To apply filtering by date range (time-from/time-to) then is required to send the value for
host_namefield.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Filter by host name. Required if wanted to filter by date range
severity (string) – Filter by syslog severity
message (string) – Filter by message text (substring/full-text)
event (string) – Filter by syslog event
ident (string) – Filter by syslog identifier
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when host_name is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when host_name is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
size (integer) – Maximum events to return (default: 10, max: 10000)
sort (string) – Sort field (default: “-@timestamp”)
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp returns an OpenTelemetry OTLP JSON LogsData document, with the total count in the X-Total-Count header; otlp-ndjson returns the same data as one LogsData document with a single log record per line
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/metrics/realm/{realm_name}/
Public API endpoint that retrieves the metric evolution (time series)
Public API endpoint that retrieves the metric evolution (time series) of a realm.
host_name/display_nameare optional and mutually exclusive, each accepting a comma-separated list; give neither to query every host in the realm.Results are paginated by hosts: each response is
{"data": [...], "offset": N, "next_offset": M}with up tosizehosts that have data in the time range (hosts without data are skipped).offsetechoes where the page started, so clients can keep a history to go back. To get the next page, send the returnednext_offsetvalue asoffset;nullmeans there are no more results.With
format=otlporformat=otlp-ndjsonthe offsets travel in theX-OffsetandX-Next-Offsetheaders, andX-Interval-Secondsholds the largest bucket used in the page: long ranges are sampled at a coarser interval, and a page stops early once it holds aboutOTLP_METRICS_MAX_POINTS_PER_PAGEpoints (continue withnext_offset). A host that does not fit even at the largest interval answers 400; narrow the time range or pass fewermeasurements. If Elasticsearch fails (502) or times out (504) on any host, the whole request fails with a{"detail": ...}body naming the host(s), instead of an empty document that looks like “no data”. The JSON output keeps answering 200 with the data it could get.Ranges that include the present change between requests as new data arrives; for repeatable results, pass
measurementswith a fixed pasttime_from/time_to.Note - To apply filtering by date range (time-from/time-to) then is required to send the value for
measurementsfield.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Comma-separated list of exact, case-sensitive host names to query, returned in the order they are sent. If no value is sent, the realm’s hosts with data in the time range are returned, in alphabetical order. Mutually exclusive with display_name.
display_name (string) – Comma-separated list of exact, case-sensitive host display names to query. All hosts in the realm will be queried if no value is sent. Mutually exclusive with host_name.
service (string) – Service description (optional)
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when measurements is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00, time_to to 23:59:00). Maximum range: 7 days. Only applied when measurements is provided and both time_from and time_to are sent (non-empty); otherwise the range is forced to the last hour and time_from/time_to are ignored
measurements (string) – Comma-separated list of measurement names, all returned for each host. If omitted, up to 10 measurements per host are auto-discovered (alphabetical order) and the range is forced to the last hour
size (integer) – Maximum hosts with data in the time range per response (default: 10, max: 10000). Hosts without data are skipped and not counted. Each host may return several entries in data, one per measurement
offset (integer) – Where the page starts. Leave it empty for the first page; to get the next one, send in this parameter the next_offset value of the previous response, exactly as received (default: 0). If next_offset is null, there are no more results to show
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp and otlp-ndjson require an Elasticsearch 9 realm; InfluxDB realms return 400. otlp returns an OpenTelemetry OTLP JSON MetricsData document. Each data point carries its service. otlp-ndjson returns the same data as one MetricsData document per host and metric, one per line
- Status Codes
200 OK –
- GET /api/v1/metrics/realm/{realm_name}/measurements/
Public API endpoint that lists measurements available for a realm.
Public API endpoint that lists measurements available for a realm.
- Parameters
realm_name (string) –
- Query Parameters
host (string) – Host asset name
service (string) – Service description
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/evolution/
Public API endpoint with the hosts with anomalies per UTC day of a
Public API endpoint with the hosts with anomalies per UTC day of a range, by severity. A host counts once a day, in the band of its maximum score of that day, and may count in several days; the days do not add up to the unique hosts of the range. Days without anomalies are not listed.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to 30 days before the end
to (string) – End of the range (exclusive), in the same formats. Defaults to now
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/hosts/
Public API endpoint with the hosts with anomalies in a range, one row
Public API endpoint with the hosts with anomalies in a range, one row per host with its latest valid event, optionally only those of one severity. The severity is the one of the maximum score of the host in the whole range, so the event shown may have a lower score. Hosts are sorted by name and paginated with a cursor.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to 30 days before the end
to (string) – End of the range (exclusive), in the same formats. Defaults to now
severity (string) – Only hosts of this severity: moderate, high or very_high
limit (string) – Hosts per page, 1 to the maximum the deployment allows (100 by default)
cursor (string) – The next_cursor of the previous page
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/resource-distribution/
Public API endpoint splitting the hosts with anomalies in a range into
Public API endpoint splitting the hosts with anomalies in a range into CPU only, memory only and both. A host is CPU if it had any CPU anomaly in the range and memory if it had any memory one, possibly on other days.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to 30 days before the end
to (string) – End of the range (exclusive), in the same formats. Defaults to now
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/severity/
Public API endpoint with the hosts with anomalies in a range by
Public API endpoint with the hosts with anomalies in a range by severity. A host is in the band of its maximum score of the range.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to 30 days before the end
to (string) – End of the range (exclusive), in the same formats. Defaults to now
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/summary/
Public API endpoint with the hosts of a realm that had at least one
Public API endpoint with the hosts of a realm that had at least one anomaly in the last 30 days.
- Parameters
realm_name (string) –
- Query Parameters
as_of (string) – Instant the fixed window ends at, ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to now
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/anomalies/weekly-trend/
Public API endpoint comparing the hosts with anomalies of the last
Public API endpoint comparing the hosts with anomalies of the last seven days with those of the seven days before.
- Parameters
realm_name (string) –
- Query Parameters
as_of (string) – Instant the fixed window ends at, ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to now
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/events/
Public API endpoint with the monitoring events of a realm, reduced to the
Public API endpoint with the monitoring events of a realm, reduced to the fields of
EVENT_FIELDSplus a normalisedseveritytext (the one of the OTLP mapping). Syslog is not served.The events come from the same source as the public monitoring events endpoint and the envelope is the same:
{"data": [...], "total_count": N}. The time range is always applied. Only the host, service, state, state type and event type filters are accepted.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Filter by host name. Mutually exclusive with display_name.
display_name (string) – Filter by host display name. Mutually exclusive with host_name.
service (string) – Filter by service description
state (integer) – Filter by state (integer)
state_type (string) – Filter by state type (e.g. HARD, SOFT)
type (string) – Filter by event type (e.g. HOST ALERT)
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00). Always applied. If only one of time_from and time_to is sent, the other one completes the default range (one hour unless the deployment says otherwise, ending now). Maximum range: 31 days
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_to defaults to 23:59:00). Always applied. Maximum range: 31 days
size (integer) – Maximum events to return (default: 10, max: 10000)
sort (string) – Sort order: one of time, -time, state, -state, where a leading - is the descending order (default: “-time”). Any other value answers 400
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp returns an OpenTelemetry OTLP JSON LogsData document, with the total count in the X-Total-Count header; otlp-ndjson returns the same data as one LogsData document with a single log record per line
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/forecasting/metrics/
Public API endpoint with the catalogue of metrics the Forecasting panel
Public API endpoint with the catalogue of metrics the Forecasting panel
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/forecasting/overview/
Public API endpoint with the forecast risk of a realm over the next 24
Public API endpoint with the forecast risk of a realm over the next 24
- Parameters
realm_name (string) –
- Query Parameters
as_of (string) – Instant the forecast is evaluated at, ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to now
forecast_id (string) – A run of the realm; the one the panel evaluates at as_of by default
metric (string) – Only this metric of the catalogue, all of them by default
limit (string) – Rows per top, 1 to 100 (10 by default)
rows_limit (string) – Rows of the lists of series that never cross and that cannot be evaluated, 1 to 1000 (100 by default)
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/forecasting/runs/
Public API endpoint listing the forecast runs of a realm, newest first,
Public API endpoint listing the forecast runs of a realm, newest first, with their state, creation, end and the messages of the process, and which of them the panel evaluates at
as_of. Paginated with a cursor.- Parameters
realm_name (string) –
- Query Parameters
as_of (string) – Instant the forecast is evaluated at, ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to now
limit (string) – Runs per page, 1 to the maximum the deployment allows (100 by default)
cursor (string) – The next_cursor of the previous page
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/forecasting/series/
Public API endpoint with the detail of one series (an entity and a
Public API endpoint with the detail of one series (an entity and a metric): its history in 15 minute buckets over
from/to, its forecast for the next 24 hours from one run, the thresholds of its latest sample, its own evaluation and the coverage of the forecast. A series outside the top of the overview is accepted. The thresholds are one snapshot that applies to the whole series.- Parameters
realm_name (string) –
- Query Parameters
as_of (string) – Instant the forecast is evaluated at, ISO 8601 (UTC when it has no offset) or epoch milliseconds. Defaults to now
from (string) – Start of the history (inclusive), ISO 8601 or epoch milliseconds. Defaults to 24 hours before the end
to (string) – End of the history (exclusive), in the same formats. Defaults to as_of
forecast_id (string) – A run of the realm; the one the panel evaluates at as_of by default
entity_id (string) – The entity (host,service) exactly as the overview names it
metric (string) – A metric of the catalogue
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/hardware-health/summary/
Public API endpoint with the hosts of a realm by hardware health
Public API endpoint with the hosts of a realm by hardware health category, from the latest sample of the critical, warning and unknown component counters of the Hardware Health service.
- Parameters
realm_name (string) –
- Query Parameters
monitoring_gap_minutes (integer) – Minutes after which a host whose latest critical, warning or unknown counter is older counts as interrupted: 0 (off), 15 (default), 30, 60 or 120. It never changes the category of the host
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/inventory/
Public API endpoint with the device inventory of a realm: type, vendor,
Public API endpoint with the device inventory of a realm: type, vendor, model, version, location, hostgroups and interfaces of each host, sorted by host name and paginated with
sizeandoffset.version_availabletells whether the version lookup worked; when it did not, every version is null and the rest of the response is unaffected.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Comma-separated list of exact, case-sensitive host names, 200 at most: a longer list is answered with 400, so split it into several requests. If no value is sent, every host of the realm is returned.
hostgroup (string) – Name of a hostgroup: only its hosts are returned.
size (integer) – Maximum devices per response (default and maximum depend on the deployment and on the limits of the client)
offset (integer) – Where the page starts (default: 0). To get the next page, send the next_offset value of the previous response. If next_offset is null, there are no more results.
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/metrics/
Public API endpoint with the time series of the observability metrics of a
Public API endpoint with the time series of the observability metrics of a
- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Comma-separated list of exact, case-sensitive host names to query, returned in the order they are sent. If no value is sent, the realm’s hosts with data in the time range are returned, in alphabetical order. Mutually exclusive with display_name.
display_name (string) – Comma-separated list of exact, case-sensitive host display names to query. Mutually exclusive with host_name.
service (string) – Service description (optional)
measurements (string) – Comma-separated list of metrics. Each one is an entry of the list this endpoint serves (patterns such as *_traffic_in included) or a metric name that one of its patterns matches; anything else answers 400 naming it. If omitted, the whole list is served
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00). Always applied. If only one of time_from and time_to is sent, the other one completes the default range (one hour unless the deployment says otherwise, ending now). Maximum range: 31 days
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_to defaults to 23:59:00). Always applied. Maximum range: 31 days
interval (integer) – Width of the time buckets in seconds, 60 at least. It is derived from the time range when omitted. It is rounded up to whole minutes and a long range may get a coarser one: the response gives the interval used in interval_seconds and in the X-Interval-Seconds header. More than 5000 buckets per series answers 400
function (string) – How the values of a bucket are combined: avg (default), min, max, sum or count
size (integer) – Maximum hosts with data in the time range per response (default: 10, max: 10000). A response also stops before the host that would take it over the maximum of metric points (100000 unless the client has a lower limit); continue with next_offset. If the first host alone does not fit, the answer is 400: ask for a larger interval, a shorter time range or fewer measurements
offset (integer) – Where the page starts. Leave it empty for the first page; to get the next one, send in this parameter the next_offset value of the previous response, exactly as received (default: 0). If next_offset is null, there are no more results to show
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp returns an OpenTelemetry OTLP JSON MetricsData document and otlp-ndjson the same data as one MetricsData document per host and metric, one per line. The offsets and the interval travel in the X-Offset, X-Next-Offset and X-Interval-Seconds headers in every format
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/data-quality/
Public API endpoint with the documents behind the numbers: how many are
Public API endpoint with the documents behind the numbers: how many are eligible, how many carry a sampling interval above 1, none or at most 1, and the first and last observation.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/destinations/top/
Public API endpoint with the top destinations: a destination IP, a
Public API endpoint with the top destinations: a destination IP, a transport and a service port by bytes. The share is against the whole filtered total, taken before the documents without a destination are left out, and
unclassified_destination_bytesexplains what was left out. The ranking says whether it is exact.destination.iphas not been validated against a real index.- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
limit (string) – Rows, 1 to 100 (10 by default)
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/protocols/
Public API endpoint with the bytes and the share of TCP and UDP and the
Public API endpoint with the bytes and the share of TCP and UDP and the total of the centre of the donut.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/service-ports/changes/
Public API endpoint with the table that compares the range with the
Public API endpoint with the table that compares the range with the previous period: the services of either period, none dropped and none truncated, with their volumes, variation, share and a status code.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
sort_by (string) – delta (absolute change, the default), current_bytes, previous_bytes, variation_pct or share_pct; nulls go last
sort_direction (string) – desc (the default) or asc
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/service-ports/evolution/
Public API endpoint with the bytes over time of the top services. The
Public API endpoint with the bytes over time of the top services. The services are the top of the whole period, not of each bucket; the buckets are
ceil((to - from) / max_points)milliseconds wide, aligned to the epoch, and a bucket without documents isnull, not zero.- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
top_n (string) – Services to draw, 1 to 10 (5 by default)
max_points (string) – Points the range is divided into, 1 to 500 (150 by default)
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/service-ports/top/
Public API endpoint with the top service ports by bytes, a (transport,
Public API endpoint with the top service ports by bytes, a (transport, port) pair each, with the share of the whole filtered total.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
limit (string) – Rows, 1 to 100 (10 by default)
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/network-traffic/summary/
Public API endpoint with the traffic of the realm in the range: the
Public API endpoint with the traffic of the realm in the range: the observed bytes, the exact count of active service ports and the eligible documents, compared with the previous period.
- Parameters
realm_name (string) –
- Query Parameters
from (string) – Start of the range (inclusive), ISO 8601 or epoch milliseconds. Defaults to 30 days before the end. The range is at most 31 days; the comparison with the previous period reads [from - duration, from), so a query spans up to twice the range
to (string) – End of the range (exclusive), in the same formats. Defaults to now
transport (string) – tcp or udp; both when omitted
service_port (string) – Service port, 0 to 65535
exporter_address (string) – Exact exporter IP addresses, comma separated and bounded
- Status Codes
200 OK –
- GET /api/v1/observability/realm/{realm_name}/syslog/
Public API endpoint with the syslog of the devices of a realm.
Public API endpoint with the syslog of the devices of a realm.
It reads the same source as the public syslog endpoint, but each event carries only
@timestamp,host,identandmessage, the fields the syslog stores. The envelope is{"data": [...], "total_count": N}. The OTLP formats are the ones of the public syslog endpoint.- Parameters
realm_name (string) –
- Query Parameters
host_name (string) – Host whose syslog is asked. Without it the time range cannot exceed 1 hour
ident (string) – Filter by syslog identifier (program), exact match
message (string) – Filter by message text (substring/full-text)
sort (string) – Sort field, with an optional leading - for descending order. One of: @timestamp, host, ident, message. Default: -@timestamp. The stored syslog has no severity or event, so those are not accepted
size (integer) – Maximum events to return (default: 10, max: 10000, and never more than the limit of the API client). There is no offset: to read further, narrow the time range
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00). The range is always applied. If neither time_from nor time_to is sent, the range is the last hour. If only time_from is sent, the range ends now. If only time_to is sent, the range starts one hour before it. Maximum range: 7 days, and 1 hour when host_name is not sent; a longer range is answered with 400
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_to defaults to 23:59:00). Must be greater than time_from. If it is not sent, the range ends now
format (string) – Response format: json (default), otlp or otlp-ndjson. otlp returns an OpenTelemetry OTLP JSON LogsData document, with the total count in the X-Total-Count header; otlp-ndjson returns the same data as one LogsData document with a single log record per line
- Status Codes
200 OK –
- POST /api/v1/passive-checks/parser/
- Request JSON Object
event (object) – (required)
- Status Codes
- GET /api/v1/reports/info/{realm_type}/{realm_name}/
Lists the reports of a realm or multirealm visible to the user.
Lists the reports of a realm or multirealm visible to the user.
- Parameters
realm_type (string) –
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/stats/api-consumption/
Public API endpoint with the aggregated consumption of the public API per
Public API endpoint with the aggregated consumption of the public API per client and period, for superusers.
It gives the requests, status codes, duration and response size of the whole API, of the requests without a client and of each client with its endpoints.
partialis true when the figures are known to be incomplete.Only the requests recorded with their trace are counted, so a period before the tracing was deployed gives zeros.
- Query Parameters
time_from (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_from defaults to 00:00:00). The period includes time_from. If neither time_from nor time_to is sent, the range is the last 24 hours. If only time_from is sent, the range ends now. If only time_to is sent, the range starts 24 hours before it. Maximum range: 31 days; a longer range is answered with 400
time_to (string) – Datetime in DD/MM/YY, DD/MM/YYYY, DD-MM-YYYY or DD-MM-YY HH:MM:SS format (project timezone); date-only values are also accepted (time_to defaults to 23:59:00). Must be greater than time_from. The period does not include time_to, so consecutive periods never count a request twice. If it is not sent, the range ends now
- Status Codes
200 OK –
- GET /api/v1/stats/get-all-users/
Web service that returns all users.
Web service that returns all users.
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/stats/origins/realms/{realm_name}/
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/stats/realms/
Web service that returns the config of every single realm.
Web service that returns the config of every single realm.
- Status Codes
200 OK –
- GET /api/v1/stats/realms/collectors/{realm_name}/
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- DELETE /api/v1/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/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/status/realms/service-status/
Returns a list of hosts and services with their state, active check and perf data
Returns a list of hosts and services with their state, active check and perf data status of all standard realms.
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/status/realms/{realm_name}/all-service-status/
Retrieves a list of hosts and services, including their state, active check status and perf data, limited to standard realms.
Retrieves a list of hosts and services, including their state, active check status and perf data, limited to standard realms.
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/summary/assets-state/hosts-by-state/
Hosts grouped by state
Hosts grouped by state
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/summary/realms/connected/
Realms and multirealms by connectivity
Realms and multirealms by connectivity
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/summary/realms/hostgroups/
Hostgroups and standard realms
Hostgroups and standard realms
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/summary/realms/realms/
Realms and multirealms
Realms and multirealms
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/summary/services/services-by-state/
Services by state
Services by state
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/summary/services/with-checks-disabled/
Services with checks disabled
Services with checks disabled
- Query Parameters
category (string) – Filter by realm category
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- GET /api/v1/summary/services/{realm_name}/services-by-state/
Services by state, per realm
Services by state, per realm
- Parameters
realm_name (string) –
- Status Codes
200 OK –
- GET /api/v1/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
200 OK –
- POST /api/v1/token/refresh/
Refresh access token for public api using a valid refresh token.
Refresh access token for public api using a valid refresh token. No authentication required — the refresh token itself is the credential.
- Status Codes