Contrail HealthBot RCA API

Copyright 2017-2019, Juniper Networks, Inc. All Rights reserved.
RCA API interface for HealthBot application
More information: Contrail HealthBot
Contact Info: healthbot-hackers@juniper.net
Version: 2.0.1
BasePath:/api/v1

Access

Methods

[ Jump to Models ]

Table of Contents

Configuration

DataSource

DataStore

Default

Documentation

Facts

Services

Configuration

Up
post /configuration/check/device-group/{device_group_name}/
Check if the un-committed configuration of the given device group is correct (checkDeviceGroupUnsavedConfiguration)
Checks if the un-committed configuration of a device-group is correct. The un-committed changes are merged with the committed configuration and the complete configuration required for the supplied device-group is validated.

Path parameters

device_group_name (required)
Path Parameter — Name of device group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

unexpected error Error

Up
post /configuration/check/network-group/{network_group_name}/
Check if the unsaved configuration of the given network group is correct. (checkNetworkGroupUnsavedConfiguration)
Checks if the un-committed configuration of a network-group is correct. The un-committed changes are merged with the committed configuration and the complete configuration required for the supplied network-group is validated.

Path parameters

network_group_name (required)
Path Parameter — Name of network group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

unexpected error Error

Up
post /configuration/
Commit unsaved configuration. (commitUnsavedConfiguration)
Commit the configuration in configuration database. Services of all the affected groups are started or restarted. If there is an error in the configuration, changes would not be saved into the database. If there is some system error, changes would be saved into the database.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

sync (optional)
Query Parameter — Boolean variable is set to false allow the commit to go asynchronously, default value is true which means commit will go synchronously default: true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

202

Job Created

default

unexpected error Error

Up
post /device/{device_id}/
Update or create a device. (createIcebergDeviceDeviceById)
Create/Update a device by device-id. The device-id specified in URL and the request body must match. If the device already exists then, old content will be updated with the new content.

Path parameters

device_id (required)
Path Parameter — ID of device-id

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device device_schema (required)
Body Parameter — devicebody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /device-group/{device_group_name}/
Update or create a device-group. (createIcebergDeviceGroupDeviceGroupById)
Create/Update a device-group by device-group-name. The device-group-name specified in URL and the request body must match. If the device-group already exists then, old content will be updated with the new content

Path parameters

device_group_name (required)
Path Parameter — ID of device-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device_group device-group_schema (required)
Body Parameter — device_groupbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /device-groups/
Update or create multiple device-groups. (createIcebergDeviceGroupsDeviceGroupsById)
Create/Update multiple device-groups. The new content for the existing device-groups updates the existing content and new device-groups are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device_groups device-groups_schema (required)
Body Parameter — device-groupsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /devices/
Update or create multiple devices. (createIcebergDevicesDevicesById)
Create/Update multiple devices. The new content for the existing devices updates the existing content and the new devices are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

devices devices_schema (required)
Body Parameter — devicesbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /network-group/{network_group_name}/
Update or create a network-group. (createIcebergNetworkGroupNetworkGroupById)
Create/Update a network-group by network-group-name. The network-group-name parameter specified in URL and the request body must match. If the network-group already exists then, the existing network-group's configuration will be updated with the new content.

Path parameters

network_group_name (required)
Path Parameter — ID of network-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

network_group network-group_schema (required)
Body Parameter — network_groupbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /network-groups/
Update or create multiple network-groups. (createIcebergNetworkGroupsNetworkGroupsById)
Create/Update multiple network-groups. The new content for the existing network-groups updates the existing content and the new network-groups are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

network_groups network-groups_schema (required)
Body Parameter — network-groupsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /notification/{notification_name}/
Update or create a notification (createIcebergNotificationNotificationById)
Create/Update a notification by notification-name. The notification-name specified in URL and the request body must match. If the notification already exists then, the existing notification's configuration will be updated with the new content.

Path parameters

notification_name (required)
Path Parameter — ID of notification-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

notification notification_schema (required)
Body Parameter — notificationbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /notifications/
Update or create multiple notifications. (createIcebergNotificationsNotificationsById)
Create/Update multiple notifications. The new content for the existing notifications updates the existing content and the new notifications are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

notifications notifications_schema (required)
Body Parameter — notificationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /playbook/{playbook_name}/
Update or create a playbook. (createIcebergPlaybookPlaybookById)
Create/Update a playbook by playbook-name. The playbook-name specified in URL and the request body must match. If the playbook already exists then, the existing playbook's configuration will be updated with the new content.

Path parameters

playbook_name (required)
Path Parameter — ID of playbook-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

playbook playbook_schema (required)
Body Parameter — playbookbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /playbooks/
Update or create multiple playbooks. (createIcebergPlaybooksPlaybooksById)
Create/Update multiple playbooks. The new content for the existing playbooks updates the existing content and the new playbooks are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

playbooks playbooks_schema (required)
Body Parameter — playbooksbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /retention-policies/
Update or create multiple retention-policies. (createIcebergRetentionPoliciesRetentionPoliciesById)
Create/Update multiple retention-policies. The new content for the existing retention-policies update the existing content and the new retention-policies are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

retention_policies retention-policies_schema (required)
Body Parameter — retention-policiesbody object object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /retention-policy/{retention_policy_name}/
Update or create a retention-policy. (createIcebergRetentionPolicyRetentionPolicyById)
Create/Update a retention-policy by retention-policy-name. The retention-policy-name specified in URL and the request body must match. If the retention-policy exists then, the existing retention-policy's configuration will be updated by the new content.

Path parameters

retention_policy_name (required)
Path Parameter — ID of retention-policy-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

retention_policy retention-policy_schema (required)
Body Parameter — retention_policybody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/report-generation/destination/{name}/
Create destination by name (createIcebergSystemSettingsDestinationById)
Create/Update a destination by name. The name specified in URL and the request body must match. If the destination exists then, the existing destination's configuration will be updated by the new content.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

destination destination_schema (required)
Body Parameter — destinationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/report-generation/destinations/
Create destinations by name (createIcebergSystemSettingsDestinations)
Create/Update multiple destinations. The new content for the existing destinations updates the existing content and the new destinations are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

destinations destinations_schema (required)
Body Parameter — destinationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/report-generation/report/{name}/
Create report by name (createIcebergSystemSettingsReportById)
Create/Update a report by name. The name specified in URL and the request body must match. If the report exists then, the existing report's configuration will be updated by the new content.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

report report_schema (required)
Body Parameter — reportsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/report-generation/reports/
Create reports by name (createIcebergSystemSettingsReports)
Create/Update multiple reports. The new content for the existing reports updates the existing content and the new reports are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

reports reports_schema (required)
Body Parameter — reportsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/scheduler/{name}/
Create scheduler by name (createIcebergSystemSettingsSchedulerById)
Create/Update a scheduler by name. The name specified in URL and the request body must match. If the scheduler exists then, the existing scheduler's configuration will be updated by the new content.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

scheduler scheduler_schema (required)
Body Parameter — schedulerbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/schedulers/
Create schedulers by name (createIcebergSystemSettingsSchedulers)
Create/Update multiple schdeulers. The new content for the existing schedulers updates the existing content and the new schedulers are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

schedulers schedulers_schema (required)
Body Parameter — schedulersbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /system-settings/
Create system-settings (createIcebergSystemSettingsSystemSettingsById)
Create/Update system-settings to populate persis-raw-data, schedulers, destinations and reports.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

system_settings system-settings_schema (required)
Body Parameter — system_settings body object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /topic/{topic_name}/rule/{rule_name}/
Update or create a rule. (createIcebergTopicRuleRuleById)
Create/Update a rule by rule-name. The rule-name specified in URL and the request body must match. If the rule already exists then, the existing rule's configuration will be updated with the new content

Path parameters

topic_name (required)
Path Parameter — ID of topic-name
rule_name (required)
Path Parameter — ID of rule-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rule rule_schema (required)
Body Parameter — rulebody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /topic/{topic_name}/
Update or create a topic. (createIcebergTopicTopicById)
Create/Update a topic by topic-name. The topic-name specified in URL and the request body must match. If the topic already exists then, the existing topic's configuration will be updated with the new content.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

topic topic_schema (required)
Body Parameter — topicbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
post /topics/
Update or create multiple topics. (createIcebergTopicsTopicsById)
Create/Update multiple topics. The new content for the existing topics updates the existing content and the new topics are created.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

topics topics_schema (required)
Body Parameter — topicsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /device/{device_id}/
Delete device. (deleteIcebergDeviceDeviceById)
Delete a device by device-id. Delete will fail if the device is being referenced by a device-group.

Path parameters

device_id (required)
Path Parameter — ID of device-id

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /device-group/{device_group_name}/
Delete device-group. (deleteIcebergDeviceGroupDeviceGroupById)
Delete a device-group by device-group-name. Delete will fail if the device-group's services are running.

Path parameters

device_group_name (required)
Path Parameter — ID of device-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /device-groups/
Delete all device-groups. (deleteIcebergDeviceGroupsDeviceGroupsById)
Delete all device-groups. Delete fails if services are still running for the device groups.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /devices/
Delete all devices. (deleteIcebergDevicesDevicesById)
Delete all devices. This will fail if any device is referenced in any device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /network-group/{network_group_name}/
Delete network-group. (deleteIcebergNetworkGroupNetworkGroupById)
Delete a network-group by network-group-name. Delete will fail if the network-group's services are running.

Path parameters

network_group_name (required)
Path Parameter — ID of network-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /network-groups/
Delete all network-groups. (deleteIcebergNetworkGroupsNetworkGroupsById)
Delete all network-groups. Delete will fail if services are still running for the network groups.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /notification/{notification_name}/
Delete a notification. (deleteIcebergNotificationNotificationById)
Delete a notification by notification-name. Delete will fail if the notification is referenced by a device-group.

Path parameters

notification_name (required)
Path Parameter — ID of notification-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /notifications/
Delete all notifications. (deleteIcebergNotificationsNotificationsById)
Delete all notifications. This will fail if any notification is referenced in any device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /playbook/{playbook_name}/
Delete a playbook. (deleteIcebergPlaybookPlaybookById)
Delete a playbook by playbook-name. Delete will fail if the playbook is referenced by a device-group.

Path parameters

playbook_name (required)
Path Parameter — ID of playbook-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /playbooks/
Delete all playbooks. (deleteIcebergPlaybooksPlaybooksById)
Delete all playbooks. This will fail if any playbook is referenced in any device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /retention-policies/
Delete all retention-policies. (deleteIcebergRetentionPoliciesRetentionPoliciesById)
Delete all the retention policies. This will fail if any retention-policy is referenced in any device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /retention-policy/{retention_policy_name}/
Delete a retention-policy. (deleteIcebergRetentionPolicyRetentionPolicyById)
Delete a retention-policy by retention-policy-name. Delete will fail if the retention-policy is referenced by a device-group.

Path parameters

retention_policy_name (required)
Path Parameter — ID of retention-policy-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/report-generation/destination/{name}/
Delete destination by name (deleteIcebergSystemSettingsDestinationById)
Delete a destination by name. Delete will fail if the destination is being referenced by a report.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/report-generation/destinations/
Delete destinations by name (deleteIcebergSystemSettingsDestinations)
Delete all destinations. This will fail if any destination is referenced in any report.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/report-generation/report/{name}/
Delete report by name (deleteIcebergSystemSettingsReportById)
Delete a report by name. Delete will fail if the report is being referenced by a device-group or network-group.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/report-generation/reports/
Delete reports by name (deleteIcebergSystemSettingsReports)
Delete all reports. This will fail if any report is referenced in any device-group or network-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/scheduler/{name}/
Delete scheduler by name (deleteIcebergSystemSettingsSchedulerById)
Delete a scheduler by name. Delete will fail if the scheduler is being referenced by a report.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/schedulers/
Delete schedulers by name (deleteIcebergSystemSettingsSchedulers)
Delete all schedulers. This will fail if any scheduler is referenced in any report.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
delete /system-settings/
Delete system-settings (deleteIcebergSystemSettingsSystemSettingsById)
Delete system-settings. This will delete all the reports, destinations and schedulers. The request will fail of any of the reports is being referenced by a device-group or network-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /topic/{topic_name}/rule/{rule_name}/
Delete a rule. (deleteIcebergTopicRuleRuleById)
Delete a rule by rule-name. Delete will fail if the rule is referenced by any other playbook.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name
rule_name (required)
Path Parameter — ID of rule-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /topic/{topic_name}/
Delete a topic. (deleteIcebergTopicTopicById)
Delete a topic by topic-name. Delete will fail if the topic is referenced by any other playbook.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
delete /topics/
Delete all topics. (deleteIcebergTopicsTopicsById)
Delete all topics. This will fail if any topic is referenced in any playbook.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
get /configuration/
Get all groups affected by un-committed configuration changes. (retrieveAffectedGroups)
Get all groups that are affected by the un-committed configuration changes.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

affected-groups

Example data

Content-Type: application/json
{
  "network-groups" : [ "network-groups", "network-groups" ],
  "device-groups" : [ "device-groups", "device-groups" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation affected-groups

default

unexpected error Error

Up
get /device-group/{device_group_name}/status/
Get device-group's status. (retrieveDeviceGroupStatus)
Get information about the status of a device-group's services.

Path parameters

device_group_name (required)
Path Parameter — Name of device-group

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

serviceStatus

Example data

Content-Type: application/json
{
  "service1" : "status1",
  "service2" : "status2"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Running status of device-group services serviceStatus

default

unexpected error Error

Up
get /device/
List all device-ids. (retrieveIcebergDeviceDevice)
Get a list of all the device IDs.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "dev1", "dev2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[dev1, dev2]

400

Internal Error

Up
get /device/{device_id}/
Get a device's configuration. (retrieveIcebergDeviceDeviceById)
Get the configuration details of a device by its device-id.

Path parameters

device_id (required)
Path Parameter — ID of device-id

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

device_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "port" : 6
  },
  "system-id" : "system-id",
  "vendor" : {
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    }
  },
  "host" : "host",
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "snmp" : {
    "port" : 1,
    "v2" : {
      "community" : "community"
    }
  },
  "device-id" : "device-id",
  "iAgent" : {
    "port" : 0
  },
  "authentication" : {
    "password" : {
      "password" : "password",
      "username" : "username"
    },
    "ssl" : {
      "key-file" : "key-file"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device_schema

400

Internal Error

Up
get /device-group/
List all device-group names. (retrieveIcebergDeviceGroupDeviceGroup)
Get a list of all the device-group names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "device-group1", "device-group2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[device-group1, device-group2]

400

Internal Error

Up
get /device-group/{device_group_name}/
Get device-group's configuration. (retrieveIcebergDeviceGroupDeviceGroupById)
Get configuration details of a device group by the device group name.

Path parameters

device_group_name (required)
Path Parameter — ID of device-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

device-group_schema

Example data

Content-Type: application/json
{
  "notification" : {
    "normal" : [ "normal", "normal" ],
    "major" : [ "major", "major" ],
    "minor" : [ "minor", "minor" ],
    "enable" : ""
  },
  "reports" : [ "reports", "reports" ],
  "device-group-name" : "device-group-name",
  "devices" : [ "devices", "devices" ],
  "native-gpb" : {
    "ports" : [ 0, 0 ]
  },
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "logging" : {
    "log-level" : "critical"
  },
  "playbooks" : [ "playbooks", "playbooks" ],
  "retention-policy" : "retention-policy",
  "authentication" : {
    "password" : {
      "password" : "password",
      "username" : "username"
    },
    "ssl" : {
      "key-file" : "key-file"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device-group_schema

400

Internal Error

Up
get /device-groups/
Get all device-groups' configuration. (retrieveIcebergDeviceGroupsDeviceGroups)
Get configuration details of all the device-groups.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

device-groups_schema

Example data

Content-Type: application/json
{
  "device-group" : [ {
    "notification" : {
      "normal" : [ "normal", "normal" ],
      "major" : [ "major", "major" ],
      "minor" : [ "minor", "minor" ],
      "enable" : ""
    },
    "reports" : [ "reports", "reports" ],
    "device-group-name" : "device-group-name",
    "devices" : [ "devices", "devices" ],
    "native-gpb" : {
      "ports" : [ 0, 0 ]
    },
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "logging" : {
      "log-level" : "critical"
    },
    "playbooks" : [ "playbooks", "playbooks" ],
    "retention-policy" : "retention-policy",
    "authentication" : {
      "password" : {
        "password" : "password",
        "username" : "username"
      },
      "ssl" : {
        "key-file" : "key-file"
      }
    }
  }, {
    "notification" : {
      "normal" : [ "normal", "normal" ],
      "major" : [ "major", "major" ],
      "minor" : [ "minor", "minor" ],
      "enable" : ""
    },
    "reports" : [ "reports", "reports" ],
    "device-group-name" : "device-group-name",
    "devices" : [ "devices", "devices" ],
    "native-gpb" : {
      "ports" : [ 0, 0 ]
    },
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "logging" : {
      "log-level" : "critical"
    },
    "playbooks" : [ "playbooks", "playbooks" ],
    "retention-policy" : "retention-policy",
    "authentication" : {
      "password" : {
        "password" : "password",
        "username" : "username"
      },
      "ssl" : {
        "key-file" : "key-file"
      }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device-groups_schema

400

Internal Error

Up
get /devices/
Get all devices' configuration. (retrieveIcebergDevicesDevices)
Get the configuration details of all devices.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

devices_schema

Example data

Content-Type: application/json
{
  "device" : [ {
    "open-config" : {
      "port" : 6
    },
    "system-id" : "system-id",
    "vendor" : {
      "juniper" : {
        "operating-system" : "junos"
      },
      "cisco" : {
        "operating-system" : "iosxr"
      }
    },
    "host" : "host",
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "snmp" : {
      "port" : 1,
      "v2" : {
        "community" : "community"
      }
    },
    "device-id" : "device-id",
    "iAgent" : {
      "port" : 0
    },
    "authentication" : {
      "password" : {
        "password" : "password",
        "username" : "username"
      },
      "ssl" : {
        "key-file" : "key-file"
      }
    }
  }, {
    "open-config" : {
      "port" : 6
    },
    "system-id" : "system-id",
    "vendor" : {
      "juniper" : {
        "operating-system" : "junos"
      },
      "cisco" : {
        "operating-system" : "iosxr"
      }
    },
    "host" : "host",
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "snmp" : {
      "port" : 1,
      "v2" : {
        "community" : "community"
      }
    },
    "device-id" : "device-id",
    "iAgent" : {
      "port" : 0
    },
    "authentication" : {
      "password" : {
        "password" : "password",
        "username" : "username"
      },
      "ssl" : {
        "key-file" : "key-file"
      }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation devices_schema

400

Internal Error

Up
get /network-group/
List all network-group names. (retrieveIcebergNetworkGroupNetworkGroup)
Get a list of all the network-group-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "network-group1", "network-group2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[network-group1, network-group2]

400

Internal Error

Up
get /network-group/{network_group_name}/
Get network-group's configuration. (retrieveIcebergNetworkGroupNetworkGroupById)
Get the configuration details of a network group by its network group name.

Path parameters

network_group_name (required)
Path Parameter — ID of network-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

network-group_schema

Example data

Content-Type: application/json
{
  "reports" : [ "reports", "reports" ],
  "notification" : {
    "normal" : [ "normal", "normal" ],
    "major" : [ "major", "major" ],
    "minor" : [ "minor", "minor" ],
    "enable" : ""
  },
  "network-group-name" : "network-group-name",
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "playbooks" : [ "playbooks", "playbooks" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation network-group_schema

400

Internal Error

Up
get /network-groups/
Get all network-groups' configuration. (retrieveIcebergNetworkGroupsNetworkGroups)
Get configuration of all network-groups.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

network-groups_schema

Example data

Content-Type: application/json
{
  "network-group" : [ {
    "reports" : [ "reports", "reports" ],
    "notification" : {
      "normal" : [ "normal", "normal" ],
      "major" : [ "major", "major" ],
      "minor" : [ "minor", "minor" ],
      "enable" : ""
    },
    "network-group-name" : "network-group-name",
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "playbooks" : [ "playbooks", "playbooks" ]
  }, {
    "reports" : [ "reports", "reports" ],
    "notification" : {
      "normal" : [ "normal", "normal" ],
      "major" : [ "major", "major" ],
      "minor" : [ "minor", "minor" ],
      "enable" : ""
    },
    "network-group-name" : "network-group-name",
    "variable" : [ {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    }, {
      "instance-id" : "instance-id",
      "rule" : "rule",
      "variable-value" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "playbook" : "playbook"
    } ],
    "description" : "description",
    "playbooks" : [ "playbooks", "playbooks" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation network-groups_schema

400

Internal Error

Up
get /notification/
List all notification-names. (retrieveIcebergNotificationNotification)
Get a list of all the notification-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "notification-1", "notification-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[notification-1, notification-2]

400

Internal Error

Up
get /notification/{notification_name}/
Get a notification's configuration. (retrieveIcebergNotificationNotificationById)
Get the configuration details of a notification by notification-name.

Path parameters

notification_name (required)
Path Parameter — ID of notification-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

notification_schema

Example data

Content-Type: application/json
{
  "http-post" : {
    "basic" : {
      "password" : "password",
      "username" : "username"
    },
    "url" : "url"
  },
  "notification-name" : "notification-name",
  "slack" : {
    "channel" : "channel",
    "url" : "url"
  },
  "kafka-publish" : {
    "sasl" : {
      "password" : "password",
      "certificate" : "certificate",
      "username" : "username"
    },
    "bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
    "topic" : "topic"
  },
  "description" : "description"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation notification_schema

400

Internal Error

Up
get /notifications/
Get all notifications' configuration. (retrieveIcebergNotificationsNotificationsById)
Get the configuration details of all notifications.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

notifications_schema

Example data

Content-Type: application/json
{
  "notification" : [ {
    "http-post" : {
      "basic" : {
        "password" : "password",
        "username" : "username"
      },
      "url" : "url"
    },
    "notification-name" : "notification-name",
    "slack" : {
      "channel" : "channel",
      "url" : "url"
    },
    "kafka-publish" : {
      "sasl" : {
        "password" : "password",
        "certificate" : "certificate",
        "username" : "username"
      },
      "bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
      "topic" : "topic"
    },
    "description" : "description"
  }, {
    "http-post" : {
      "basic" : {
        "password" : "password",
        "username" : "username"
      },
      "url" : "url"
    },
    "notification-name" : "notification-name",
    "slack" : {
      "channel" : "channel",
      "url" : "url"
    },
    "kafka-publish" : {
      "sasl" : {
        "password" : "password",
        "certificate" : "certificate",
        "username" : "username"
      },
      "bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
      "topic" : "topic"
    },
    "description" : "description"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation notifications_schema

400

Internal Error

Up
get /playbook/
List all playbook-names. (retrieveIcebergPlaybookPlaybook)
Get a list of all the playbook-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "playbook-1", "playbook-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[playbook-1, playbook-2]

400

Internal Error

Up
get /playbook/{playbook_name}/
Get a playbook's configuration. (retrieveIcebergPlaybookPlaybookById)
Get the configuration details of a playbook by playbook-name.

Path parameters

playbook_name (required)
Path Parameter — ID of playbook-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

playbook_schema

Example data

Content-Type: application/json
{
  "playbook-name" : "playbook-name",
  "description" : "description",
  "rules" : [ "rules", "rules" ],
  "synopsis" : "synopsis"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation playbook_schema

400

Internal Error

Up
get /playbooks/
Get all playbooks' configuration. (retrieveIcebergPlaybooksPlaybooksById)
Get the configuration of all playbooks.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

playbooks_schema

Example data

Content-Type: application/json
{
  "playbook" : [ {
    "playbook-name" : "playbook-name",
    "description" : "description",
    "rules" : [ "rules", "rules" ],
    "synopsis" : "synopsis"
  }, {
    "playbook-name" : "playbook-name",
    "description" : "description",
    "rules" : [ "rules", "rules" ],
    "synopsis" : "synopsis"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation playbooks_schema

400

Internal Error

Up
get /retention-policies/
Get all retention-policies' configuration. (retrieveIcebergRetentionPoliciesRetentionPoliciesById)
Get the configuration of all the retention-policies.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

retention-policies_schema

Example data

Content-Type: application/json
{
  "retention-policy" : [ {
    "duration" : "duration",
    "replication" : 0,
    "retention-policy-name" : "retention-policy-name"
  }, {
    "duration" : "duration",
    "replication" : 0,
    "retention-policy-name" : "retention-policy-name"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation retention-policies_schema

400

Internal Error

Up
get /retention-policy/
List all retention-policy-names. (retrieveIcebergRetentionPolicyRetentionPolicy)
Get a list of all the retention-policy-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "retention-policy-1", "retention-policy-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[retention-policy-1, retention-policy-2]

400

Internal Error

Up
get /retention-policy/{retention_policy_name}/
Get a retention-policy's configuration. (retrieveIcebergRetentionPolicyRetentionPolicyById)
Get the configuration details of a retention policy by retention-policy-name.

Path parameters

retention_policy_name (required)
Path Parameter — ID of retention-policy-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

retention-policy_schema

Example data

Content-Type: application/json
{
  "duration" : "duration",
  "replication" : 0,
  "retention-policy-name" : "retention-policy-name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation retention-policy_schema

400

Internal Error

Up
get /system-settings/report-generation/destination/{name}/
Retrieve destination by name (retrieveIcebergSystemSettingsDestinationById)
Get the configuration details of a destination by its name.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

destination_schema

Example data

Content-Type: application/json
{
  "disk" : {
    "max-reports" : 0
  },
  "name" : "name",
  "email" : {
    "id" : "id"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation destination_schema

400

Internal Error

Up
get /system-settings/report-generation/destinations/
Retrieve destinations by name (retrieveIcebergSystemSettingsDestinations)
Get the configuration details of all destinations.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

destinations_schema

Example data

Content-Type: application/json
{
  "destination" : [ {
    "disk" : {
      "max-reports" : 0
    },
    "name" : "name",
    "email" : {
      "id" : "id"
    }
  }, {
    "disk" : {
      "max-reports" : 0
    },
    "name" : "name",
    "email" : {
      "id" : "id"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation destinations_schema

400

Internal Error

Up
get /system-settings/report-generation/report/{name}/
Retrieve report by name (retrieveIcebergSystemSettingsReportById)
Get the configuration details of a report by its name.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

report_schema

Example data

Content-Type: application/json
{
  "schedule" : [ "schedule", "schedule" ],
  "destination" : [ "destination", "destination" ],
  "format" : "json",
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation report_schema

400

Internal Error

Up
get /system-settings/report-generation/reports/
Retrieve reports by name (retrieveIcebergSystemSettingsReports)
Get the configuration details of all reports.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

reports_schema

Example data

Content-Type: application/json
{
  "report" : [ {
    "schedule" : [ "schedule", "schedule" ],
    "destination" : [ "destination", "destination" ],
    "format" : "json",
    "name" : "name"
  }, {
    "schedule" : [ "schedule", "schedule" ],
    "destination" : [ "destination", "destination" ],
    "format" : "json",
    "name" : "name"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation reports_schema

400

Internal Error

Up
get /system-settings/scheduler/{name}/
Retrieve scheduler by name (retrieveIcebergSystemSettingsSchedulerById)
Get the configuration details of a scheduler by its name.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

scheduler_schema

Example data

Content-Type: application/json
{
  "start-time" : "start-time",
  "end-time" : "end-time",
  "repeat" : {
    "never" : "",
    "interval" : {
      "hours" : 1,
      "minutes" : 5,
      "days" : 6
    },
    "every" : "week"
  },
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation scheduler_schema

400

Internal Error

Up
get /system-settings/schedulers/
Retrieve schedulers by name (retrieveIcebergSystemSettingsSchedulers)
Get the configuration details of all schedulers.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

schedulers_schema

Example data

Content-Type: application/json
{
  "scheduler" : [ {
    "start-time" : "start-time",
    "end-time" : "end-time",
    "repeat" : {
      "never" : "",
      "interval" : {
        "hours" : 1,
        "minutes" : 5,
        "days" : 6
      },
      "every" : "week"
    },
    "name" : "name"
  }, {
    "start-time" : "start-time",
    "end-time" : "end-time",
    "repeat" : {
      "never" : "",
      "interval" : {
        "hours" : 1,
        "minutes" : 5,
        "days" : 6
      },
      "every" : "week"
    },
    "name" : "name"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation schedulers_schema

400

Internal Error

Up
get /system-settings/
Retrieve system-settings (retrieveIcebergSystemSettingsSystemSettings)
Retrieve system-settings

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

system-settings_schema

Example data

Content-Type: application/json
{
  "system-settings" : {
    "scheduler" : [ {
      "start-time" : "start-time",
      "end-time" : "end-time",
      "repeat" : {
        "never" : "",
        "interval" : {
          "hours" : 1,
          "minutes" : 5,
          "days" : 6
        },
        "every" : "week"
      },
      "name" : "name"
    }, {
      "start-time" : "start-time",
      "end-time" : "end-time",
      "repeat" : {
        "never" : "",
        "interval" : {
          "hours" : 1,
          "minutes" : 5,
          "days" : 6
        },
        "every" : "week"
      },
      "name" : "name"
    } ],
    "persist-raw-data" : "",
    "report-generation" : {
      "destination" : [ {
        "disk" : {
          "max-reports" : 0
        },
        "name" : "name",
        "email" : {
          "id" : "id"
        }
      }, {
        "disk" : {
          "max-reports" : 0
        },
        "name" : "name",
        "email" : {
          "id" : "id"
        }
      } ],
      "report" : [ {
        "schedule" : [ "schedule", "schedule" ],
        "destination" : [ "destination", "destination" ],
        "format" : "json",
        "name" : "name"
      }, {
        "schedule" : [ "schedule", "schedule" ],
        "destination" : [ "destination", "destination" ],
        "format" : "json",
        "name" : "name"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation system-settings_schema

400

Internal Error

Up
get /topic/{topic_name}/rule/
List all rule-names in a topic. (retrieveIcebergTopicRuleRule)
Get a list of all the rule-names in a topic.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "rule-1", "rule-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[rule-1, rule-2]

400

Internal Error

Up
get /topic/{topic_name}/rule/{rule_name}/
Get a rule's configuration. (retrieveIcebergTopicRuleRuleById)
Get the configuration details of a rule by rule-name.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name
rule_name (required)
Path Parameter — ID of rule-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

rule_schema

Example data

Content-Type: application/json
{
  "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
  "field" : [ {
    "description" : "This field is for neighbor address",
    "field-name" : "neighbor-address",
    "sensor" : [ {
      "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
      "sensor-name" : "bgp-sensor",
      "where" : [ {
        "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
      } ]
    } ],
    "type" : "string"
  } ],
  "keys" : [ "neighbor-address" ],
  "rule-name" : "check-bgp-route-flap-damping",
  "sensor" : [ {
    "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
    "open-config" : {
      "frequency" : "10s",
      "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
    },
    "sensor-name" : "bgp-sensor",
    "synopsis" : "bgp open-config sensor definition"
  } ],
  "synopsis" : "bgp session state analyzer",
  "trigger" : [ {
    "description" : "Sets health based on bgp neighbor route flap damping.",
    "synopsis" : "bgp neighbor route flap damping kpi",
    "term" : [ {
      "term-name" : "is-neighbor-route-flap-damping",
      "then" : {
        "status" : {
          "color" : "red",
          "message" : "Observed route-flap-damping"
        }
      },
      "when" : {
        "does-not-match-with" : [ {
          "left-operand" : "$route-flap-damping",
          "right-operand" : "false"
        } ]
      }
    } ],
    "trigger-name" : "neigbor-route-flap-damping"
  } ],
  "variable" : [ {
    "description" : "Enter neighbor name or address using regular expression",
    "name" : "neighbors",
    "type" : "string",
    "value" : ".*"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation rule_schema

400

Internal Error

Up
get /topic/
List all topic-names. (retrieveIcebergTopicTopic)
Get a list of all the topic-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "topic-1", "topic-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[topic-1, topic-2]

400

Internal Error

Up
get /topic/{topic_name}/
Get a topic's configuration. (retrieveIcebergTopicTopicById)
Get the configuration details of a topic by the topic-name.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

topic_schema

Example data

Content-Type: application/json
{
  "sub-topics" : [ "sub-topics", "sub-topics" ],
  "description" : "description",
  "rule" : [ {
    "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
    "field" : [ {
      "description" : "This field is for neighbor address",
      "field-name" : "neighbor-address",
      "sensor" : [ {
        "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
        "sensor-name" : "bgp-sensor",
        "where" : [ {
          "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
        } ]
      } ],
      "type" : "string"
    } ],
    "keys" : [ "neighbor-address" ],
    "rule-name" : "check-bgp-route-flap-damping",
    "sensor" : [ {
      "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
      "open-config" : {
        "frequency" : "10s",
        "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
      },
      "sensor-name" : "bgp-sensor",
      "synopsis" : "bgp open-config sensor definition"
    } ],
    "synopsis" : "bgp session state analyzer",
    "trigger" : [ {
      "description" : "Sets health based on bgp neighbor route flap damping.",
      "synopsis" : "bgp neighbor route flap damping kpi",
      "term" : [ {
        "term-name" : "is-neighbor-route-flap-damping",
        "then" : {
          "status" : {
            "color" : "red",
            "message" : "Observed route-flap-damping"
          }
        },
        "when" : {
          "does-not-match-with" : [ {
            "left-operand" : "$route-flap-damping",
            "right-operand" : "false"
          } ]
        }
      } ],
      "trigger-name" : "neigbor-route-flap-damping"
    } ],
    "variable" : [ {
      "description" : "Enter neighbor name or address using regular expression",
      "name" : "neighbors",
      "type" : "string",
      "value" : ".*"
    } ]
  }, {
    "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
    "field" : [ {
      "description" : "This field is for neighbor address",
      "field-name" : "neighbor-address",
      "sensor" : [ {
        "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
        "sensor-name" : "bgp-sensor",
        "where" : [ {
          "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
        } ]
      } ],
      "type" : "string"
    } ],
    "keys" : [ "neighbor-address" ],
    "rule-name" : "check-bgp-route-flap-damping",
    "sensor" : [ {
      "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
      "open-config" : {
        "frequency" : "10s",
        "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
      },
      "sensor-name" : "bgp-sensor",
      "synopsis" : "bgp open-config sensor definition"
    } ],
    "synopsis" : "bgp session state analyzer",
    "trigger" : [ {
      "description" : "Sets health based on bgp neighbor route flap damping.",
      "synopsis" : "bgp neighbor route flap damping kpi",
      "term" : [ {
        "term-name" : "is-neighbor-route-flap-damping",
        "then" : {
          "status" : {
            "color" : "red",
            "message" : "Observed route-flap-damping"
          }
        },
        "when" : {
          "does-not-match-with" : [ {
            "left-operand" : "$route-flap-damping",
            "right-operand" : "false"
          } ]
        }
      } ],
      "trigger-name" : "neigbor-route-flap-damping"
    } ],
    "variable" : [ {
      "description" : "Enter neighbor name or address using regular expression",
      "name" : "neighbors",
      "type" : "string",
      "value" : ".*"
    } ]
  } ],
  "synopsis" : "synopsis",
  "topic-name" : "topic-name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation topic_schema

400

Internal Error

Up
get /topics/
Get all topics' configuration. (retrieveIcebergTopicsTopics)
Get the configuration details of all topics.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration

Return type

topics_schema

Example data

Content-Type: application/json
{
  "topic" : [ {
    "sub-topics" : [ "sub-topics", "sub-topics" ],
    "description" : "description",
    "rule" : [ {
      "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
      "field" : [ {
        "description" : "This field is for neighbor address",
        "field-name" : "neighbor-address",
        "sensor" : [ {
          "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
          "sensor-name" : "bgp-sensor",
          "where" : [ {
            "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
          } ]
        } ],
        "type" : "string"
      } ],
      "keys" : [ "neighbor-address" ],
      "rule-name" : "check-bgp-route-flap-damping",
      "sensor" : [ {
        "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
        "open-config" : {
          "frequency" : "10s",
          "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
        },
        "sensor-name" : "bgp-sensor",
        "synopsis" : "bgp open-config sensor definition"
      } ],
      "synopsis" : "bgp session state analyzer",
      "trigger" : [ {
        "description" : "Sets health based on bgp neighbor route flap damping.",
        "synopsis" : "bgp neighbor route flap damping kpi",
        "term" : [ {
          "term-name" : "is-neighbor-route-flap-damping",
          "then" : {
            "status" : {
              "color" : "red",
              "message" : "Observed route-flap-damping"
            }
          },
          "when" : {
            "does-not-match-with" : [ {
              "left-operand" : "$route-flap-damping",
              "right-operand" : "false"
            } ]
          }
        } ],
        "trigger-name" : "neigbor-route-flap-damping"
      } ],
      "variable" : [ {
        "description" : "Enter neighbor name or address using regular expression",
        "name" : "neighbors",
        "type" : "string",
        "value" : ".*"
      } ]
    }, {
      "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
      "field" : [ {
        "description" : "This field is for neighbor address",
        "field-name" : "neighbor-address",
        "sensor" : [ {
          "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
          "sensor-name" : "bgp-sensor",
          "where" : [ {
            "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
          } ]
        } ],
        "type" : "string"
      } ],
      "keys" : [ "neighbor-address" ],
      "rule-name" : "check-bgp-route-flap-damping",
      "sensor" : [ {
        "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
        "open-config" : {
          "frequency" : "10s",
          "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
        },
        "sensor-name" : "bgp-sensor",
        "synopsis" : "bgp open-config sensor definition"
      } ],
      "synopsis" : "bgp session state analyzer",
      "trigger" : [ {
        "description" : "Sets health based on bgp neighbor route flap damping.",
        "synopsis" : "bgp neighbor route flap damping kpi",
        "term" : [ {
          "term-name" : "is-neighbor-route-flap-damping",
          "then" : {
            "status" : {
              "color" : "red",
              "message" : "Observed route-flap-damping"
            }
          },
          "when" : {
            "does-not-match-with" : [ {
              "left-operand" : "$route-flap-damping",
              "right-operand" : "false"
            } ]
          }
        } ],
        "trigger-name" : "neigbor-route-flap-damping"
      } ],
      "variable" : [ {
        "description" : "Enter neighbor name or address using regular expression",
        "name" : "neighbors",
        "type" : "string",
        "value" : ".*"
      } ]
    } ],
    "synopsis" : "synopsis",
    "topic-name" : "topic-name"
  }, {
    "sub-topics" : [ "sub-topics", "sub-topics" ],
    "description" : "description",
    "rule" : [ {
      "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
      "field" : [ {
        "description" : "This field is for neighbor address",
        "field-name" : "neighbor-address",
        "sensor" : [ {
          "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
          "sensor-name" : "bgp-sensor",
          "where" : [ {
            "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
          } ]
        } ],
        "type" : "string"
      } ],
      "keys" : [ "neighbor-address" ],
      "rule-name" : "check-bgp-route-flap-damping",
      "sensor" : [ {
        "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
        "open-config" : {
          "frequency" : "10s",
          "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
        },
        "sensor-name" : "bgp-sensor",
        "synopsis" : "bgp open-config sensor definition"
      } ],
      "synopsis" : "bgp session state analyzer",
      "trigger" : [ {
        "description" : "Sets health based on bgp neighbor route flap damping.",
        "synopsis" : "bgp neighbor route flap damping kpi",
        "term" : [ {
          "term-name" : "is-neighbor-route-flap-damping",
          "then" : {
            "status" : {
              "color" : "red",
              "message" : "Observed route-flap-damping"
            }
          },
          "when" : {
            "does-not-match-with" : [ {
              "left-operand" : "$route-flap-damping",
              "right-operand" : "false"
            } ]
          }
        } ],
        "trigger-name" : "neigbor-route-flap-damping"
      } ],
      "variable" : [ {
        "description" : "Enter neighbor name or address using regular expression",
        "name" : "neighbors",
        "type" : "string",
        "value" : ".*"
      } ]
    }, {
      "description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
      "field" : [ {
        "description" : "This field is for neighbor address",
        "field-name" : "neighbor-address",
        "sensor" : [ {
          "path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
          "sensor-name" : "bgp-sensor",
          "where" : [ {
            "query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
          } ]
        } ],
        "type" : "string"
      } ],
      "keys" : [ "neighbor-address" ],
      "rule-name" : "check-bgp-route-flap-damping",
      "sensor" : [ {
        "description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
        "open-config" : {
          "frequency" : "10s",
          "sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
        },
        "sensor-name" : "bgp-sensor",
        "synopsis" : "bgp open-config sensor definition"
      } ],
      "synopsis" : "bgp session state analyzer",
      "trigger" : [ {
        "description" : "Sets health based on bgp neighbor route flap damping.",
        "synopsis" : "bgp neighbor route flap damping kpi",
        "term" : [ {
          "term-name" : "is-neighbor-route-flap-damping",
          "then" : {
            "status" : {
              "color" : "red",
              "message" : "Observed route-flap-damping"
            }
          },
          "when" : {
            "does-not-match-with" : [ {
              "left-operand" : "$route-flap-damping",
              "right-operand" : "false"
            } ]
          }
        } ],
        "trigger-name" : "neigbor-route-flap-damping"
      } ],
      "variable" : [ {
        "description" : "Enter neighbor name or address using regular expression",
        "name" : "neighbors",
        "type" : "string",
        "value" : ".*"
      } ]
    } ],
    "synopsis" : "synopsis",
    "topic-name" : "topic-name"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation topics_schema

400

Internal Error

Up
get /network-group/{network_group_name}/status/
Get network-group's status. (retrieveNetworkGroupStatus)
Get information about the status of a network-group's services.

Path parameters

network_group_name (required)
Path Parameter — Name of network-group

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

serviceStatus

Example data

Content-Type: application/json
{
  "service1" : "status1",
  "service2" : "status2"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success serviceStatus

default

unexpected error Error

Up
delete /configuration/
Delete the un-committed configuration. (rollbackUnsavedConfiguration)
The API server follows a commit model. Unsaved configuration is called a working configuration. This API call deletes the working configuration.

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

default

Unexpected error Error

Up
put /device/{device_id}/
Overwrite a device. (updateIcebergDeviceDeviceById)
Overwrite a device by device ID. The device ID specified in the URL and the request body must match.

Path parameters

device_id (required)
Path Parameter — ID of device-id

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device device_schema (required)
Body Parameter — devicebody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /device-group/{device_group_name}/
Overwrite a device-group. (updateIcebergDeviceGroupDeviceGroupById)
Overwrite a device-group by its device-group-name. The device-group-name specified in the URL and the request body must match.

Path parameters

device_group_name (required)
Path Parameter — ID of device-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device_group device-group_schema (required)
Body Parameter — device_groupbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /device-groups/
Overwrite device-groups. (updateIcebergDeviceGroupsDeviceGroupsById)
Overwrite the existing configuration of device-groups. New device-groups are created and the existing device-groups are overwritten with new content. If some existing device-groups are not present in the payload, such device-groups are deleted. This will fail if any of the device-groups that are not present in the payload have running services.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

device_groups device-groups_schema (required)
Body Parameter — device-groupsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /devices/
Overwrite devices. (updateIcebergDevicesDevicesById)
Overwrite the existing configuration of devices. New devices are created and the existing devices are overwritten with new content. If some existing devices are not present in the payload, such devices are deleted. This will fail if any of the devices that are not present in the payload are referenced by a device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

devices devices_schema (required)
Body Parameter — devicesbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /network-group/{network_group_name}/
Overwrite a network-group. (updateIcebergNetworkGroupNetworkGroupById)
Overwrite a network-group by the network-group-name. The network-group-name specified in the URL and the request body must match.

Path parameters

network_group_name (required)
Path Parameter — ID of network-group-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

network_group network-group_schema (required)
Body Parameter — network_groupbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /network-groups/
Overwrite network-groups. (updateIcebergNetworkGroupsNetworkGroupsById)
Overwrite the existing network-group configuration. New network-groups are created and the existing network-groups are overwritten with new content. If some of the existing network-groups are not present in the payload, such network-groups are deleted. This will fail if any of the network-groups that are not present in the payload have running services.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

network_groups network-groups_schema (required)
Body Parameter — network-groupsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /notification/{notification_name}/
Overwrite a notification. (updateIcebergNotificationNotificationById)
Overwrite a notification by the notification-name. The notification-name specified in URL and the request body must match.

Path parameters

notification_name (required)
Path Parameter — ID of notification-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

notification notification_schema (required)
Body Parameter — notificationbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /notifications/
Overwrite notifications. (updateIcebergNotificationsNotificationsById)
Overwrite the existing notifications configuration. New notifications are created and existing notifications are overwritten with new content. If some of the existing notifications are not present in the payload, such notifications are deleted. This will fail if any of the notifications that are not present in the payload are referenced by a device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

notifications notifications_schema (required)
Body Parameter — notificationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /playbook/{playbook_name}/
Overwrite a playbook. (updateIcebergPlaybookPlaybookById)
Overwrite a playbook by the playbook-name. The playbook-name specified in the URL and the request body must match.

Path parameters

playbook_name (required)
Path Parameter — ID of playbook-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

playbook playbook_schema (required)
Body Parameter — playbookbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /playbooks/
Overwrite all playbooks. (updateIcebergPlaybooksPlaybooksById)
Overwrite the existing playbooks configuration. New playbooks are created and existing playbooks are overwritten with new content. If some of the existing playbooks are not present in the payload, such playbooks are deleted. This will fail if any of the playbooks that are not present in the payload are referenced by a device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

playbooks playbooks_schema (required)
Body Parameter — playbooksbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /retention-policies/
Overwrite all retention-policies. (updateIcebergRetentionPoliciesRetentionPoliciesId)
Overwrite the existing retention-policies configuration. New retention-policies are created and existing retention-policies are overwritten with new content. If some existing retention-policies are not present in the payload, such retention-policies are deleted. This will fail if any of the retention-policies that are not present in the payload are referenced by a device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

retention_policies retention-policies_schema (required)
Body Parameter — retention-policies body object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /retention-policy/{retention_policy_name}/
Overwrite a retention-policy. (updateIcebergRetentionPolicyRetentionPolicyById)
Overwrite a retention-policy by the retention-policy-name. The retention-policy-name specified in URL and the request body must match.

Path parameters

retention_policy_name (required)
Path Parameter — ID of retention-policy-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

retention_policy retention-policy_schema (required)
Body Parameter — retention_policybody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/report-generation/destination/{name}/
Update destination by name (updateIcebergSystemSettingsDestinationById)
Overwrite a destination by destination name. The destination name specified in the URL and the request body must match.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

destination destination_schema (required)
Body Parameter — destinationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/report-generation/destinations/
Update destinations by name (updateIcebergSystemSettingsDestinations)
Overwrite the existing configuration of destinations. New destinations are created and the existing destinations are overwritten with new content. If some existing destinations are not present in the payload, such destinations are deleted. This will fail if any of the destinations that are not present in the payload are referenced by a report.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

destinations destinations_schema (required)
Body Parameter — destinationsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/report-generation/report/{name}/
Update report by name (updateIcebergSystemSettingsReportById)
Overwrite a report by report name. The report name specified in the URL and the request body must match.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

report report_schema (required)
Body Parameter — reportsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/report-generation/reports/
Update reports by name (updateIcebergSystemSettingsReports)
Overwrite the existing configuration of reports. New reports are created and the existing reports are overwritten with new content. If some existing reports are not present in the payload, such reports are deleted. This will fail if any of the reports that are not present in the payload are referenced by a device-group or network-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

reports reports_schema (required)
Body Parameter — reportsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/scheduler/{name}/
Update scheduler by name (updateIcebergSystemSettingsSchedulerById)
Overwrite a scheduler by scheduler name. The scheduler name specified in the URL and the request body must match.

Path parameters

name (required)
Path Parameter — ID of name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

scheduler scheduler_schema (required)
Body Parameter — schedulerbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/schedulers/
Update schedulers by name (updateIcebergSystemSettingsSchedulers)
Update operation of resource: schedulers

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

schedulers schedulers_schema (required)
Body Parameter — schedulersbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /system-settings/
Update system-settings by ID (updateIcebergSystemSettingsSystemSettingsById)
Overwrite the existing configuration of system-settings. New system-settings are created and existing system-settings are overwritten with new content. If some existing system-settings are not present in the payload, such system-settings are deleted. This will fail if any of the reports in system-settings that are not present in the payload are referenced by a device-group or network-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

system_settings system-settings_schema (required)
Body Parameter — system_settingsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /topic/{topic_name}/rule/{rule_name}/
Overwrite a rule. (updateIcebergTopicRuleRuleById)
Overwrite a rule by the rule-name. The rule-name specified in URL and the request body must match.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name
rule_name (required)
Path Parameter — ID of rule-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rule rule_schema (required)
Body Parameter — rulebody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /topic/{topic_name}/
Overwrite a topic. (updateIcebergTopicTopicById)
Overwrite a topic by the topic-name. The topic-name specified in URL and the request body must match.

Path parameters

topic_name (required)
Path Parameter — ID of topic-name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

topic topic_schema (required)
Body Parameter — topicbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Up
put /topics/
Overwrite topics. (updateIcebergTopicsTopicsById)
Overwrite the existing topics configuration. New topics are created and existing topics are overwritten with new content. If some existing topics are not present in the payload, such topics are deleted. This will fail if any of the topics that are not present in the payload are referenced by a playbook.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

topics topics_schema (required)
Body Parameter — topicsbody object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

DataSource

Up
post /data-store/{group_name}/
Create dashboard details. (createDataStore)
Store data-store details in database for the requested group name and key.

Path parameters

group_name (required)
Path Parameter — Group name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data datastore_schema (required)
Body Parameter — Value of data_store object

Query parameters

key (required)
Query Parameter — Key of data_store object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

DataStore

Up
delete /data-store/{group_name}/
Delete dashboard details. (deleteDataStore)
Delete data_store details for the given group-name, or as per the keys passed in query.

Path parameters

group_name (required)
Path Parameter — Group name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

key (optional)
Query Parameter — ID of dashboard

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

400

Internal Error

Up
get /data-store/{group_name}/
Delete dashboard details. (retrieveDataStore)
Retrieve data_store details for the given group-name, or as per the keys passed in query.

Path parameters

group_name (required)
Path Parameter — Group name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

key (optional)
Query Parameter — Key of data_store object

Return type

datastore_schema

Example data

Content-Type: application/json
{
  "group-name" : "group-name",
  "value" : "{}",
  "key" : "key"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation datastore_schema

400

Internal Error

Up
put /data-store/{group_name}/
Update data_store details. (updateDataStore)
Update data-store details in database for the requested group name and key.

Path parameters

group_name (required)
Path Parameter — Group name

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

data datastore_schema (required)
Body Parameter — value of data_store object

Query parameters

key (required)
Query Parameter — key of data_store

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Internal Error

Default

Up
post /files/helper-files/{file_name}/
Upload a helper-file. (createFilesHelperFilesByFileName)
Upload the specified helper-file.

Path parameters

file_name (required)
Path Parameter — File name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

input_path (optional)
Query Parameter — Input path

Form parameters

up_file (required)
Form Parameter — File content

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

unexpected error Error

Up
delete /files/helper-files/{file_name}/
Delete a helper-file. (deleteFilesHelperFilesByFileName)
Delete the specified helper-file. Delete will not fail if the helper-file is being used by some service.

Path parameters

file_name (required)
Path Parameter — File name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

input_path (optional)
Query Parameter — Input path

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

default

unexpected error Error

Up
post /inspect/command-rpc/table/
Inspect the given iAgent table. (inspectCommandRpcTableOnDevice)
Inspect the given iAgent table on a device and return the results.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

command_rpc_detail command-rpc (required)
Body Parameter — command-rpc object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

Unexpected error Error

Up
get /configuration/jobs/
(retrieveConfigurationJobs)
Return list of all the Commit Job ID's

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

job_id (optional)
Query Parameter — Id of Job format: uuid
job_status (optional)
Query Parameter — Type of job

Return type

array[inline_response_200]

Example data

Content-Type: application/json
[ {
  "job-id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "job-result" : "job-result",
  "job-status" : "finished"
}, {
  "job-id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "job-result" : "job-result",
  "job-status" : "finished"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful creation of job.

default

unexpected error Error

Up
get /data/database/table/
Get information about tables for a device of a device-group. (retrieveDataDatabaseTable)
Get information about different types of tables stored for a device of a device-group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

device_id (optional)
Query Parameter — Name of device
device_group_name (optional)
Query Parameter — Name of device-group
network_group_name (optional)
Query Parameter — Name of network-group

Return type

array[table_schema]

Example data

Content-Type: application/json
[ {
  "db_name" : "db_name",
  "name" : "name",
  "type" : "Prediction table"
}, {
  "db_name" : "db_name",
  "name" : "name",
  "type" : "Prediction table"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Tables in the given database

default

unexpected error Error

Up
get /data/database/table/column/
Get information about columns in a table. (retrieveDataDatabaseTableColumnByTableName)
Get information about columns in a table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

device_id (optional)
Query Parameter — Name of device
device_group_name (optional)
Query Parameter — Name of device-group
network_group_name (optional)
Query Parameter — Name of network-group
table_name (required)
Query Parameter — Name of table

Return type

array[String]

Example data

Content-Type: application/json
[ "field-1", "field-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of columns in the given table

Example data

Content-Type: application/json
[field-1, field-2]

default

unexpected error Error

Up
get /data/database/table/tags/
Get information about tags keys and values in a table. (retrieveDataDatabaseTagsByTableName)
Get information about tags keys and values in a table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

device_id (optional)
Query Parameter — Name of device
device_group_name (optional)
Query Parameter — Name of device-group
network_group_name (optional)
Query Parameter — Name of network-group
table_name (required)
Query Parameter — Name of table
tag (optional)
Query Parameter — Tag key for which values are requested.
where_clause (optional)
Query Parameter — Where condition to select values for the requested key. This would not be processed if there is no tag query parameter. eg: tag_key1=val1 AND tag_key2=val2

Return type

array[String]

Example data

Content-Type: application/json
[ "Value-1", "Value-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of tags in the given table

Example data

Content-Type: application/json
[Value-1, Value-2]

default

unexpected error Error

Up
get /event/
Get all events for a device. (retrieveEvent)
Get the list of events for a device. Filtering is possible with the use of various query parameters.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
device_id (required)
Query Parameter — device-id of the device for which events are requested
device_group_name (optional)
Query Parameter — Device group's device-group-name of which the device is part
granularity (optional)
Query Parameter — Granularity of query

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of events

default

unexpected error Error

Up
get /event/{event_name}/
Get instances of a device event. (retrieveEventByEventName)
Get instances of a specified device event. Filtering is possible with the use of various query parameters.

Path parameters

event_name (required)
Path Parameter — Name of event

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
device_id (required)
Query Parameter — device-id of the device for which events are requested
device_group_name (optional)
Query Parameter — device-group-name of which the device is part
granularity (optional)
Query Parameter — Granularity of query

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Instance list of specified event

default

unexpected error Error

Up
get /event/device-group/{event_name}/
Get instances of a device-group event. (retrieveEventByEventNameDeviceGroup)
Get instances of a specified device-group event. Filtering is possible with the use of various query parameters.

Path parameters

event_name (required)
Path Parameter — Name of event

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
device_group_name (required)
Query Parameter — device_group_name of the device-group for which events are requested
granularity (optional)
Query Parameter — Granularity of query
device_id (optional)
Query Parameter — list of devices under a device-group to be fetched

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Instance list of specified event

default

unexpected error Error

Up
get /event/network-group/{event_name}/
Get instances of a network-group event. (retrieveEventByEventNameNetworkGroup)
Get instances of a specified network-group event. Filtering is possible with the use of various query parameters.

Path parameters

event_name (required)
Path Parameter — Name of event

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
network_group_name (required)
Query Parameter — network_group_name of the network-group for which events are requested
granularity (optional)
Query Parameter — Granularity of query

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Instance list of specified event

default

unexpected error Error

Up
get /event/device-group/
Get all events for a device-group. (retrieveEventDeviceGroup)
Get the list of events for a device-group. Filtering is possible with the use of various query parameters.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
device_group_name (required)
Query Parameter — device_group_name of the device-group for which events are requested
granularity (optional)
Query Parameter — Granularity of query
device_id (optional)
Query Parameter — list of devices under a device-group to be fetched

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of events

default

unexpected error Error

Up
get /event/network-group/
Get all events for a network-group. (retrieveEventNetworkGroup)
Get the list of events for a network-group. Filtering is possible with the use of various query parameters.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
network_group_name (required)
Query Parameter — network_group_name of the network-group for which events are requested
granularity (optional)
Query Parameter — Granularity of query

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
  "color" : "yellow",
  "event_name" : "event_name",
  "frequency" : 0,
  "timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of events

default

unexpected error Error

Up
get /files/helper-files/
Get all helper-file names. (retrieveFilesHelperFiles)
Get a list of all the helper-file file-names.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

input_path (optional)
Query Parameter — Input path

Return type

array[String]

Example data

Content-Type: application/json
[ "file-1", "file-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[file-1, file-2]

default

unexpected error Error

Up
get /files/helper-files/{file_name}/
Download a helper-file. (retrieveFilesHelperFilesByFileName)
Download the specified helper-file.

Path parameters

file_name (required)
Path Parameter — File name

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

input_path (optional)
Query Parameter — Input path

Return type

File

Example data

Content-Type: application/json
"FILE CONTENT"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation File

Example data

Content-Type: application/json
FILE CONTENT

default

unexpected error Error

Up
get /health/
Return a dict with health of devices in device groups and network groups (retrieveHealthAll)
Returns health of network-groups and devices in device-groups

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

healthSchema

Example data

Content-Type: application/json
{
  "device-health" : {
    "device-1" : {
      "device-group-1" : "green",
      "device-group-2" : "yellow"
    },
    "device-2" : {
      "device-group-1" : "red"
    }
  },
  "network-health" : {
    "network-group-1" : "green",
    "network-group-2" : "red",
    "network-group-3" : "gray"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Dict of health of devices in device groups and network groups healthSchema

default

unexpected error Error

Up
get /health-tree/device-group/{device_group_name}/
Get device-group health-tree. (retrieveHealthTreeByDeviceGroup)
Get health-tree of a specified device-group.

Path parameters

device_group_name (required)
Path Parameterdevice-group-name of device-group

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

timestamp (optional)
Query Parameter — Timestamp at which health tree is requested. If not specified, current server timestamp is used. format: date-time
tolerance (optional)
Query Parameter — Timestamp tolerance in seconds. With this option, health-tree will contain latest data between timestamp-2*tolerance and timestamp. Default value is 2*frequency where frequency is extracted from trigger. format: int64
device (optional)
Query Parameter — list of devices under a device-group to be fetched

Return type

deviceGroupHealthTree

Example data

Content-Type: application/json
{
  "children" : [ {
    "children" : [ {
      "children" : [ {
        "children" : [ {
          "color" : "red",
          "data" : "information for the field",
          "name" : "trigger-1",
          "timestamp" : "2018-06-19T05:29:08.30870784Z"
        }, {
          "color" : "yellow",
          "data" : "information for the field",
          "name" : "trigger-2",
          "timestamp" : "2018-06-19T05:43:31.993232128Z"
        } ],
        "color" : "red",
        "name" : "tag-keys"
      } ],
      "color" : "red",
      "name" : "topic-1"
    }, {
      "children" : [ {
        "color" : "green",
        "data" : "information for the field",
        "name" : "trigger-3",
        "timestamp" : "2018-06-19T05:44:40.4764928Z"
      } ],
      "color" : "green",
      "name" : "topic-2"
    } ],
    "color" : "red",
    "name" : "device-id"
  } ],
  "color" : "red",
  "name" : "device-group-name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Health Tree of a device-group deviceGroupHealthTree

default

unexpected error Error

Up
get /health-tree/{device_id}/
Return a device's health-tree. (retrieveHealthTreeById)
Return health-tree of a specified device identified by device-id.

Path parameters

device_id (required)
Path Parameterdevice-id of device

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

timestamp (optional)
Query Parameter — Timestamp at which health tree is requested. If not specified, current server timestamp is used. format: date-time
tolerance (optional)
Query Parameter — Timestamp tolerance in seconds. With this option, health-tree will contain latest data between timestamp-2*tolerance and timestamp. Default value is 2*frequency where frequency is extracted from trigger. format: int64

Return type

deviceHealthTree

Example data

Content-Type: application/json
{
  "children" : [ {
    "children" : [ {
      "children" : [ {
        "children" : [ {
          "color" : "red",
          "data" : "information for the field",
          "name" : "trigger-1",
          "timestamp" : "2018-06-19T05:29:08.30870784Z"
        }, {
          "color" : "yellow",
          "data" : "information for the field",
          "name" : "trigger-2",
          "timestamp" : "2018-06-19T05:43:31.993232128Z"
        } ],
        "color" : "red",
        "name" : "tag-keys"
      } ],
      "color" : "red",
      "name" : "topic-1"
    }, {
      "children" : [ {
        "color" : "green",
        "data" : "information for the field",
        "name" : "trigger-3",
        "timestamp" : "2018-06-19T05:44:40.4764928Z"
      } ],
      "color" : "green",
      "name" : "topic-2"
    } ],
    "color" : "red",
    "name" : "device-group-name"
  } ],
  "color" : "red",
  "name" : "device-id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Health Tree of device deviceHealthTree

default

unexpected error Error

Up
get /health-tree/network-group/{network_group_name}/
Get network-group health-tree. (retrieveHealthTreeByNetworkGroup)
Get health-tree of a specified network-group.

Path parameters

network_group_name (required)
Path Parameternetwork-group-name of network-group

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

timestamp (optional)
Query Parameter — Timestamp at which health tree is requested. If not specified, current server timestamp is used. format: date-time
tolerance (optional)
Query Parameter — Timestamp tolerance in seconds. With this option, health-tree will contain latest data between timestamp-2*tolerance and timestamp. Default value is 2*frequency where frequency is extracted from trigger. format: int64

Return type

networkHealthTree

Example data

Content-Type: application/json
{
  "children" : [ {
    "children" : [ {
      "children" : [ {
        "color" : "red",
        "data" : "information for the field",
        "name" : "trigger-1",
        "timestamp" : "2018-06-19T05:29:08.30870784Z"
      }, {
        "color" : "yellow",
        "data" : "information for the field",
        "name" : "trigger-2",
        "timestamp" : "2018-06-19T05:43:31.993232128Z"
      } ],
      "color" : "red",
      "name" : "tag-keys"
    } ],
    "color" : "red",
    "name" : "topic-1"
  }, {
    "children" : [ {
      "color" : "green",
      "data" : "information for the field",
      "name" : "trigger-3",
      "timestamp" : "2018-06-19T05:44:40.4764928Z"
    } ],
    "color" : "green",
    "name" : "topic-2"
  } ],
  "color" : "red",
  "name" : "network-group-name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Health Tree of network-group networkHealthTree

default

unexpected error Error

Up
get /sensors/
List all OpenConfig sensors. (retrieveSensors)
Get a list of all the sensors for the filters provided. Filtering is possible with the use of query parameters. If you have a sensor /1/2/3/4/5/6/ and sensor_name=/1and depth=3, the result would be /2/3/4. If you use append=true, then the result would be /1/2/3/4.

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

sensor_name (optional)
Query Parameter — Sensor name prefix.
sensor_type (required)
Query Parameter — Sensor type
depth (optional)
Query Parameter — Relative depth to the sensor_name.
append (optional)
Query Parameter — Returns full path of the sensor.
snmp_table (optional)
Query Parameter — Returns list of all the columns for the particular snmp_table

Return type

array[String]

Example data

Content-Type: application/json
[ "sensor1", "sensor2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of sensors available for the given depth for a sensor_name

Example data

Content-Type: application/json
[sensor1, sensor2]

default

unexpected error Error

Documentation

Up
get /
Get all All API's. (retrieveDefinedApi)
GET static api documentation

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful loaded HTML page

default

unexpected error Error

Facts

Up
get /device/{device_id}/facts/
Get a device's facts. (retrieveIcebergDeviceDeviceFactsById)
Get the fact details of a device by its device-id.

Path parameters

device_id (required)
Path Parameter — ID of device-id

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
update (optional)
Query Parameter — true will first update facts from device and then return facts
timeout (optional)
Query Parameter — timeout in seconds to wait for facts from given device id

Return type

device_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "port" : 6
  },
  "system-id" : "system-id",
  "vendor" : {
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    }
  },
  "host" : "host",
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "snmp" : {
    "port" : 1,
    "v2" : {
      "community" : "community"
    }
  },
  "device-id" : "device-id",
  "iAgent" : {
    "port" : 0
  },
  "authentication" : {
    "password" : {
      "password" : "password",
      "username" : "username"
    },
    "ssl" : {
      "key-file" : "key-file"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device_schema

400

Internal Error

Up
get /devices/facts/
Get devices facts. (retrieveIcebergDevicesDevicesFacts)
Get the fact details of every device

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
update (optional)
Query Parameter — true will first update facts from device and then return facts
timeout (optional)
Query Parameter — timeout in seconds to wait for facts from every device

Return type

device_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "port" : 6
  },
  "system-id" : "system-id",
  "vendor" : {
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    }
  },
  "host" : "host",
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "snmp" : {
    "port" : 1,
    "v2" : {
      "community" : "community"
    }
  },
  "device-id" : "device-id",
  "iAgent" : {
    "port" : 0
  },
  "authentication" : {
    "password" : {
      "password" : "password",
      "username" : "username"
    },
    "ssl" : {
      "key-file" : "key-file"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device_schema

400

Internal Error

Up
get /device-group/{device_group_name}/facts/
Get a devices facts for given group. (retrieveIcebergDevicesFactsByGroup)
Get the fact details of every device under given group

Path parameters

device_group_name (required)
Path Parameter — ID of group

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
update (optional)
Query Parameter — true will first update facts from device and then return facts
timeout (optional)
Query Parameter — timeout in seconds to wait for facts from every device

Return type

device_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "port" : 6
  },
  "system-id" : "system-id",
  "vendor" : {
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    }
  },
  "host" : "host",
  "variable" : [ {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  }, {
    "instance-id" : "instance-id",
    "rule" : "rule",
    "variable-value" : [ {
      "name" : "name",
      "value" : "value"
    }, {
      "name" : "name",
      "value" : "value"
    } ],
    "playbook" : "playbook"
  } ],
  "description" : "description",
  "snmp" : {
    "port" : 1,
    "v2" : {
      "community" : "community"
    }
  },
  "device-id" : "device-id",
  "iAgent" : {
    "port" : 0
  },
  "authentication" : {
    "password" : {
      "password" : "password",
      "username" : "username"
    },
    "ssl" : {
      "key-file" : "key-file"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation device_schema

400

Internal Error

Services

Up
post /services/device-group/{device_group_name}/
Start a device-group's services. (createServicesDeviceGroupsDeviceGroupByDeviceGroupName)
Start services of a device group. Use this to start stopped services.

Path parameters

device_group_name (required)
Path Parameter — Name of device group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

unexpected error Error

Up
post /services/network-group/{network_group_name}/
Start a network-group's services. (createServicesNetworkGroupByNetworkGroupName)
Start services of a network group. Use this to start stopped services.

Path parameters

network_group_name (required)
Path Parameter — Name of network group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

default

unexpected error Error

Up
delete /services/device-group/{device_group_name}/
Stop and remove a device-group's services. (deleteServicesDeviceGroupsDeviceGroupByDeviceGroupName)
Stop and clean services of a device-group. This will remove all the services for a device-group, however, it will not clean up the collected data.

Path parameters

device_group_name (required)
Path Parameter — Name of device group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

default

unexpected error Error

Up
delete /services/network-group/{network_group_name}/
Stop and remove a network-group's services. (deleteServicesNetworkGroupByNetworkGroupName)
Stop and clean the services of a network group. This will remove all the services for a network-group, however, it will not clean up the collected data.

Path parameters

network_group_name (required)
Path Parameter — Name of network group

Consumes

This API call consumes the following media types via the Content-Type request header:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Successful operation

default

unexpected error Error

Up
get /services/device-group/
Get running device-group-names. (retrieveServicesDeviceGroupsDeviceGroupDeviceGroup)
Get the list of device-group-names of device-groups whose services are running.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[String]

Example data

Content-Type: application/json
[ "device-group-1", "device-group-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[device-group-1, device-group-2]

400

Internal Error

Up
get /services/network-group/
Get running network-group-names (retrieveServicesNetworkGroup)
Get the list of network-group-names of network-groups whose services are running.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[String]

Example data

Content-Type: application/json
[ "network-group-1", "network-group-2" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

Example data

Content-Type: application/json
[network-group-1, network-group-2]

400

Internal Error

Models

[ Jump to Methods ]

Table of Contents

  1. Error -
  2. affected-groups -
  3. apply-macro_schema -
  4. applymacro_schema_data -
  5. command-rpc -
  6. commit-job -
  7. datastore_schema -
  8. destination_schema -
  9. destination_schema_disk -
  10. destination_schema_email -
  11. destinations_schema -
  12. device-group_schema -
  13. device-groups_schema -
  14. deviceGroupHealthTree -
  15. deviceHealthSchema -
  16. deviceHealthTree -
  17. device_schema -
  18. device_schema_authentication -
  19. device_schema_iAgent -
  20. device_schema_openconfig -
  21. device_schema_snmp -
  22. device_schema_snmp_v2 -
  23. device_schema_variable -
  24. device_schema_vendor -
  25. device_schema_vendor_cisco -
  26. device_schema_vendor_juniper -
  27. devicegroup_schema_authentication -
  28. devicegroup_schema_authentication_password -
  29. devicegroup_schema_authentication_ssl -
  30. devicegroup_schema_logging -
  31. devicegroup_schema_nativegpb -
  32. devicegroup_schema_notification -
  33. devicegroup_schema_variable -
  34. devicegroup_schema_variablevalue -
  35. devices_schema -
  36. event -
  37. groupHealthSchema -
  38. healthSchema -
  39. inline_response_200 -
  40. network-group_schema -
  41. network-groups_schema -
  42. networkHealthTree -
  43. notification_schema -
  44. notification_schema_httppost -
  45. notification_schema_httppost_basic -
  46. notification_schema_kafkapublish -
  47. notification_schema_kafkapublish_sasl -
  48. notification_schema_slack -
  49. notifications_schema -
  50. playbook_schema -
  51. playbooks_schema -
  52. report-generation_schema -
  53. report_schema -
  54. reports_schema -
  55. retention-policies_schema -
  56. retention-policy_schema -
  57. rule_schema -
  58. rule_schema_argument -
  59. rule_schema_constant -
  60. rule_schema_field -
  61. rule_schema_formula -
  62. rule_schema_formula_1 -
  63. rule_schema_formula_1_and -
  64. rule_schema_formula_1_or -
  65. rule_schema_formula_1_unique -
  66. rule_schema_formula_1_unless -
  67. rule_schema_formula_count -
  68. rule_schema_formula_dynamicthreshold -
  69. rule_schema_formula_max -
  70. rule_schema_formula_mean -
  71. rule_schema_formula_microburst -
  72. rule_schema_formula_min -
  73. rule_schema_formula_outlierdetection -
  74. rule_schema_formula_outlierdetection_algorithm -
  75. rule_schema_formula_outlierdetection_algorithm_dbscan -
  76. rule_schema_formula_outlierdetection_algorithm_dbscan_sensitivity -
  77. rule_schema_formula_outlierdetection_algorithm_kfold3sigma -
  78. rule_schema_formula_predict -
  79. rule_schema_formula_stddev -
  80. rule_schema_formula_userdefinedfunction -
  81. rule_schema_formula_userdefinedfunction_argument -
  82. rule_schema_function -
  83. rule_schema_iAgent -
  84. rule_schema_iAgent_args -
  85. rule_schema_nativegpb -
  86. rule_schema_openconfig -
  87. rule_schema_reference -
  88. rule_schema_ruleproperties -
  89. rule_schema_ruleproperties_catalogue -
  90. rule_schema_ruleproperties_helperfiles -
  91. rule_schema_ruleproperties_supporteddevices -
  92. rule_schema_ruleproperties_supporteddevices_juniper -
  93. rule_schema_ruleproperties_supporteddevices_juniper_operatingsystem -
  94. rule_schema_ruleproperties_supporteddevices_juniper_products -
  95. rule_schema_ruleproperties_supporteddevices_juniper_releases -
  96. rule_schema_ruleproperties_supporteddevices_othervendor -
  97. rule_schema_sensor -
  98. rule_schema_sensor_1 -
  99. rule_schema_snmp -
  100. rule_schema_term -
  101. rule_schema_then -
  102. rule_schema_then_argument -
  103. rule_schema_then_status -
  104. rule_schema_then_userdefinedaction -
  105. rule_schema_trigger -
  106. rule_schema_variable -
  107. rule_schema_vector -
  108. rule_schema_when -
  109. rule_schema_when_doesnotmatchwith -
  110. rule_schema_when_equalto -
  111. rule_schema_when_exists -
  112. rule_schema_when_increasingatleastbyrate -
  113. rule_schema_when_increasingatleastbyvalue -
  114. rule_schema_when_maxrateofincrease -
  115. rule_schema_when_range -
  116. rule_schema_when_userdefinedfunction -
  117. rule_schema_where -
  118. scheduler_schema -
  119. scheduler_schema_repeat -
  120. scheduler_schema_repeat_interval -
  121. schedulers_schema -
  122. serviceStatus -
  123. system-settings_schema -
  124. systemsettings_schema_systemsettings -
  125. systemsettings_schema_systemsettings_reportgeneration -
  126. table_schema -
  127. time-range-mandatory -
  128. topic_schema -
  129. topics_schema -
  130. when-lhs-rhs-group -

Error - Up

detail
status
Integer format: int32

affected-groups - Up

device-groups (optional)
network-groups (optional)

apply-macro_schema - Up

data (optional)
name
String Name of the macro to be expanded format: string

applymacro_schema_data - Up

name
String Keyword part of the keyword-value pair format: string
value (optional)
String Value part of the keyword-value pair format: string

command-rpc - Up

args (optional)
map[String, String] Optional key/value pair arguments to table
filename
String Command-rpc table filename in which the table is defined
host
String Host name or ip-address of the device in which command will be inspected
password
String Password to connect to device
tablename
String Command-rpc table name
target (optional)
String To run command on FPC, specifiy FPC target
username
String Username to connect to device

commit-job - Up

detail
status
Integer format: int32
url

datastore_schema - Up

group-name (optional)
String group name
key (optional)
String key name for the group
value (optional)
Object value for the key

destination_schema - Up

disk (optional)
email (optional)
name
String Name of the destination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

destination_schema_disk - Up

Store report on disk
max-reports (optional)
Integer Maximux repots to store on disk format: int32

destination_schema_email - Up

Send report over email
id (optional)
String Email ID format: string

destinations_schema - Up

destination (optional)

device-group_schema - Up

authentication (optional)
description (optional)
String Description about the device group format: string
device-group-name
String Name of the group. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
devices (optional)
logging (optional)
native-gpb (optional)
notification (optional)
playbooks (optional)
reports (optional)
retention-policy (optional)
String Name of the retention policy to be applied
variable (optional)
array[devicegroup_schema_variable] Playbook variable configuration

device-groups_schema - Up

device-group

deviceGroupHealthTree - Up

children
color (optional)
Enum:
green
yellow
red
data (optional)
name
timestamp (optional)
Date format: date-time

deviceHealthSchema - Up

deviceHealthTree - Up

children
color (optional)
Enum:
green
yellow
red
data (optional)
name
timestamp (optional)
Date format: date-time

device_schema - Up

authentication (optional)
description (optional)
String Description about the device format: string
device-id
String Identifier for the device. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
host
String Name or IP the device format: string
iAgent (optional)
open-config (optional)
snmp (optional)
system-id (optional)
String ID which is sent in the JTI UDP messages format: string
variable (optional)
array[device_schema_variable] Playbook variable configuration
vendor (optional)

device_schema_authentication - Up

password (optional)
ssl (optional)

device_schema_iAgent - Up

port (optional)
Integer Netconf port format: int32

device_schema_openconfig - Up

port
Integer Port on which gRPC connection needs to be established format: int32

device_schema_snmp - Up

port (optional)
Integer Port on which SNMP requests need to be sent. Port 161 is used if not configured. format: int32
v2 (optional)

device_schema_snmp_v2 - Up

community (optional)
String Community name. 'public' will be used if not configured format: string

device_schema_variable - Up

instance-id
String Name of the variable instance. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
playbook
String Name of the playbook in which the variable instance needs to be used
rule
String Name of the rule. This must be of the format / format: string
variable-value (optional)

device_schema_vendor - Up

Vendor specific configuration
cisco (optional)
juniper (optional)

device_schema_vendor_cisco - Up

operating-system
String Operating system of the device
Enum:
iosxr

device_schema_vendor_juniper - Up

operating-system
String Operating system of the device
Enum:
junos
junosEvolved

devicegroup_schema_authentication - Up

Common authentication parameters
password (optional)
ssl (optional)

devicegroup_schema_authentication_password - Up

password
String Password for authentication format: string
username
String Username for authentication format: string

devicegroup_schema_authentication_ssl - Up

key-file (optional)
String File where the keys are stored for authentication format: string

devicegroup_schema_logging - Up

Logging configuration
log-level (optional)
String Set the logging level
Enum:
critical
error
debug
warn
info
notice

devicegroup_schema_nativegpb - Up

ports (optional)
array[Integer] format: int32

devicegroup_schema_notification - Up

enable (optional)
array[null] Turn on notifications
major (optional)
minor (optional)
normal (optional)

devicegroup_schema_variable - Up

instance-id
String Unique ID of the variable instance. This should be unique per playbook and rule combination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
playbook
String Name of the playbook in which the variable instance needs to be used
rule
String Name of the rule. This must be of the format / format: string
variable-value (optional)

devicegroup_schema_variablevalue - Up

name
String Variable name used in the playbook/rule. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
value
String Value for the variable format: string

devices_schema - Up

device

event - Up

color (optional)
String Event severity
Enum:
yellow
red
event_name (optional)
String Event name
frequency (optional)
Integer Frequency of the event.
timestamp (optional)
Date format: date-time

groupHealthSchema - Up

healthSchema - Up

device-health (optional)
network-health (optional)

inline_response_200 - Up

job-id (optional)
UUID format: uuid
job-result (optional)
job-status (optional)
Enum:
finished
killed
pending
started

network-group_schema - Up

description (optional)
String Description about the network group format: string
network-group-name
String Name of the network group. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
reports (optional)
notification (optional)
playbooks (optional)
variable (optional)
array[devicegroup_schema_variable] Playbook variable configuration

network-groups_schema - Up

network-group

networkHealthTree - Up

children
color (optional)
Enum:
green
yellow
red
data (optional)
name
timestamp (optional)
Date format: date-time

notification_schema - Up

description (optional)
String Description about the notification format: string
http-post (optional)
notification-name
String Name of the notification. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
slack (optional)
kafka-publish (optional)

notification_schema_httppost - Up

Define HTTP endpoint to post the notification
basic (optional)
url
String URL on which http notification needs to be posted format: string

notification_schema_httppost_basic - Up

Basic http authetication using username and password
password
String Password for http basic authentication format: string
username
String Username for http basic authentication format: string

notification_schema_kafkapublish - Up

Define kafka notification
bootstrap-servers
array[String] format: string
sasl (optional)
topic (optional)
String Kafka topic to which Healthbot should publish. Should be of pattern .[a-zA-Z0-9_-]+[a-zA-Z0-9._-] , Default value is derived from <device/network-group>.... format: string

notification_schema_kafkapublish_sasl - Up

Authetication using username and password over SSL connection
certificate (optional)
String File path to kafka CA-Certificate. Should be of pattern .+.pem format: string
password (optional)
String Password for sasl_ssl authentication format: string
username (optional)
String Username for sasl_ssl authentication format: string

notification_schema_slack - Up

Define slack notification
channel
String Channel on which notification should be posted format: string
url
String URL on which slack notification needs to be posted format: string

notifications_schema - Up

notification

playbook_schema - Up

description (optional)
String Description about this playbook format: string
playbook-name
String Name of the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
rules (optional)
array[String] format: string
synopsis (optional)
String Short description about this playbook format: string

playbooks_schema - Up

playbook

report-generation_schema - Up

destination (optional)
report (optional)

report_schema - Up

destination
format (optional)
String Generated report format
Enum:
json
html
name
String Name of the report format: string
schedule

reports_schema - Up

report (optional)

retention-policies_schema - Up

retention-policy

retention-policy_schema - Up

duration (optional)
String Schedule duration in days or hours, Should be of pattern [1-9][0-9]*[dh] format: string
replication (optional)
Integer Number of independent copies if stored in the cluster format: int32
retention-policy-name
String Name of the retention-policy. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

rule_schema - Up

description (optional)
String Description about the rule format: string
field (optional)
function (optional)
keys (optional)
array[String] format: string
network-rule (optional)
array[null] Flag to denote a network rule
rule-frequency (optional)
String Frequency at which the rule’s field, reference, and vector elements should be computed. Required only when a rule doesn’t have a sensor defined. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
rule-name
String Name of the rule. Should be of pattern [a-z][a-z0-9_-]* format: string
sensor (optional)
synopsis (optional)
String Synopsis about the rule format: string
trigger (optional)
variable (optional)
array[rule_schema_variable] Playbook variable configuration
vector (optional)
rule-properties (optional)

rule_schema_argument - Up

argument-name
String Name of the argument. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
mandatory (optional)
array[null] Flag to indicate a mandatory attribute

rule_schema_constant - Up

value
String Value for the constant format: string

rule_schema_field - Up

constant (optional)
description (optional)
String Description about this field format: string
field-name
String Name of the field. Should be of pattern [a-z][a-zA-Z0-9_-]* format: string
formula (optional)
reference (optional)
sensor (optional)
type (optional)
Enum:
string
integer
float

rule_schema_formula - Up

count (optional)
dynamic-threshold (optional)
max (optional)
mean (optional)
microburst (optional)
min (optional)
outlier-detection (optional)
predict (optional)
stddev (optional)
user-defined-function (optional)

rule_schema_formula_1 - Up

and (optional)
or (optional)
unique (optional)
unless (optional)

rule_schema_formula_1_and - Up

AND(intersection) operation between two vectors. Resultant vector is a set with elements common in both vectors
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string

rule_schema_formula_1_or - Up

OR(union) operation between two vectors. Resultant vector is a set with elements from both the vectors
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string

rule_schema_formula_1_unique - Up

Create a vector with unique elements from another vector
vector-name
String Vector name in which unique elements needs to be computed. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string

rule_schema_formula_1_unless - Up

UNLESS(difference) operation between vectors. Resultant vector is a set with elements in left-vector but not in right-vector
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string

rule_schema_formula_count - Up

Find number of occurances
field-name
String Field name on which count operation needs to be performed format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_formula_dynamicthreshold - Up

Apply dynamic threshold. Learn dynamic threshold value over period of time and apply it on value
algorithm
String Algorithm used to learn the dynamic threshold value
Enum:
3sigma
k-means
field-name
String Field name on which dynamic threshold needs to be applied format: string
learning-period
String Learning period to learn the dynamic threshold. Should be of pattern [1-9][0-9]*(seconds|months|hours|days|weeks|years|s|m|h|d|w|y) format: string
pattern-periodicity
String Pattern periodicity format: string

rule_schema_formula_max - Up

Find the max value
field-name
String Field name on which max operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_formula_mean - Up

Find the mean value
field-name
String Field name on which mean operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_formula_microburst - Up

Detect microbursts in the egress queues. This has to be used only with qmon sensors
if-name
String Interface name. This should be field name where interface names are being stored format: string
packets
String Queue egress packets. This should be field name where queue egress packets are being stored format: string
percentage
String Queue buffer occupancy percentage. This should be field name where queue buffer occupancy percentage are being stored format: string
queue-no
String Queue numbers. This should be field name where queue numbers are being stored format: string

rule_schema_formula_min - Up

Find the min value
field-name
String Field name on which min operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_formula_outlierdetection - Up

Apply outlier detection.
algorithm (optional)
dataset
String Variable containing the list of XPATHs to the data format: string

rule_schema_formula_outlierdetection_algorithm - Up

dbscan (optional)
k-fold-3sigma (optional)

rule_schema_formula_outlierdetection_algorithm_dbscan - Up

learning-period
String Time period on which to detect outliers format: string
sensitivity (optional)

rule_schema_formula_outlierdetection_algorithm_dbscan_sensitivity - Up

Sensitivity to outliers: high sensitivity detects more outliers
absolute-percentage (optional)
Double Absolute percentage of members that are to be marked as outliers format: double
level (optional)
String Fuzzy level of outliers to be detected
Enum:
low
medium
high

rule_schema_formula_outlierdetection_algorithm_kfold3sigma - Up

learning-period
String Time period on which to detect outliers format: string
sensitivity (optional)
sigma-coefficient (optional)
Double Number of standard deviations past which outliers are marked format: double

rule_schema_formula_predict - Up

Learn baseline threshold based on the ML alogrithms and predict value in future
algorithm
String Algorithm used to create baseline thresholds
Enum:
median-prediction
field-name
String Field name on which ML algorithm needs to be applied format: string
learning-period
String Learning period to learn the baseline threshold. Should be of pattern [1-9][0-9]*(seconds|months|hours|days|weeks|years|s|m|h|d|w|y) format: string
pattern-periodicity
String Pattern periodicity format: string
prediction-offset
String Time offset in future to predict. Should be of pattern [1-9][0-9]*[smhdwy] format: string

rule_schema_formula_stddev - Up

Find the standard deviation
field-name
String Field name on which standard deviation operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_formula_userdefinedfunction - Up

User defined function to populate field value
argument (optional)
function-name
String Function name

rule_schema_formula_userdefinedfunction_argument - Up

argument
String Argument name
value
String Argument value format: string

rule_schema_function - Up

argument (optional)
description (optional)
String Description of the function format: string
function-name
String Name of the function. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
method
String Function to be called format: string
path
String File in which function is defined. This is relative path to the data directory format: string

rule_schema_iAgent - Up

args (optional)
file
String File where table and views are defined format: string
frequency
String Frequency at which the iagent should execute the commands and extract the data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
table
String Table which needs to be used to extract the data format: string
target (optional)
String To run command on FPC, specifiy FPC target (optional) format: string

rule_schema_iAgent_args - Up

arg-name
String name of argument format: string
arg-value (optional)
String value of argument format: string

rule_schema_nativegpb - Up

port
Integer Port on which the native sensors will be received format: int32
sensor-name
String Sensor to subscribe format: string

rule_schema_openconfig - Up

frequency
String Sensor subscription duration. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s. A frequency of zero should be used only in case of events subscription format: string
sensor-name
String Sensor to subscribe format: string

rule_schema_reference - Up

data-if-missing (optional)
String Assign given default value for field in case of data missing format: string
path
String Reference to a field or trigger in different rule. Format is /topic[topic-name=]/rule[rule-name=]/field[]/ for field reference and /topic[topic-name=]/rule[rule-name=]/trigger[trigger-name=]/key[condition]/trigger_field for trigger reference. Filtering part where field and key are mentioned is optional format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_ruleproperties - Up

author (optional)
String E-mail address of the rule writer format: string
catalogue (optional)
contributor (optional)
Enum:
juniper
external
date (optional)
String format: string
helper-files (optional)
supported-devices (optional)
supported-healthbot-version (optional)
String Healthbot version in which is rule is supported format: string
version (optional)
Integer Rule version, an integer value needs to be incremented for any major change format: int32
apply-macro (optional)

rule_schema_ruleproperties_catalogue - Up

Metadata to classify the rules
tier (optional)
Enum:
1
2
3

rule_schema_ruleproperties_helperfiles - Up

file-type
Enum:
schema
mib
other
list-of-files
array[String] format: string

rule_schema_ruleproperties_supporteddevices - Up

juniper (optional)
other-vendor (optional)

rule_schema_ruleproperties_supporteddevices_juniper - Up

operating-system (optional)

rule_schema_ruleproperties_supporteddevices_juniper_operatingsystem - Up

os-name
Enum:
junos
junosEvolved
products (optional)

rule_schema_ruleproperties_supporteddevices_juniper_products - Up

product-name
String Product name format: string
releases (optional)

rule_schema_ruleproperties_supporteddevices_juniper_releases - Up

platform (optional)
array[String] format: string
release-name
String Release name format: string
release-support (optional)
String Specifies the min/max support for this release
Enum:
max-supported-release
only-on-this-release
min-supported-release

rule_schema_ruleproperties_supporteddevices_othervendor - Up

apply-macro (optional)
operating-system (optional)
String Vendor operating system format: string
vendor-identifier
String Unique key to idendify the other vendor specifc products format: string
vendor-name
String Vendor-name format: string

rule_schema_sensor - Up

data-if-missing (optional)
String Assign given default value for field in case of data missing. Zero-suppression take priority over data-if-missing format: string
path
String Sensor path format: string
sensor-name
String Name of the sensor
where (optional)
array[rule_schema_where] List of where clauses to filter ingest data
zero-suppression (optional)
array[null] Assign zero as default value for field in case of zero-suppression

rule_schema_sensor_1 - Up

description (optional)
String Description about the sensor format: string
iAgent (optional)
native-gpb (optional)
open-config (optional)
sensor-name
String Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
snmp (optional)
synopsis (optional)
String Synopsis about the sensor format: string

rule_schema_snmp - Up

frequency
String Frequency at which data needs to be extracted from given SNMP table. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
table
String OID of an SNMP table format: string

rule_schema_term - Up

term-name
String Term name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
then (optional)
when (optional)

rule_schema_then - Up

next (optional)
array[null] Continue evaluating next term in a trigger
status (optional)
user-defined-action (optional)

rule_schema_then_argument - Up

argument
String Argument name
value
String Argument value format: string

rule_schema_then_status - Up

color
String Color that needs to be shown in the health tree format: string
Enum:
green
yellow
red
message (optional)
String Descriotion that needs to be show in the health tree format: string

rule_schema_then_userdefinedaction - Up

argument (optional)
function-name
String Function name

rule_schema_trigger - Up

description (optional)
String Description about the trigger format: string
frequency (optional)
String Frequency or time interval at which the trigger needs to be evaluated. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
synopsis (optional)
String Synopsis about the trigger format: string
term
trigger-name
String Trigger name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

rule_schema_variable - Up

description (optional)
String Description about the variable format: string
name
String Variable name used in the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
type
String Type of value supported. This information will be used by UI to display options available for the values
Enum:
int
float
string
boolean
device-group
device
sensor-argument
value (optional)
String Default value for the variable format: string

rule_schema_vector - Up

formula (optional)
path (optional)
array[String] format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
vector-name
String Name of the vector. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

rule_schema_when - Up

does-not-match-with (optional)
equal-to (optional)
exists (optional)
greater-than (optional)
greater-than-or-equal-to (optional)
increasing-at-least-by-rate (optional)
array[rule_schema_when_increasingatleastbyrate] Rate of increase between successive values is at least given rate
increasing-at-least-by-value (optional)
array[rule_schema_when_increasingatleastbyvalue] Increase between successive values is at least given value
increasing-at-most-by-rate (optional)
array[rule_schema_when_increasingatleastbyrate] Rate of increase between successive values is at most given rate
increasing-at-most-by-value (optional)
array[rule_schema_when_increasingatleastbyvalue] Increase between successive values is at most given value
less-than (optional)
less-than-or-equal-to (optional)
matches-with (optional)
max-rate-of-increase (optional)
min-rate-of-increase (optional)
not-equal-to (optional)
range (optional)
user-defined-function (optional)

rule_schema_when_doesnotmatchwith - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
ignore-case (optional)
array[null] Flag to ignore case while matching the string
left-operand
String Left operand. This is the string in which we have to match the expression. format: string
right-operand
String Right operand. This is the match expression. format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_when_equalto - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
left-operand
String Left operand format: string
right-operand
String right operand format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_when_exists - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name which needs to be present format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_when_increasingatleastbyrate - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
per
String Time unit part of rate
Enum:
second
minute
hour
day
week
month
year
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
value (optional)
String Value part of rate. This can be a float or field name from this rule and should match the pattern (\d+(.\d{0,2})?)|($[a-z][a-zA-Z0-9_-]*) format: string
percentage (optional)
String Percentage of change from previous value. This can be a float or field name from this rule and should match the pattern (\d+(.\d{0,2})?)|($[a-z][a-zA-Z0-9_-]*) format: string

rule_schema_when_increasingatleastbyvalue - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
value (optional)
String Value of increase between current and last reported values format: string

rule_schema_when_maxrateofincrease - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name on which rate should be compared format: string
rate (optional)
String Rate format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_when_range - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name on which range should be applied format: string
max
Double Maximum value in the range format: double
min
Double Minumum value in the range format: double
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_when_userdefinedfunction - Up

all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
argument (optional)
function-name
String Function name
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string

rule_schema_where - Up

query
String Query to filter ingest data format: string

scheduler_schema - Up

end-time (optional)
String End scheduler at this time format: string
name
String Name of the scheduler format: string
repeat
start-time
String Start scheduler at this time format: string

scheduler_schema_repeat - Up

Control when to repeat scheduling
every (optional)
String Repeat every
Enum:
week
day
month
year
interval (optional)
never (optional)
array[null] Never repeat scheduling

scheduler_schema_repeat_interval - Up

Regular interval repetition
days (optional)
Integer format: int32
hours (optional)
Integer format: int32
minutes (optional)
Integer format: int32

schedulers_schema - Up

scheduler (optional)

serviceStatus - Up

Property key is service-name

system-settings_schema - Up

system-settings (optional)

systemsettings_schema_systemsettings - Up

persist-raw-data (optional)
array[null] Persist raw data in the database
report-generation (optional)
scheduler (optional)

systemsettings_schema_systemsettings_reportgeneration - Up

destination (optional)
report (optional)

table_schema - Up

name
String Name of the table
type
Enum:
Prediction table
Rule evaluation table
Field table
Sensor table
db_name (optional)
String Database name in which the measurement is present.

time-range-mandatory - Up

time-range
String How much back in time should we look for data

topic_schema - Up

description (optional)
String Description about this topic format: string
rule (optional)
sub-topics (optional)
synopsis (optional)
String Short description about this topic format: string
topic-name
String Name of the topic. Should be of pattern [a-z][a-z-](.{1}[a-z0-9-]+) format: string

topics_schema - Up

topic

when-lhs-rhs-group - Up

left-operand (optional)
String Left operand
right-operand (optional)
String right operand
time-range (optional)
String How much back in time should we look for data