Healthbot APIs

API interface for Healthbot application
More information: https://www.juniper.net/documentation/product/en_US/healthbot
Contact Info: healthbot-feedback@juniper.net
Version: 3.1.0
BasePath:/api/v2
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Administration

Authentication

Configuration

Datastore

Debug

Default

Documentation

Facts

Instanceschedulestate

License

Logs

Organization

Services

System

Administration

Up
post /group/
Create groups (createGroups)
Create group in the system

Consumes

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

Request body

groups groups (required)
Body Parameter — group details

Request headers

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 associated_group_schema

Up
post /user/
Create an user. (createUsers)
Create users in the system

Consumes

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

Request body

users user_schema (required)
Body Parameter — List of users

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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 /group/{groupid}/
Delete groups (deleteGroup)
Delete the groups

Path parameters

groupid (required)
Path Parameter — Id of group

Consumes

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

Request headers

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 /user/{userid}/
Delete list of users. (deleteUser)
Delete list of users from system, for administrative purpose

Path parameters

userid (required)
Path Parameter — Id of user

Consumes

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

Request headers

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
put /group/
Flush the groups (flushGroups)
Flush the existing groups and create new set of groups

Consumes

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

Request body

groups groups (required)
Body Parameter — Group data

Request headers

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 associated_group_schema

Up
put /user/
Flush user base with new set of records. (flushUsers)
Flush the user base with new records

Consumes

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

Request body

users user_schema (required)
Body Parameter — User details

Request headers

Return type

array[inline_response_200_3]

Example data

Content-Type: application/json
[ {
  "userName" : "aeiou",
  "userId" : "aeiou"
} ]

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
get /group/{groupid}/
Get lits of all the groups (getGroupDetails)
Get list of registered groups, for administrative purpose

Path parameters

groupid (required)
Path Parameter — Id of group

Consumes

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

Request headers

Return type

inline_response_200_8

Example data

Content-Type: application/json
{
  "groupName" : "aeiou",
  "groupDescription" : "aeiou",
  "groupId" : "aeiou",
  "roles" : "",
  "users" : ""
}

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 inline_response_200_8

400

Internal Error

Up
get /user/{userid}/
Get lits of all the users (getUserDetails)
Get details of registered users, for administrative purpose

Path parameters

userid (required)
Path Parameter — Id of user

Consumes

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

Request headers

Return type

inline_response_200_4

Example data

Content-Type: application/json
{
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "active" : true,
  "groups" : "",
  "userName" : "aeiou",
  "userId" : "aeiou",
  "email" : "aeiou"
}

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 inline_response_200_4

400

Internal Error

Up
get /group/
Get lits of all the groups (retrieveGroups)
Get list of registered groups, for administrative purpose

Consumes

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

Request headers

Return type

array[inline_response_200_8]

Example data

Content-Type: application/json
[ {
  "groupName" : "aeiou",
  "groupDescription" : "aeiou",
  "groupId" : "aeiou",
  "roles" : "",
  "users" : ""
} ]

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
get /role/
Get list of all the roles (retrieveRoles)
Get list of registered roles, for administrative purpose

Consumes

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

Request headers

Return type

role_schema

Example data

Content-Type: application/json
""

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 role_schema

400

Internal Error

Up
get /user/
Get lits of all the users (retrieveUsers)
Get list of registered users, for administrative purpose

Consumes

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

Request headers

Return type

array[inline_response_200_2]

Example data

Content-Type: application/json
[ {
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "active" : true,
  "userName" : "aeiou",
  "userId" : "aeiou",
  "email" : "aeiou"
} ]

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 /group/{groupid}/
Get lits of all the roles (updateGroup)
Update group

Path parameters

groupid (required)
Path Parameter — Id of group

Consumes

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

Request body

group group (required)
Body Parameter — group details

Request headers

Return type

inline_response_200_9

Example data

Content-Type: application/json
{
  "groupName" : "aeiou",
  "groupId" : "aeiou"
}

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 inline_response_200_9

400

Internal Error

Up
post /user/{userid}/
Update user profile informations. (updateUserProfile)
Update a user profile in the system

Path parameters

userid (required)
Path Parameter — Id of user

Consumes

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

Request body

user user (required)
Body Parameter — user details

Request headers

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

Authentication

Up
post /token/
Re-issue tokens from existing token (refreshToken)
Re-issue tokens from existing token

Consumes

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

Request body

token token (required)
Body Parameter — Token object

Return type

inline_response_200_7

Example data

Content-Type: application/json
{
  "accessToken" : "aeiou",
  "refreshToken" : "aeiou"
}

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 inline_response_200_7

400

Internal Error

Up
post /login/
User login (userLogin)
User login and recive tokens

Consumes

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

Request body

credential credential (required)
Body Parameter — topics body object

Return type

inline_response_200_6

Example data

Content-Type: application/json
{
  "tokenExpires" : "aeiou",
  "refreshTokenExpires" : "aeiou",
  "firstLogin" : true,
  "accessToken" : "aeiou",
  "refreshToken" : "aeiou"
}

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 inline_response_200_6

400

Internal Error

Up
post /logout/
User logout (userLogout)
User logout

Consumes

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

Request body

refreshToken refreshToken (required)
Body Parameter — request 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

Configuration

Up
post /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/organizations/
Update or create multiple organizations. (createHealthbotOrganizationsOrganizations)
Create/Update multiple organizations. The new content for the existing organizations updates the existing content and the new organizations are created.

Consumes

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

Request body

organizations organizations_schema (required)
Body Parameter — organizations body object

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/system/report-generation/destination/{name}/
Create destination by name (createIcebergSystemDestinationById)
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 — Name of destination

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

Request headers

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 /config/system/report-generation/destinations/
Create destinations by name (createIcebergSystemDestinations)
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

Request headers

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 /config/system/report-generation/report/{name}/
Create report by name (createIcebergSystemReportById)
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 — Name of report

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

Request headers

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 /config/system/report-generation/reports/
Create reports by name (createIcebergSystemReports)
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

Request headers

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 /config/system/scheduler/{name}/
Create scheduler by name (createIcebergSystemSchedulerById)
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 — Name of Scheduler

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

Request headers

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 /config/system/schedulers/
Create schedulers by name (createIcebergSystemSchedulers)
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

Request headers

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 /config/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 — Name of destination

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

Request headers

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 /config/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

Request headers

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 /config/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 — Name of report

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

Request headers

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 /config/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

Request headers

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 /config/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 — Name of Scheduler

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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/system/
Create system (createIcebergSystemSystemById)
Create/Update system to populate persist-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

Request headers

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/ingest/byoi/ingest-mappings/
Delete all ingest-mappings. (deleteHealthbotIngestByoiIngestMappings)
Delete all ingest-mappings.

Consumes

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

Request headers

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 /config/ingest-settings/byoi/ingest-mappings/
Delete all ingest-mappings. (deleteHealthbotIngestSettingsByoiIngestMappings)
Delete all ingest-mappings.

Consumes

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

Request headers

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 /config/organizations/
Delete all organizations. (deleteHealthbotOrganizationsOrganizations)
Delete all organizations. This will fail if any organization edge is referenced in any device-group.

Consumes

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

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/system/report-generation/destination/{name}/
Delete destination by name (deleteIcebergSystemDestinationById)
Delete a destination by name. Delete will fail if the destination is being referenced by a report.

Path parameters

name (required)
Path Parameter — Name of destination

Consumes

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

Request headers

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 /config/system/report-generation/destinations/
Delete destinations by name (deleteIcebergSystemDestinations)
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:

Request headers

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 /config/system/report-generation/report/{name}/
Delete report by name (deleteIcebergSystemReportById)
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 — Name of report

Consumes

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

Request headers

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 /config/system/report-generation/reports/
Delete reports by name (deleteIcebergSystemReports)
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:

Request headers

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 /config/system/scheduler/{name}/
Delete scheduler by name (deleteIcebergSystemSchedulerById)
Delete a scheduler by name. Delete will fail if the scheduler is being referenced by a report.

Path parameters

name (required)
Path Parameter — Name of Scheduler

Consumes

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

Request headers

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 /config/system/schedulers/
Delete schedulers by name (deleteIcebergSystemSchedulers)
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:

Request headers

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 /config/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 — Name of destination

Consumes

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

Request headers

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 /config/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:

Request headers

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 /config/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 — Name of report

Consumes

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

Request headers

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 /config/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:

Request headers

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 /config/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 — Name of Scheduler

Consumes

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

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/system/
Delete system (deleteIcebergSystemSystemById)
Delete system. 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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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
post /first-login/
Change password after first login (firstLogin)
Change password in first login

Consumes

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

Request body

password password (required)
Body Parameter — set new password

Request headers

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 /config/initialize/
Initialize config-server (initialize)
Initialize config-server

Consumes

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

Request headers

Query parameters

restart_groups (optional)
Query Parameter — Boolean variable is set to true if group services have to be restarted. Defaults to true. default: true
reload_rules (optional)
Query Parameter — Boolean variable is set to true if default rules have to reloaded. Defaults to true. default: true
reload_playbooks (optional)
Query Parameter — Boolean variable is set to true if default playbooks have to be reloaded. Defaults to true. default: true
reload_syslog_patterns (optional)
Query Parameter — Boolean variable is set to true if syslog patterns have to be reloaded. Defaults to true. default: true
reload_syslog_pattern_sets (optional)
Query Parameter — Boolean variable is set to true if syslog pattern sets have to be reloaded. Defaults to true. default: true
reload_flow_templates (optional)
Query Parameter — Boolean variable is set to true if flow templates have to be reloaded. Defaults to true. default: true
reload_sflow_schema (optional)
Query Parameter — Boolean variable is set to true if sflow schema has to be reloaded. Defaults to true. 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

default

unexpected error Error

Up
get /config/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:

Request headers

Return type

affected-groups

Example data

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

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:

Request headers

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-group/{device_group_name}/trigger_info/
Get device-group's trigger info. (retrieveDeviceGroupTriggerInfo)
Get information about the triggers in a device-group.

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:

Request headers

Return type

trigger_schema

Example data

Content-Type: application/json
{
  "triggers" : [ {
    "name" : "aeiou",
    "fields" : [ "aeiou" ]
  } ]
}

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

Trigger info for a device group. trigger_schema

default

unexpected error Error

Up
get /config/organizations/
Get all organizations' configuration. (retrieveHealthbotOrganizationsOrganizations)
Get the configuration details of all organizations.

Consumes

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

Request headers

Query parameters

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

Return type

organizations_schema

Example data

Content-Type: application/json
{
  "organization" : [ {
    "site" : [ {
      "edge" : [ {
        "edge-name" : "aeiou",
        "description" : "aeiou",
        "edge-id" : "aeiou"
      } ],
      "site-name" : "aeiou",
      "description" : "aeiou"
    } ],
    "description" : "aeiou",
    "organization-name" : "aeiou"
  } ]
}

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 organizations_schema

400

Internal Error

Up
get /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

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

Return type

device_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "initial-sync" : true,
    "gnmi" : {
      "enable" : true,
      "encoding" : "protobuf"
    },
    "port" : 39501
  },
  "outbound-ssh" : {
    "disable" : true
  },
  "timezone" : "aeiou",
  "description" : "aeiou",
  "snmp" : {
    "port" : 9607,
    "v2" : {
      "community" : "aeiou"
    }
  },
  "syslog" : {
    "source-ip-addresses" : [ "aeiou" ],
    "hostnames" : [ "aeiou" ]
  },
  "device-id" : "aeiou",
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "iAgent" : {
    "port" : 5249
  },
  "system-id" : "aeiou",
  "vendor" : {
    "arista" : {
      "operating-system" : "eos"
    },
    "linux" : {
      "operating-system" : "aeiou"
    },
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    },
    "other-vendor" : {
      "operating-system" : "aeiou",
      "vendor-name" : "aeiou"
    },
    "paloalto" : {
      "operating-system" : "panos"
    }
  },
  "host" : "aeiou",
  "variable" : [ {
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "flow" : {
    "source-ip-addresses" : [ "aeiou" ]
  },
  "authentication" : {
    "password" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "ssh" : {
      "ssh-key-profile" : "aeiou",
      "username" : "aeiou"
    },
    "ssl" : {
      "ca-profile" : "aeiou",
      "server-common-name" : "aeiou",
      "local-certificate" : "aeiou"
    }
  },
  "tagging-profile" : [ "aeiou" ]
}

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

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

Return type

device-group_schema

Example data

Content-Type: application/json
{
  "open-config" : {
    "initial-sync" : true,
    "gnmi" : {
      "enable" : true,
      "encoding" : "protobuf"
    }
  },
  "reports" : [ "aeiou" ],
  "devices" : [ "aeiou" ],
  "outbound-ssh" : {
    "ports" : [ 5 ]
  },
  "timezone" : "aeiou",
  "ingest-frequency" : [ "aeiou" ],
  "description" : "aeiou",
  "playbooks" : [ "aeiou" ],
  "syslog" : {
    "ports" : [ 36944 ]
  },
  "scheduler" : [ {
    "schedule" : "aeiou",
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "playbook" : "aeiou"
  } ],
  "notification" : {
    "normal" : [ "aeiou" ],
    "major" : [ "aeiou" ],
    "minor" : [ "aeiou" ],
    "enable" : [ "{}" ],
    "no-initial-normal-notify-suppression" : true
  },
  "edge" : "aeiou",
  "raw-data" : {
    "summarize" : {
      "summarization-profile" : [ "aeiou" ],
      "time-span" : "aeiou"
    },
    "persist" : "{}"
  },
  "device-group-name" : "aeiou",
  "native-gpb" : {
    "ports" : [ 0 ]
  },
  "publish" : {
    "field" : [ "aeiou" ],
    "destination" : [ "aeiou" ],
    "sensor" : [ "aeiou" ]
  },
  "variable" : [ {
    "running-state" : "running",
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "logging" : {
    "open-config" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "sflow" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "snmp" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "syslog" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "iAgent" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "non-sensor-rules" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "reports-generation" : {
      "log-level" : "error"
    },
    "trigger-evaluation" : {
      "log-level" : "error"
    },
    "log-level" : "error",
    "native-gpb" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "ML-model-builder" : {
      "log-level" : "error"
    },
    "flow" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "byoi" : {
      "service" : [ {
        "log-level" : "error",
        "daemons" : [ "ingest" ],
        "name" : "aeiou"
      } ]
    }
  },
  "flow" : {
    "netflow" : {
      "ports" : [ 6 ]
    },
    "sflow" : {
      "ports" : [ 1 ]
    },
    "deploy-nodes" : [ "aeiou" ]
  },
  "retention-policy" : "aeiou",
  "authentication" : {
    "password" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "ssh" : {
      "ssh-key-profile" : "aeiou",
      "username" : "aeiou"
    },
    "ssl" : {
      "ca-profile" : "aeiou",
      "server-common-name" : "aeiou",
      "local-certificate" : "aeiou"
    }
  },
  "tagging-profile" : [ "aeiou" ]
}

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 /config/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:

Request headers

Query parameters

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

Return type

device-groups_schema

Example data

Content-Type: application/json
{
  "device-group" : [ {
    "open-config" : {
      "initial-sync" : true,
      "gnmi" : {
        "enable" : true,
        "encoding" : "protobuf"
      }
    },
    "reports" : [ "aeiou" ],
    "devices" : [ "aeiou" ],
    "outbound-ssh" : {
      "ports" : [ 5 ]
    },
    "timezone" : "aeiou",
    "ingest-frequency" : [ "aeiou" ],
    "description" : "aeiou",
    "playbooks" : [ "aeiou" ],
    "syslog" : {
      "ports" : [ 36944 ]
    },
    "scheduler" : [ {
      "schedule" : "aeiou",
      "instance-id" : "aeiou",
      "rule" : "aeiou",
      "playbook" : "aeiou"
    } ],
    "notification" : {
      "normal" : [ "aeiou" ],
      "major" : [ "aeiou" ],
      "minor" : [ "aeiou" ],
      "enable" : [ "{}" ],
      "no-initial-normal-notify-suppression" : true
    },
    "edge" : "aeiou",
    "raw-data" : {
      "summarize" : {
        "summarization-profile" : [ "aeiou" ],
        "time-span" : "aeiou"
      },
      "persist" : "{}"
    },
    "device-group-name" : "aeiou",
    "native-gpb" : {
      "ports" : [ 0 ]
    },
    "publish" : {
      "field" : [ "aeiou" ],
      "destination" : [ "aeiou" ],
      "sensor" : [ "aeiou" ]
    },
    "variable" : [ {
      "running-state" : "running",
      "instance-id" : "aeiou",
      "rule" : "aeiou",
      "variable-value" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "playbook" : "aeiou"
    } ],
    "logging" : {
      "open-config" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "sflow" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "snmp" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "syslog" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "iAgent" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "non-sensor-rules" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "reports-generation" : {
        "log-level" : "error"
      },
      "trigger-evaluation" : {
        "log-level" : "error"
      },
      "log-level" : "error",
      "native-gpb" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "ML-model-builder" : {
        "log-level" : "error"
      },
      "flow" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "byoi" : {
        "service" : [ {
          "log-level" : "error",
          "daemons" : [ "ingest" ],
          "name" : "aeiou"
        } ]
      }
    },
    "flow" : {
      "netflow" : {
        "ports" : [ 6 ]
      },
      "sflow" : {
        "ports" : [ 1 ]
      },
      "deploy-nodes" : [ "aeiou" ]
    },
    "retention-policy" : "aeiou",
    "authentication" : {
      "password" : {
        "password" : "aeiou",
        "username" : "aeiou"
      },
      "ssh" : {
        "ssh-key-profile" : "aeiou",
        "username" : "aeiou"
      },
      "ssl" : {
        "ca-profile" : "aeiou",
        "server-common-name" : "aeiou",
        "local-certificate" : "aeiou"
      }
    },
    "tagging-profile" : [ "aeiou" ]
  } ]
}

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 /config/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:

Request headers

Query parameters

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

Return type

devices_schema

Example data

Content-Type: application/json
{
  "device" : [ {
    "open-config" : {
      "initial-sync" : true,
      "gnmi" : {
        "enable" : true,
        "encoding" : "protobuf"
      },
      "port" : 39501
    },
    "outbound-ssh" : {
      "disable" : true
    },
    "timezone" : "aeiou",
    "description" : "aeiou",
    "snmp" : {
      "port" : 9607,
      "v2" : {
        "community" : "aeiou"
      }
    },
    "syslog" : {
      "source-ip-addresses" : [ "aeiou" ],
      "hostnames" : [ "aeiou" ]
    },
    "device-id" : "aeiou",
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "iAgent" : {
      "port" : 5249
    },
    "system-id" : "aeiou",
    "vendor" : {
      "arista" : {
        "operating-system" : "eos"
      },
      "linux" : {
        "operating-system" : "aeiou"
      },
      "juniper" : {
        "operating-system" : "junos"
      },
      "cisco" : {
        "operating-system" : "iosxr"
      },
      "other-vendor" : {
        "operating-system" : "aeiou",
        "vendor-name" : "aeiou"
      },
      "paloalto" : {
        "operating-system" : "panos"
      }
    },
    "host" : "aeiou",
    "variable" : [ {
      "instance-id" : "aeiou",
      "rule" : "aeiou",
      "variable-value" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "playbook" : "aeiou"
    } ],
    "flow" : {
      "source-ip-addresses" : [ "aeiou" ]
    },
    "authentication" : {
      "password" : {
        "password" : "aeiou",
        "username" : "aeiou"
      },
      "ssh" : {
        "ssh-key-profile" : "aeiou",
        "username" : "aeiou"
      },
      "ssl" : {
        "ca-profile" : "aeiou",
        "server-common-name" : "aeiou",
        "local-certificate" : "aeiou"
      }
    },
    "tagging-profile" : [ "aeiou" ]
  } ]
}

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

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

Return type

network-group_schema

Example data

Content-Type: application/json
{
  "scheduler" : [ {
    "schedule" : "aeiou",
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "playbook" : "aeiou"
  } ],
  "reports" : [ "aeiou" ],
  "notification" : {
    "normal" : [ "aeiou" ],
    "major" : [ "aeiou" ],
    "minor" : [ "aeiou" ],
    "enable" : [ "{}" ]
  },
  "ingest-frequency" : [ "aeiou" ],
  "network-group-name" : "aeiou",
  "publish" : {
    "field" : [ "aeiou" ],
    "destination" : [ "aeiou" ]
  },
  "variable" : [ {
    "running-state" : "running",
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "description" : "aeiou",
  "logging" : {
    "trigger-evaluation" : {
      "log-level" : "error"
    },
    "log-level" : "error",
    "non-sensor-rules" : {
      "log-level" : "error",
      "daemons" : [ "ingest" ]
    },
    "reports-generation" : {
      "log-level" : "error"
    },
    "ML-model-builder" : {
      "log-level" : "error"
    }
  },
  "playbooks" : [ "aeiou" ],
  "tagging-profile" : [ "aeiou" ]
}

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 /config/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:

Request headers

Query parameters

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

Return type

network-groups_schema

Example data

Content-Type: application/json
{
  "network-group" : [ {
    "scheduler" : [ {
      "schedule" : "aeiou",
      "instance-id" : "aeiou",
      "rule" : "aeiou",
      "playbook" : "aeiou"
    } ],
    "reports" : [ "aeiou" ],
    "notification" : {
      "normal" : [ "aeiou" ],
      "major" : [ "aeiou" ],
      "minor" : [ "aeiou" ],
      "enable" : [ "{}" ]
    },
    "ingest-frequency" : [ "aeiou" ],
    "network-group-name" : "aeiou",
    "publish" : {
      "field" : [ "aeiou" ],
      "destination" : [ "aeiou" ]
    },
    "variable" : [ {
      "running-state" : "running",
      "instance-id" : "aeiou",
      "rule" : "aeiou",
      "variable-value" : [ {
        "name" : "aeiou",
        "value" : "aeiou"
      } ],
      "playbook" : "aeiou"
    } ],
    "description" : "aeiou",
    "logging" : {
      "trigger-evaluation" : {
        "log-level" : "error"
      },
      "log-level" : "error",
      "non-sensor-rules" : {
        "log-level" : "error",
        "daemons" : [ "ingest" ]
      },
      "reports-generation" : {
        "log-level" : "error"
      },
      "ML-model-builder" : {
        "log-level" : "error"
      }
    },
    "playbooks" : [ "aeiou" ],
    "tagging-profile" : [ "aeiou" ]
  } ]
}

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 /config/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:

Request headers

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 /config/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:

Request headers

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" : "aeiou",
      "username" : "aeiou"
    },
    "url" : "aeiou"
  },
  "emails" : {
    "filter" : {
      "rules" : [ "aeiou" ]
    },
    "ids" : [ "aeiou" ]
  },
  "microsoft-teams" : {
    "channel" : "aeiou"
  },
  "notification-name" : "aeiou",
  "slack" : {
    "channel" : "aeiou",
    "url" : "aeiou"
  },
  "kafka-publish" : {
    "sasl" : {
      "password" : "aeiou",
      "certificate" : "aeiou",
      "username" : "aeiou"
    },
    "use-hash-partitioner" : true,
    "bootstrap-servers" : [ "aeiou" ],
    "topic" : "aeiou"
  },
  "description" : "aeiou"
}

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 /config/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:

Request headers

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" : "aeiou",
        "username" : "aeiou"
      },
      "url" : "aeiou"
    },
    "emails" : {
      "filter" : {
        "rules" : [ "aeiou" ]
      },
      "ids" : [ "aeiou" ]
    },
    "microsoft-teams" : {
      "channel" : "aeiou"
    },
    "notification-name" : "aeiou",
    "slack" : {
      "channel" : "aeiou",
      "url" : "aeiou"
    },
    "kafka-publish" : {
      "sasl" : {
        "password" : "aeiou",
        "certificate" : "aeiou",
        "username" : "aeiou"
      },
      "use-hash-partitioner" : true,
      "bootstrap-servers" : [ "aeiou" ],
      "topic" : "aeiou"
    },
    "description" : "aeiou"
  } ]
}

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
download (optional)
Query Parameter — Download as compressed .playbook file

Return type

playbook_schema

Example data

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

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 /config/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:

Request headers

Query parameters

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

Return type

playbooks_schema

Example data

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

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 /config/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:

Request headers

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" : "aeiou",
    "replication" : 0,
    "retention-policy-name" : "aeiou"
  } ]
}

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

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

Return type

retention-policy_schema

Example data

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

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 /config/system/report-generation/destination/{name}/
Retrieve destination by name (retrieveIcebergSystemDestinationById)
Get the configuration details of a destination by its name.

Path parameters

name (required)
Path Parameter — Name of destination

Consumes

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

Request headers

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" : "aeiou",
  "email" : {
    "id" : "aeiou"
  }
}

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 /config/system/report-generation/destinations/
Retrieve destinations by name (retrieveIcebergSystemDestinations)
Get the configuration details of all destinations.

Consumes

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

Request headers

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" : "aeiou",
    "email" : {
      "id" : "aeiou"
    }
  } ]
}

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 /config/system/report-generation/report/{name}/
Retrieve report by name (retrieveIcebergSystemReportById)
Get the configuration details of a report by its name.

Path parameters

name (required)
Path Parameter — Name of report

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

report_schema

Example data

Content-Type: application/json
{
  "schedule" : [ "aeiou" ],
  "capture-fields" : [ "aeiou" ],
  "graph-canvas" : [ {
    "name" : "aeiou",
    "canvas-panel" : [ {
      "name" : "aeiou"
    } ]
  } ],
  "destination" : [ "aeiou" ],
  "format" : "json",
  "name" : "aeiou"
}

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 /config/system/report-generation/reports/
Retrieve reports by name (retrieveIcebergSystemReports)
Get the configuration details of all reports.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

reports_schema

Example data

Content-Type: application/json
{
  "report" : [ {
    "schedule" : [ "aeiou" ],
    "capture-fields" : [ "aeiou" ],
    "graph-canvas" : [ {
      "name" : "aeiou",
      "canvas-panel" : [ {
        "name" : "aeiou"
      } ]
    } ],
    "destination" : [ "aeiou" ],
    "format" : "json",
    "name" : "aeiou"
  } ]
}

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 /config/system/scheduler/{name}/
Retrieve scheduler by name (retrieveIcebergSystemSchedulerById)
Get the configuration details of a scheduler by its name.

Path parameters

name (required)
Path Parameter — Name of Scheduler

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

scheduler_schema

Example data

Content-Type: application/json
{
  "start-time" : "aeiou",
  "end-time" : "aeiou",
  "run-for" : {
    "hours" : 36944,
    "minutes" : 15087,
    "days" : 39073
  },
  "repeat" : {
    "never" : [ "{}" ],
    "interval" : {
      "hours" : 39501,
      "minutes" : 9607,
      "days" : 5249
    },
    "every" : "week"
  },
  "name" : "aeiou",
  "type" : "continuous"
}

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 /config/system/schedulers/
Retrieve schedulers by name (retrieveIcebergSystemSchedulers)
Get the configuration details of all schedulers.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

schedulers_schema

Example data

Content-Type: application/json
{
  "scheduler" : [ {
    "start-time" : "aeiou",
    "end-time" : "aeiou",
    "run-for" : {
      "hours" : 36944,
      "minutes" : 15087,
      "days" : 39073
    },
    "repeat" : {
      "never" : [ "{}" ],
      "interval" : {
        "hours" : 39501,
        "minutes" : 9607,
        "days" : 5249
      },
      "every" : "week"
    },
    "name" : "aeiou",
    "type" : "continuous"
  } ]
}

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 /config/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 — Name of destination

Consumes

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

Request headers

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" : "aeiou",
  "email" : {
    "id" : "aeiou"
  }
}

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 /config/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:

Request headers

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" : "aeiou",
    "email" : {
      "id" : "aeiou"
    }
  } ]
}

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 /config/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 — Name of report

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

report_schema

Example data

Content-Type: application/json
{
  "schedule" : [ "aeiou" ],
  "capture-fields" : [ "aeiou" ],
  "graph-canvas" : [ {
    "name" : "aeiou",
    "canvas-panel" : [ {
      "name" : "aeiou"
    } ]
  } ],
  "destination" : [ "aeiou" ],
  "format" : "json",
  "name" : "aeiou"
}

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 /config/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:

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

reports_schema

Example data

Content-Type: application/json
{
  "report" : [ {
    "schedule" : [ "aeiou" ],
    "capture-fields" : [ "aeiou" ],
    "graph-canvas" : [ {
      "name" : "aeiou",
      "canvas-panel" : [ {
        "name" : "aeiou"
      } ]
    } ],
    "destination" : [ "aeiou" ],
    "format" : "json",
    "name" : "aeiou"
  } ]
}

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 /config/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 — Name of Scheduler

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

scheduler_schema

Example data

Content-Type: application/json
{
  "start-time" : "aeiou",
  "end-time" : "aeiou",
  "run-for" : {
    "hours" : 36944,
    "minutes" : 15087,
    "days" : 39073
  },
  "repeat" : {
    "never" : [ "{}" ],
    "interval" : {
      "hours" : 39501,
      "minutes" : 9607,
      "days" : 5249
    },
    "every" : "week"
  },
  "name" : "aeiou",
  "type" : "continuous"
}

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 /config/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:

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

schedulers_schema

Example data

Content-Type: application/json
{
  "scheduler" : [ {
    "start-time" : "aeiou",
    "end-time" : "aeiou",
    "run-for" : {
      "hours" : 36944,
      "minutes" : 15087,
      "days" : 39073
    },
    "repeat" : {
      "never" : [ "{}" ],
      "interval" : {
        "hours" : 39501,
        "minutes" : 9607,
        "days" : 5249
      },
      "every" : "week"
    },
    "name" : "aeiou",
    "type" : "continuous"
  } ]
}

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 /config/system-settings/
Retrieve system-settings (retrieveIcebergSystemSettingsSystemSettings)
Retrieve system-settings

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

system-settings_schema

Example data

Content-Type: application/json
{ }

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 /config/system/
Retrieve system data (retrieveIcebergSystemSystem)
Retrieve system details

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

system-settings_schema

Example data

Content-Type: application/json
{ }

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
download (optional)
Query Parameter — Download a compressed .rule file

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 /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

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

Return type

topic_schema

Example data

Content-Type: application/json
{
  "sub-topics" : [ "aeiou" ],
  "description" : "aeiou",
  "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" : ".*"
    } ]
  } ],
  "synopsis" : "aeiou",
  "topic-name" : "aeiou"
}

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 /config/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:

Request headers

Query parameters

working (optional)
Query Parameter — true queries un-committed configuration
sort (optional)
Query Parameter — asc/desc queries sorted configuration

Return type

topics_schema

Example data

Content-Type: application/json
{
  "topic" : [ {
    "sub-topics" : [ "aeiou" ],
    "description" : "aeiou",
    "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" : ".*"
      } ]
    } ],
    "synopsis" : "aeiou",
    "topic-name" : "aeiou"
  } ]
}

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:

Request headers

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
get /network-group/{network_group_name}/trigger_info/
Get network-group's trigger info. (retrieveNetworkGroupTriggerInfo)
Get information about the triggers in a device-group.

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:

Request headers

Return type

trigger_schema

Example data

Content-Type: application/json
{
  "triggers" : [ {
    "name" : "aeiou",
    "fields" : [ "aeiou" ]
  } ]
}

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

Trigger info for a network group. trigger_schema

default

unexpected error Error

Up
get /orchestrator/
Get Orchestrator type (retrieveOrchestrator)
Get orchestrator type. Will be one of kubernetes or compose.

Consumes

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

Request headers

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 /config/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:

Request headers

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 /config/organizations/
Overwrite organizations. (updateHealthbotOrganizationsOrganizations)
Overwrite the existing organizations configuration. New organizations are created and existing organizations are overwritten with new content. If some of the existing organizations are not present in the payload, such organizations are deleted. This will fail if any of the organization edges 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

organizations organizations_schema (required)
Body Parameter — organizations body object

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/system/report-generation/destination/{name}/
Update destination by name (updateIcebergSystemDestinationById)
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 — Name of destination

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

Request headers

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 /config/system/report-generation/destinations/
Update destinations by name (updateIcebergSystemDestinations)
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

Request headers

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 /config/system/report-generation/report/{name}/
Update report by name (updateIcebergSystemReportById)
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 — Name of report

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

Request headers

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 /config/system/report-generation/reports/
Update reports by name (updateIcebergSystemReports)
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

Request headers

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 /config/system/scheduler/{name}/
Update scheduler by name (updateIcebergSystemSchedulerById)
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 — Name of Scheduler

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

Request headers

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 /config/system/schedulers/
Update schedulers by name (updateIcebergSystemSchedulers)
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

Request headers

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 /config/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 — Name of destination

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

Request headers

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 /config/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

Request headers

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 /config/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 — Name of report

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

Request headers

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 /config/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

Request headers

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 /config/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 — Name of Scheduler

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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/system/
Update system by ID (updateIcebergSystemSystemById)
New endpoint to over-write 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_settings body object

Request headers

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/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

Request headers

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 /config/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

Request headers

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 /config/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

Request headers

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
get /user-profile/
Get users profile information (userRetrieveUserProfile)
Get user profile

Consumes

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

Request headers

Return type

inline_response_200_5

Example data

Content-Type: application/json
{
  "firstName" : "aeiou",
  "lastName" : "aeiou",
  "userName" : "aeiou",
  "userId" : "aeiou",
  "email" : "aeiou"
}

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 inline_response_200_5

400

Internal Error

Up
post /user-profile/
Update user profile informations. (userUpdateUserProfile)
Update user profile in the system

Consumes

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

Request body

user user_1 (required)
Body Parameter — topics body object

Request headers

Return type

array[inline_response_200_3]

Example data

Content-Type: application/json
[ {
  "userName" : "aeiou",
  "userId" : "aeiou"
} ]

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
post /config/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

Request headers

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

Up
delete /config/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:

Request headers

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 /config/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:

Request headers

Query parameters

key (optional)
Query Parameter — Key of data_store object

Return type

datastore_schema

Example data

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

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 /config/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

Request headers

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

Debug

Up
post /debug/configuration/
Request Healthbot MGD service to generate the debug related configuration for healthbot debugger to consume. (healthbotDebugGenerateConfiguration)
Request Healthbot MGD service to generate the debug related configuration for healthbot debugger to consume.

Consumes

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

Request headers

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

Up
post /debug/scenario/{scenario_name}/
Run debugging for the given scenario name (retrieveDebugForScenario)
Run debugging for the given scenario name

Path parameters

scenario_name (required)
Path Parameter — Scenario name

Consumes

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

Request body

debug_arguments debug-arguments_schema (optional)
Body Parameter — Debug arguments object

Request headers

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

202

Successful operation

default

Unexpected error Error

Default

Up
get /config/files/helper-files/backup/
Download the tar file containing all helper files. (backupHelperFiles)
Download helper files tar file, which will include the config and input directory.

Consumes

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

Request headers

Return type

File

Example data

Content-Type:

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

default

unexpected error Error

Up
post /config/files/certificates/{file_name}/
Upload a certificate file. (createFilesCertificatesByFileName)
Upload the specified certificate-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:

Request headers

Query parameters

password (optional)
Query Parameter — password
certificate_type (optional)
Query Parameter — Certificate type

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
post /config/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:

Request headers

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
post /config/ingest/byoi/custom-plugin/{name}/
Create custom-plugin by ID (createHealthbotIngestByoiCustomPluginById)
Create operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request body

custom_plugin custom-plugin_schema (required)
Body Parameter — custom_pluginbody object

Request headers

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 /config/ingest/byoi/default-plugin/tlive-kafka-oc/{name}/
Create tlive-kafka-oc by ID (createHealthbotIngestByoiDefaultPluginTliveKafkaById)
Add/Merge a tlive-kafka-oc configuration.

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request body

tlive_kafka tlive-kafka-oc_schema (required)
Body Parameter — tlive_kafkabody object

Request headers

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 /config/ingest/byoi/ingest-mapping/{name}/
Create ingest-mapping by ID (createHealthbotIngestByoiIngestMappingById)
Create ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request body

ingest_mapping ingest-mapping_schema (required)
Body Parameter — ingest_mappingbody object

Request headers

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 /config/ingest/frequency-profile/{name}/
Create frequency-profile by ID (createHealthbotIngestFrequencyProfileById)
Create operation of resource: frequency-profile

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

frequency_profile frequency-profile_schema (required)
Body Parameter — frequency_profilebody object

Request headers

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 /config/ingest-settings/byoi/custom-plugin/{name}/
Create custom-plugin by ID (createHealthbotIngestSettingsByoiCustomPluginById)
Create operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request body

custom_plugin custom-plugin_schema (required)
Body Parameter — custom_pluginbody object

Request headers

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 /config/ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/
Create tlive-kafka-oc by ID (createHealthbotIngestSettingsByoiDefaultPluginTliveKafkaById)
Add/Merge a tlive-kafka-oc configuration.

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request body

tlive_kafka tlive-kafka-oc_schema (required)
Body Parameter — tlive_kafkabody object

Request headers

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 /config/ingest-settings/byoi/ingest-mapping/{name}/
Create ingest-mapping by ID (createHealthbotIngestSettingsByoiIngestMappingById)
Create ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request body

ingest_mapping ingest-mapping_schema (required)
Body Parameter — ingest_mappingbody object

Request headers

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 /config/ingest-settings/frequency-profile/{name}/
Create frequency-profile by ID (createHealthbotIngestSettingsFrequencyProfileById)
Create operation of resource: frequency-profile

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

frequency_profile frequency-profile_schema (required)
Body Parameter — frequency_profilebody object

Request headers

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 /config/ingest-settings/data-enrichment/tagging-profile/{name}/
Create tagging-profile by ID (createHealthbotIngestSettingsTaggingProfileById)
Create operation of resource: tagging-profile

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

tagging_profile tagging-profile_schema (required)
Body Parameter — tagging_profilebody object

Request headers

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 /config/ingest-settings/data-enrichment/tagging-profiles/
Create tagging-profile by ID (createHealthbotIngestSettingsTaggingProfiles)
Create operation of resource: tagging-profile

Consumes

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

Request body

tagging_profile tagging-profiles_schema (required)
Body Parameter — tagging_profilebody object

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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 /config/ingest/sflow/
Create sflow by ID (createHealthbotIngestSflow)
Create operation of resource: sflow

Consumes

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

Request body

sflow sflow_schema (required)
Body Parameter — sflowbody object

Request headers

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 /config/ingest/sflow/counter-record/{record_name}/
Create counter-record by ID (createHealthbotIngestSflowCounterRecordById)
Create operation of resource: counter-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request body

counter_record counter-record_schema (required)
Body Parameter — counter_recordbody object

Request headers

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 /config/ingest/sflow/flow-record/{record_name}/
Create flow-record by ID (createHealthbotIngestSflowFlowRecordById)
Create operation of resource: flow-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request body

flow_record flow-record_schema (required)
Body Parameter — flow_recordbody object

Request headers

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 /config/ingest/sflow/protocol/{protocol_name}/
Create protocol by ID (createHealthbotIngestSflowProtocolById)
Create operation of resource: protocol

Path parameters

protocol_name (required)
Path Parameter — ID of protocol-name

Consumes

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

Request body

protocol protocol_schema (required)
Body Parameter — protocolbody object

Request headers

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 /config/ingest/sflow/sample/{sample_name}/
Create sample by ID (createHealthbotIngestSflowSampleById)
Create operation of resource: sample

Path parameters

sample_name (required)
Path Parameter — ID of sample-name

Consumes

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

Request body

sample sample_schema (required)
Body Parameter — samplebody object

Request headers

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 /config/ingest/data-enrichment/tagging-profile/{name}/
Create tagging-profile by ID (createHealthbotIngestTaggingProfileById)
Create operation of resource: tagging-profile

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

tagging_profile tagging-profile_schema (required)
Body Parameter — tagging_profilebody object

Request headers

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 /config/ingest/data-enrichment/tagging-profiles/
Create tagging-profile by ID (createHealthbotIngestTaggingProfiles)
Create operation of resource: tagging-profile

Consumes

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

Request body

tagging_profile tagging-profiles_schema (required)
Body Parameter — tagging_profilebody object

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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 /config/organization/{organization_name}/
Create organization by ID (createHealthbotOrganizationOrganizationById)
Create operation of resource: organization

Path parameters

organization_name (required)
Path Parameter — ID of organization-name

Consumes

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

Request body

organization organization_schema (required)
Body Parameter — organizationbody object

Request headers

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 /config/system/tsdb/
Create time-series-database by ID (createHealthbotSystemTimeSeriesDatabaseTimeSeriesDatabaseById)
Create operation of resource: time-series-database

Consumes

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

Request body

time_series_database tsdb_schema (required)
Body Parameter — time_series_databasebody object

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/ingest/
Create ingest by ID (createIcebergIngest)
Create operation of resource: ingest

Consumes

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

Request body

ingest_settings ingest-settings_schema (required)
Body Parameter — ingest_settingsbody object

Request headers

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 /config/ingest/flow/
Create flow by ID (createIcebergIngestFlow)
Create operation of resource: flow

Consumes

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

Request body

flow flow_schema (required)
Body Parameter — flowbody object

Request headers

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 /config/ingest/flow/template/{name}/
Create template by ID (createIcebergIngestFlowTemplateById)
Create operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request body

template template_schema (required)
Body Parameter — templatebody object

Request headers

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 /config/ingest/native-gpb/
Create native-gpb by ID (createIcebergIngestNativeGpb)
Create operation of resource: native-gpb

Consumes

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

Request body

native_gpb native-gpb_schema (required)
Body Parameter — native_gpbbody object

Request headers

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 /config/ingest-settings/
Create ingest-settings by ID (createIcebergIngestSettings)
Create operation of resource: ingest-settings

Consumes

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

Request body

ingest_settings ingest-settings_schema (required)
Body Parameter — ingest_settingsbody object

Request headers

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 /config/ingest-settings/flow/
Create flow by ID (createIcebergIngestSettingsFlow)
Create operation of resource: flow

Consumes

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

Request body

flow flow_schema (required)
Body Parameter — flowbody object

Request headers

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 /config/ingest-settings/flow/template/{name}/
Create template by ID (createIcebergIngestSettingsFlowTemplateById)
Create operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request body

template template_schema (required)
Body Parameter — templatebody object

Request headers

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 /config/ingest-settings/syslog/
Create syslog by ID (createIcebergIngestSettingsSyslog)
Create operation of resource: syslog

Consumes

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

Request body

syslog syslog_schema (required)
Body Parameter — syslogbody object

Request headers

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 /config/ingest-settings/syslog/pattern/{name}/
Create pattern by ID (createIcebergIngestSettingsSyslogPatternById)
Create operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request body

pattern pattern_schema (required)
Body Parameter — patternbody object

Request headers

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 /config/ingest-settings/syslog/pattern-set/{name}/
Create pattern-set by ID (createIcebergIngestSettingsSyslogPatternSetById)
Create operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request body

pattern_set pattern-set_schema (required)
Body Parameter — pattern_setbody object

Request headers

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 /config/ingest/syslog/
Create syslog by ID (createIcebergIngestSyslog)
Create operation of resource: syslog

Consumes

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

Request body

syslog syslog_schema (required)
Body Parameter — syslogbody object

Request headers

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 /config/ingest/syslog/pattern/{name}/
Create pattern by ID (createIcebergIngestSyslogPatternById)
Create operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request body

pattern pattern_schema (required)
Body Parameter — patternbody object

Request headers

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 /config/ingest/syslog/pattern-set/{name}/
Create pattern-set by ID (createIcebergIngestSyslogPatternSetById)
Create operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request body

pattern_set pattern-set_schema (required)
Body Parameter — pattern_setbody object

Request headers

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 /config/profile/data-summarization/raw/{name}/
Create raw-data-summarization by ID (createIcebergProfileDataSummarizationRawById)
Create operation of resource: raw-data-summarization

Path parameters

name (required)
Path Parameter — Name of raw-data-summarization

Consumes

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

Request body

raw_data_summarization raw_schema (required)
Body Parameter — raw_data_summarizationbody object

Request headers

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 /config/profile/security/ca-profile/{name}/
Create ca-profile by ID (createIcebergProfileSecurityCaProfileById)
Create operation of resource: ca-profile

Path parameters

name (required)
Path Parameter — Name of ca-profile

Consumes

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

Request body

ca_profile ca-profile_schema (required)
Body Parameter — ca_profilebody object

Request headers

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 /config/profile/security/local-certificate/{name}/
Create local-certificate by ID (createIcebergProfileSecurityLocalCertificateById)
Create operation of resource: local-certificate

Path parameters

name (required)
Path Parameter — Name of local-certificate

Consumes

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

Request body

local_certificate local-certificate_schema (required)
Body Parameter — local_certificatebody object

Request headers

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 /config/profile/security/ssh-key-profile/{name}/
Create ssh-key-profile by ID (createIcebergProfileSecuritySshKeyProfileById)
Create operation of resource: ssh-key-profile

Path parameters

name (required)
Path Parameter — Name of ssh-key-profile

Consumes

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

Request body

ssh_key_profile ssh-key-profile_schema (required)
Body Parameter — ssh_key_profilebody object

Request headers

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 /config/profiles/
Create profile by ID (createIcebergProfiles)
Create entire profile configuration.

Consumes

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

Request body

profile profiles_schema (required)
Body Parameter — profilebody object

Request headers

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 /config/files/certificates/{file_name}/
Delete a certificate-file. (deleteFilesCertificatesByFileName)
Delete the specified certificate-file. Delete will not fail if the certificate-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:

Request headers

Query parameters

input_path (optional)
Query Parameter — Input path
certificate_type (optional)
Query Parameter — Certificate type

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 /config/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:

Request headers

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
delete /config/ingest/byoi/custom-plugin/{name}/
Delete custom-plugin by ID (deleteHealthbotIngestByoiCustomPluginById)
Delete operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request headers

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 /config/ingest/byoi/default-plugin/tlive-kafka-oc/{name}/
Delete tlive-kafka-oc by ID (deleteHealthbotIngestByoiDefaultPluginTliveKafkaById)
Delete operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request headers

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 /config/ingest/byoi/ingest-mapping/{name}/
Delete ingest-mapping by ID (deleteHealthbotIngestByoiIngestMappingById)
Delete ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request headers

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 /config/ingest/frequency-profile/{name}/
Delete frequency-profile by ID (deleteHealthbotIngestFrequencyProfileById)
Delete operation of resource: frequency-profile

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 headers

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 /config/ingest-settings/byoi/custom-plugin/{name}/
Delete custom-plugin by ID (deleteHealthbotIngestSettingsByoiCustomPluginById)
Delete operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request headers

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 /config/ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/
Delete tlive-kafka-oc by ID (deleteHealthbotIngestSettingsByoiDefaultPluginTliveKafkaById)
Delete operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request headers

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 /config/ingest-settings/byoi/ingest-mapping/{name}/
Delete ingest-mapping by ID (deleteHealthbotIngestSettingsByoiIngestMappingById)
Delete ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request headers

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 /config/ingest-settings/frequency-profile/{name}/
Delete frequency-profile by ID (deleteHealthbotIngestSettingsFrequencyProfileById)
Delete operation of resource: frequency-profile

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 headers

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 /config/ingest-settings/data-enrichment/tagging-profile/{name}/
Delete tagging-profile by ID (deleteHealthbotIngestSettingsTaggingProfileById)
Delete operation of resource: tagging-profile

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 headers

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 /config/ingest-settings/data-enrichment/tagging-profiles/
Delete tagging-profile by ID (deleteHealthbotIngestSettingsTaggingProfiles)
Delete operation of resource: tagging-profile

Consumes

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

Request headers

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 /config/ingest/sflow/
Delete sflow by ID (deleteHealthbotIngestSflow)
Delete operation of resource: sflow

Consumes

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

Request headers

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 /config/ingest/sflow/counter-record/{record_name}/
Delete counter-record by ID (deleteHealthbotIngestSflowCounterRecordById)
Delete operation of resource: counter-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request headers

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 /config/ingest/sflow/flow-record/{record_name}/
Delete flow-record by ID (deleteHealthbotIngestSflowFlowRecordById)
Delete operation of resource: flow-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request headers

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 /config/ingest/sflow/protocol/{protocol_name}/
Delete protocol by ID (deleteHealthbotIngestSflowProtocolById)
Delete operation of resource: protocol

Path parameters

protocol_name (required)
Path Parameter — ID of protocol-name

Consumes

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

Request headers

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 /config/ingest/sflow/sample/{sample_name}/
Delete sample by ID (deleteHealthbotIngestSflowSampleById)
Delete operation of resource: sample

Path parameters

sample_name (required)
Path Parameter — ID of sample-name

Consumes

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

Request headers

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 /config/ingest/data-enrichment/tagging-profile/{name}/
Delete tagging-profile by ID (deleteHealthbotIngestTaggingProfileById)
Delete operation of resource: tagging-profile

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 headers

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 /config/ingest/data-enrichment/tagging-profiles/
Delete tagging-profile by ID (deleteHealthbotIngestTaggingProfiles)
Delete operation of resource: tagging-profile

Consumes

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

Request headers

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 /config/organization/{organization_name}/
Delete organization by ID (deleteHealthbotOrganizationOrganizationById)
Delete operation of resource: organization

Path parameters

organization_name (required)
Path Parameter — ID of organization-name

Consumes

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

Request headers

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 /config/system/tsdb/
Delete time-series-database (deleteHealthbotSystemTimeSeriesDatabaseTimeSeriesDatabaseById)
Delete operation of resource: time-series-database

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 /config/ingest/
Delete ingest by ID (deleteIcebergIngest)
Delete operation of resource: ingest

Consumes

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

Request headers

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 /config/ingest/flow/
Delete flow by ID (deleteIcebergIngestFlow)
Delete operation of resource: flow

Consumes

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

Request headers

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 /config/ingest/flow/template/{name}/
Delete template by ID (deleteIcebergIngestFlowTemplateById)
Delete operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request headers

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 /config/ingest/native-gpb/
Delete native-gpb by ID (deleteIcebergIngestNativeGpb)
Delete operation of resource: native-gpb

Consumes

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

Request headers

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 /config/ingest-settings/
Delete ingest-settings by ID (deleteIcebergIngestSettings)
Delete operation of resource: ingest-settings

Consumes

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

Request headers

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 /config/ingest-settings/flow/
Delete flow by ID (deleteIcebergIngestSettingsFlow)
Delete operation of resource: flow

Consumes

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

Request headers

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 /config/ingest-settings/flow/template/{name}/
Delete template by ID (deleteIcebergIngestSettingsFlowTemplateById)
Delete operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request headers

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 /config/ingest-settings/syslog/
Delete syslog by ID (deleteIcebergIngestSettingsSyslog)
Delete operation of resource: syslog

Consumes

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

Request headers

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 /config/ingest-settings/syslog/pattern/{name}/
Delete pattern by ID (deleteIcebergIngestSettingsSyslogPatternById)
Delete operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request headers

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 /config/ingest-settings/syslog/pattern-set/{name}/
Delete pattern-set by ID (deleteIcebergIngestSettingsSyslogPatternSetById)
Delete operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request headers

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 /config/ingest/syslog/
Delete syslog by ID (deleteIcebergIngestSyslog)
Delete operation of resource: syslog

Consumes

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

Request headers

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 /config/ingest/syslog/pattern/{name}/
Delete pattern by ID (deleteIcebergIngestSyslogPatternById)
Delete operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request headers

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 /config/ingest/syslog/pattern-set/{name}/
Delete pattern-set by ID (deleteIcebergIngestSyslogPatternSetById)
Delete operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request headers

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 /config/profile/data-summarization/raw/{name}/
Delete raw-data-summarization by ID (deleteIcebergProfileDataSummarizationRawById)
Delete operation of resource: raw data-summarization

Path parameters

name (required)
Path Parameter — Name of raw-data-summarization

Consumes

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

Request headers

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 /config/profile/security/ca-profile/{name}/
Delete ca-profile by ID (deleteIcebergProfileSecurityCaProfileById)
Delete operation of resource: ca-profile

Path parameters

name (required)
Path Parameter — Name of ca-profile

Consumes

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

Request headers

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 /config/profile/security/local-certificate/{name}/
Delete local-certificate by ID (deleteIcebergProfileSecurityLocalCertificateById)
Delete operation of resource: local-certificate

Path parameters

name (required)
Path Parameter — Name of local-certificate

Consumes

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

Request headers

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 /config/profile/security/ssh-key-profile/{name}/
Delete ssh-key-profile by ID (deleteIcebergProfileSecuritySshKeyProfileById)
Delete operation of resource: ssh-key-profile

Path parameters

name (required)
Path Parameter — Name of ssh-key-profile

Consumes

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

Request headers

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 /config/profiles/
Delete profile by ID (deleteIcebergProfiles)
Delete entire profile configuration.

Consumes

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

Request headers

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 /field-capture/
Get last value of all fields before a given timestamp. (getFieldsFromXpath)
Get the values of all fields

Consumes

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

Query parameters

xpath (required)
Query Parameter — XPATH
timestamp (optional)
Query Parameter — Timestamp

Return type

field-capture_schema

Example data

Content-Type: application/json
{ }

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 field-capture_schema

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

Request headers

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 /config/files/helper-files/backup/
Upload a helper-file. (restoreHelperFiles)
Upload tar file of helper-files

Consumes

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

Request headers

Form parameters

restore_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
get /config/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:

Request headers

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" : "aeiou",
  "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:

Request headers

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" : "aeiou",
  "name" : "aeiou",
  "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:

Request headers

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:

Request headers

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 /debug/jobs/
(retrieveDebugJobs)
Return the status of the last "/debug/" job

Consumes

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

Request headers

Query parameters

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

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 /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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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:

Request headers

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
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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 /events/
Get all events. (retrieveEvents)
Get the list of all events. 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:

Request headers

Query parameters

from_timestamp (required)
Query Parameter — Starting timestamp format: date-time
to_timestamp (optional)
Query Parameter — Ending timestamp format: date-time
color (optional)
Query Parameter — Color of events.

Return type

array[event]

Example data

Content-Type: application/json
[ {
  "color" : "yellow",
  "event_name" : "aeiou",
  "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 /config/files/certificates/{file_name}/
Download a certificate-file. (retrieveFilesCertificatesByFileName)
Download the specified certificate-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:

Request headers

Query parameters

input_path (optional)
Query Parameter — Input path
certificate_type (optional)
Query Parameter — Certificate type

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 /config/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:

Request headers

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 /config/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:

Request headers

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:

Request headers

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:

Request headers

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:

Request headers

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:

Request headers

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 /config/ingest/byoi/custom-plugin/{name}/
Retrieve custom-plugin by ID (retrieveHealthbotIngestByoiCustomPluginById)
Retrieve operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

custom-plugin_schema

Example data

Content-Type: application/json
{
  "service-name" : "aeiou",
  "security-parameters" : {
    "user-authentication" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "name" : "aeiou",
  "parameters" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "plugin-name" : "aeiou"
}

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 custom-plugin_schema

400

Internal Error

Up
get /config/ingest/byoi/custom-plugins/
Retrieve custom-plugin by ID (retrieveHealthbotIngestByoiCustomPlugins)
Retrieve all the custom-plugins configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

custom-plugin_schema

Example data

Content-Type: application/json
{
  "service-name" : "aeiou",
  "security-parameters" : {
    "user-authentication" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "name" : "aeiou",
  "parameters" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "plugin-name" : "aeiou"
}

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 custom-plugin_schema

400

Internal Error

Up
get /config/ingest/byoi/default-plugin/tlive-kafka-oc/{name}/
Retrieve tlive-kafka-oc by ID (retrieveHealthbotIngestByoiDefaultPluginTliveKafkaById)
Retrieve operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

tlive-kafka-oc_schema

Example data

Content-Type: application/json
{
  "security" : {
    "sasl" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "brokers" : [ "aeiou" ],
  "topics" : [ "aeiou" ],
  "name" : "aeiou",
  "collector-settings" : "{}"
}

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 tlive-kafka-oc_schema

400

Internal Error

Up
get /config/ingest/byoi/default-plugin/tlive-kafka-ocs/
Retrieve tlive-kafka-oc (retrieveHealthbotIngestByoiDefaultPluginTliveKafkas)
Retrieve all the tlive-kafka-ocs configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/byoi/ingest-mapping/{name}/
Retrieve ingest-mapping by ID (retrieveHealthbotIngestByoiIngestMappingById)
Retrieve ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ingest-mapping_schema

Example data

Content-Type: application/json
{
  "open-config" : "",
  "netflow" : "",
  "native-gpb" : "",
  "name" : "aeiou",
  "snmp" : "",
  "syslog" : "",
  "iAgent" : {
    "for-device-groups" : [ "aeiou" ],
    "use-plugin" : {
      "instance" : "aeiou",
      "name" : "aeiou",
      "type" : "default-plugin"
    }
  }
}

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 ingest-mapping_schema

400

Internal Error

Up
get /config/ingest/byoi/ingest-mappings/
Retrieve ingest-mapping (retrieveHealthbotIngestByoiIngestMappings)
Retrieve all the ingest mappings configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/frequency-profiles/
Retrieve frequency-profile (retrieveHealthbotIngestFrequencyProfile)
Retrieve operation of resource: frequency-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/frequency-profile/{name}/
Retrieve frequency-profile by ID (retrieveHealthbotIngestFrequencyProfileById)
Retrieve operation of resource: frequency-profile

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 headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

frequency-profile_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "sensor" : [ {
    "sensor-name" : "aeiou",
    "frequency" : "aeiou"
  } ],
  "non-sensor" : [ {
    "rule-name" : "aeiou",
    "frequency" : "aeiou"
  } ]
}

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 frequency-profile_schema

400

Internal Error

Up
get /config/ingest-settings/byoi/custom-plugin/{name}/
Retrieve custom-plugin by ID (retrieveHealthbotIngestSettingsByoiCustomPluginById)
Retrieve operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

custom-plugin_schema

Example data

Content-Type: application/json
{
  "service-name" : "aeiou",
  "security-parameters" : {
    "user-authentication" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "name" : "aeiou",
  "parameters" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "plugin-name" : "aeiou"
}

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 custom-plugin_schema

400

Internal Error

Up
get /config/ingest-settings/byoi/custom-plugins/
Retrieve custom-plugin by ID (retrieveHealthbotIngestSettingsByoiCustomPlugins)
Retrieve all the custom-plugins configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

custom-plugin_schema

Example data

Content-Type: application/json
{
  "service-name" : "aeiou",
  "security-parameters" : {
    "user-authentication" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "name" : "aeiou",
  "parameters" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "plugin-name" : "aeiou"
}

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 custom-plugin_schema

400

Internal Error

Up
get /config/ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/
Retrieve tlive-kafka-oc by ID (retrieveHealthbotIngestSettingsByoiDefaultPluginTliveKafkaById)
Retrieve operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

tlive-kafka-oc_schema

Example data

Content-Type: application/json
{
  "security" : {
    "sasl" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "tls" : {
      "local-certificate-profile" : "aeiou",
      "ca-profile" : "aeiou",
      "insecure-skip-verify" : true
    }
  },
  "brokers" : [ "aeiou" ],
  "topics" : [ "aeiou" ],
  "name" : "aeiou",
  "collector-settings" : "{}"
}

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 tlive-kafka-oc_schema

400

Internal Error

Up
get /config/ingest-settings/byoi/default-plugin/tlive-kafka-ocs/
Retrieve tlive-kafka-oc (retrieveHealthbotIngestSettingsByoiDefaultPluginTliveKafkas)
Retrieve all the tlive-kafka-ocs configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/byoi/ingest-mapping/{name}/
Retrieve ingest-mapping by ID (retrieveHealthbotIngestSettingsByoiIngestMappingById)
Retrieve ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ingest-mapping_schema

Example data

Content-Type: application/json
{
  "open-config" : "",
  "netflow" : "",
  "native-gpb" : "",
  "name" : "aeiou",
  "snmp" : "",
  "syslog" : "",
  "iAgent" : {
    "for-device-groups" : [ "aeiou" ],
    "use-plugin" : {
      "instance" : "aeiou",
      "name" : "aeiou",
      "type" : "default-plugin"
    }
  }
}

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 ingest-mapping_schema

400

Internal Error

Up
get /config/ingest-settings/byoi/ingest-mappings/
Retrieve ingest-mapping (retrieveHealthbotIngestSettingsByoiIngestMappings)
Retrieve all the ingest mappings configured.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/frequency-profiles/
Retrieve frequency-profile (retrieveHealthbotIngestSettingsFrequencyProfile)
Retrieve operation of resource: frequency-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/frequency-profile/{name}/
Retrieve frequency-profile by ID (retrieveHealthbotIngestSettingsFrequencyProfileById)
Retrieve operation of resource: frequency-profile

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 headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

frequency-profile_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "sensor" : [ {
    "sensor-name" : "aeiou",
    "frequency" : "aeiou"
  } ],
  "non-sensor" : [ {
    "rule-name" : "aeiou",
    "frequency" : "aeiou"
  } ]
}

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 frequency-profile_schema

400

Internal Error

Up
get /config/ingest-settings/data-enrichment/tagging-profile/{name}/
Retrieve tagging-profile by ID (retrieveHealthbotIngestSettingsTaggingProfileById)
Retrieve operation of resource: tagging-profile

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 headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

tagging-profile_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "policy" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "rules" : [ "aeiou" ],
    "term" : [ {
      "term-name" : "aeiou",
      "then" : {
        "next" : [ "{}" ],
        "add-field" : [ {
          "name" : "aeiou",
          "type" : "string",
          "value" : "aeiou"
        } ],
        "add-key" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ]
      },
      "when" : {
        "less-than-or-equal-to" : [ "" ],
        "equal-to" : [ {
          "right-operand" : "aeiou",
          "left-operand" : "aeiou"
        } ],
        "eval" : [ {
          "expression" : "aeiou"
        } ],
        "greater-than-or-equal-to" : [ "" ],
        "does-not-match-with" : [ {
          "right-operand" : "aeiou",
          "left-operand" : "aeiou"
        } ],
        "matches-with" : [ "" ],
        "does-not-match-with-scheduler" : "",
        "less-than" : [ "" ],
        "greater-than" : [ "" ],
        "not-equal-to" : [ "" ],
        "matches-with-scheduler" : {
          "scheduler" : "aeiou",
          "time" : "aeiou"
        }
      }
    } ]
  } ]
}

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 tagging-profile_schema

400

Internal Error

Up
get /config/ingest-settings/data-enrichment/tagging-profiles/
Retrieve tagging-profile by ID (retrieveHealthbotIngestSettingsTaggingProfiles)
Retrieve operation of resource: tagging-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/sflow/
Retrieve sflow (retrieveHealthbotIngestSflow)
Retrieve operation of resource: sflow

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

sflow_schema

Example data

Content-Type: application/json
{
  "sflow" : {
    "flow-record" : [ "" ],
    "protocol" : [ {
      "number" : 5,
      "field" : [ "" ],
      "protocol-name" : "aeiou"
    } ],
    "counter-record" : [ {
      "field" : [ {
        "field-name" : "aeiou",
        "size-based-on-field" : {
          "when-equal" : [ {
            "right-operand" : "aeiou",
            "then" : {
              "size" : "aeiou"
            },
            "left-operand" : "aeiou"
          } ],
          "then" : {
            "size" : "aeiou"
          }
        },
        "export-as" : "tag",
        "size-in-bits" : 6,
        "description" : "aeiou",
        "type" : "number",
        "next-header" : ""
      } ],
      "record-name" : "aeiou",
      "enterprise" : 0,
      "format" : 1
    } ],
    "sample" : [ {
      "record-type" : "flow",
      "sample-name" : "aeiou",
      "field" : [ "" ],
      "enterprise" : 5,
      "format" : 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 sflow_schema

400

Internal Error

Up
get /config/ingest/sflow/counter-record/{record_name}/
Retrieve counter-record by ID (retrieveHealthbotIngestSflowCounterRecordById)
Retrieve operation of resource: counter-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

counter-record_schema

Example data

Content-Type: application/json
{
  "field" : [ {
    "field-name" : "aeiou",
    "size-based-on-field" : {
      "when-equal" : [ {
        "right-operand" : "aeiou",
        "then" : {
          "size" : "aeiou"
        },
        "left-operand" : "aeiou"
      } ],
      "then" : {
        "size" : "aeiou"
      }
    },
    "export-as" : "tag",
    "size-in-bits" : 6,
    "description" : "aeiou",
    "type" : "number",
    "next-header" : ""
  } ],
  "record-name" : "aeiou",
  "enterprise" : 0,
  "format" : 1
}

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 counter-record_schema

400

Internal Error

Up
get /config/ingest/sflow/flow-record/{record_name}/
Retrieve flow-record by ID (retrieveHealthbotIngestSflowFlowRecordById)
Retrieve operation of resource: flow-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

flow-record_schema

Example data

Content-Type: application/json
{
  "field" : [ {
    "field-name" : "aeiou",
    "size-based-on-field" : {
      "when-equal" : [ {
        "right-operand" : "aeiou",
        "then" : {
          "size" : "aeiou"
        },
        "left-operand" : "aeiou"
      } ],
      "then" : {
        "size" : "aeiou"
      }
    },
    "export-as" : "tag",
    "size-in-bits" : 6,
    "description" : "aeiou",
    "type" : "number",
    "next-header" : ""
  } ],
  "record-name" : "aeiou",
  "enterprise" : 0,
  "format" : 1
}

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 flow-record_schema

400

Internal Error

Up
get /config/ingest/sflow/protocol/{protocol_name}/
Retrieve protocol by ID (retrieveHealthbotIngestSflowProtocolById)
Retrieve operation of resource: protocol

Path parameters

protocol_name (required)
Path Parameter — ID of protocol-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

protocol_schema

Example data

Content-Type: application/json
{
  "number" : 6,
  "field" : [ {
    "field-name" : "aeiou",
    "size-based-on-field" : {
      "when-equal" : [ {
        "right-operand" : "aeiou",
        "then" : {
          "size" : "aeiou"
        },
        "left-operand" : "aeiou"
      } ],
      "then" : {
        "size" : "aeiou"
      }
    },
    "export-as" : "tag",
    "size-in-bits" : 0,
    "description" : "aeiou",
    "type" : "number",
    "next-header" : ""
  } ],
  "protocol-name" : "aeiou"
}

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 protocol_schema

400

Internal Error

Up
get /config/ingest/sflow/sample/{sample_name}/
Retrieve sample by ID (retrieveHealthbotIngestSflowSampleById)
Retrieve operation of resource: sample

Path parameters

sample_name (required)
Path Parameter — ID of sample-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

sample_schema

Example data

Content-Type: application/json
{
  "record-type" : "flow",
  "sample-name" : "aeiou",
  "field" : [ {
    "field-name" : "aeiou",
    "size-based-on-field" : {
      "when-equal" : [ {
        "right-operand" : "aeiou",
        "then" : {
          "size" : "aeiou"
        },
        "left-operand" : "aeiou"
      } ],
      "then" : {
        "size" : "aeiou"
      }
    },
    "export-as" : "tag",
    "size-in-bits" : 6,
    "description" : "aeiou",
    "type" : "number",
    "next-header" : ""
  } ],
  "enterprise" : 0,
  "format" : 1
}

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 sample_schema

400

Internal Error

Up
get /config/ingest/data-enrichment/tagging-profile/{name}/
Retrieve tagging-profile by ID (retrieveHealthbotIngestTaggingProfileById)
Retrieve operation of resource: tagging-profile

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 headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

tagging-profile_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "policy" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "rules" : [ "aeiou" ],
    "term" : [ {
      "term-name" : "aeiou",
      "then" : {
        "next" : [ "{}" ],
        "add-field" : [ {
          "name" : "aeiou",
          "type" : "string",
          "value" : "aeiou"
        } ],
        "add-key" : [ {
          "name" : "aeiou",
          "value" : "aeiou"
        } ]
      },
      "when" : {
        "less-than-or-equal-to" : [ "" ],
        "equal-to" : [ {
          "right-operand" : "aeiou",
          "left-operand" : "aeiou"
        } ],
        "eval" : [ {
          "expression" : "aeiou"
        } ],
        "greater-than-or-equal-to" : [ "" ],
        "does-not-match-with" : [ {
          "right-operand" : "aeiou",
          "left-operand" : "aeiou"
        } ],
        "matches-with" : [ "" ],
        "does-not-match-with-scheduler" : "",
        "less-than" : [ "" ],
        "greater-than" : [ "" ],
        "not-equal-to" : [ "" ],
        "matches-with-scheduler" : {
          "scheduler" : "aeiou",
          "time" : "aeiou"
        }
      }
    } ]
  } ]
}

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 tagging-profile_schema

400

Internal Error

Up
get /config/ingest/data-enrichment/tagging-profiles/
Retrieve tagging-profile by ID (retrieveHealthbotIngestTaggingProfiles)
Retrieve operation of resource: tagging-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/organization/
Retrieve organization (retrieveHealthbotOrganizationOrganization)
Retrieve operation of resource: organization

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

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/organization/{organization_name}/
Retrieve organization by ID (retrieveHealthbotOrganizationOrganizationById)
Retrieve operation of resource: organization

Path parameters

organization_name (required)
Path Parameter — ID of organization-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

organization_schema

Example data

Content-Type: application/json
{
  "site" : [ {
    "edge" : [ {
      "edge-name" : "aeiou",
      "description" : "aeiou",
      "edge-id" : "aeiou"
    } ],
    "site-name" : "aeiou",
    "description" : "aeiou"
  } ],
  "description" : "aeiou",
  "organization-name" : "aeiou"
}

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 organization_schema

400

Internal Error

Up
get /config/system/tsdb/
Retrieve time-series-database (retrieveHealthbotSystemTimeSeriesDatabaseTimeSeriesDatabase)
Retrieve operation of resource: time-series-database

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

tsdb_schema

Example data

Content-Type: application/json
{
  "dedicate" : true,
  "nodes" : [ "aeiou" ],
  "replication-factor" : 0
}

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 tsdb_schema

400

Internal Error

Up
get /config/ingest/
Retrieve ingest (retrieveIcebergIngest)
Retrieve operation of resource: ingest

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ingest-settings_schema

Example data

Content-Type: application/json
{ }

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 ingest-settings_schema

400

Internal Error

Up
get /config/ingest/flow/
Retrieve flow (retrieveIcebergIngestFlow)
Retrieve operation of resource: flow

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

flow_schema

Example data

Content-Type: application/json
{
  "flow" : {
    "template" : [ {
      "recognition-pattern" : {
        "exclude-fields" : [ "aeiou" ],
        "include-fields" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "description" : "aeiou",
      "key-fields" : [ "aeiou" ],
      "protocol-version" : "v9",
      "priority" : 0
    } ]
  }
}

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 flow_schema

400

Internal Error

Up
get /config/ingest/flow/template/{name}/
Retrieve template by ID (retrieveIcebergIngestFlowTemplateById)
Retrieve operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

template_schema

Example data

Content-Type: application/json
{
  "recognition-pattern" : {
    "exclude-fields" : [ "aeiou" ],
    "include-fields" : [ "aeiou" ]
  },
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "protocol-version" : "v9",
  "priority" : 0
}

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 template_schema

400

Internal Error

Up
get /config/ingest/flow/template/
Retrieve template (retrieveIcebergIngestFlowTemplateIds)
Retrieve operation of resource: template

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/native-gpb/
Retrieve native-gpb (retrieveIcebergIngestNativeGpb)
Retrieve operation of resource: native-gpb

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

native-gpb_schema

Example data

Content-Type: application/json
{
  "native-gpb" : {
    "port" : 5249
  }
}

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 native-gpb_schema

400

Internal Error

Up
get /config/ingest-settings/
Retrieve ingest-settings (retrieveIcebergIngestSettings)
Retrieve operation of resource: ingest-settings

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ingest-settings_schema

Example data

Content-Type: application/json
{ }

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 ingest-settings_schema

400

Internal Error

Up
get /config/ingest-settings/flow/
Retrieve flow (retrieveIcebergIngestSettingsFlow)
Retrieve operation of resource: flow

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

flow_schema

Example data

Content-Type: application/json
{
  "flow" : {
    "template" : [ {
      "recognition-pattern" : {
        "exclude-fields" : [ "aeiou" ],
        "include-fields" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "description" : "aeiou",
      "key-fields" : [ "aeiou" ],
      "protocol-version" : "v9",
      "priority" : 0
    } ]
  }
}

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 flow_schema

400

Internal Error

Up
get /config/ingest-settings/flow/template/{name}/
Retrieve template by ID (retrieveIcebergIngestSettingsFlowTemplateById)
Retrieve operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

template_schema

Example data

Content-Type: application/json
{
  "recognition-pattern" : {
    "exclude-fields" : [ "aeiou" ],
    "include-fields" : [ "aeiou" ]
  },
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "protocol-version" : "v9",
  "priority" : 0
}

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 template_schema

400

Internal Error

Up
get /config/ingest-settings/flow/template/
Retrieve template (retrieveIcebergIngestSettingsFlowTemplateIds)
Retrieve operation of resource: template

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/syslog/
Retrieve syslog (retrieveIcebergIngestSettingsSyslog)
Retrieve operation of resource: syslog

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

syslog_schema

Example data

Content-Type: application/json
{
  "syslog" : {
    "port" : 0,
    "pattern" : [ {
      "filter" : "aeiou",
      "constant" : [ {
        "name" : "aeiou",
        "description" : "aeiou",
        "type" : "integer",
        "value" : "aeiou"
      } ],
      "field" : [ {
        "name" : "aeiou",
        "description" : "aeiou",
        "from" : "aeiou",
        "type" : "integer"
      } ],
      "name" : "aeiou",
      "description" : "aeiou",
      "key-fields" : [ "aeiou" ],
      "filter-type" : "grok",
      "event-id" : "aeiou"
    } ],
    "pattern-set" : [ {
      "name" : "aeiou",
      "pattern-names" : [ "aeiou" ],
      "description" : "aeiou"
    } ]
  }
}

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 syslog_schema

400

Internal Error

Up
get /config/ingest-settings/syslog/pattern/{name}/
Retrieve pattern by ID (retrieveIcebergIngestSettingsSyslogPatternById)
Retrieve operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

pattern_schema

Example data

Content-Type: application/json
{
  "filter" : "aeiou",
  "constant" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "type" : "integer",
    "value" : "aeiou"
  } ],
  "field" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "from" : "aeiou",
    "type" : "integer"
  } ],
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "filter-type" : "grok",
  "event-id" : "aeiou"
}

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 pattern_schema

400

Internal Error

Up
get /config/ingest-settings/syslog/pattern/
Retrieve pattern (retrieveIcebergIngestSettingsSyslogPatternIds)
Retrieve operation of resource: pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/syslog/pattern-set/{name}/
Retrieve pattern-set by ID (retrieveIcebergIngestSettingsSyslogPatternSetById)
Retrieve operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of patter-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

pattern-set_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "pattern-names" : [ "aeiou" ],
  "description" : "aeiou"
}

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 pattern-set_schema

400

Internal Error

Up
get /config/ingest-settings/syslog/pattern-set/
Retrieve pattern-set (retrieveIcebergIngestSettingsSyslogPatternSetIds)
Retrieve operation of resource: pattern-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest-settings/syslog/pattern-sets/
Retrieve pattern-set by ID (retrieveIcebergIngestSettingsSyslogPatternSets)
Retrieve operation of resource: pattern-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[pattern-set_schema]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "pattern-names" : [ "aeiou" ],
  "description" : "aeiou"
} ]

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
get /config/ingest-settings/syslog/patterns/
Retrieve pattern by ID (retrieveIcebergIngestSettingsSyslogPatterns)
Retrieve operation of resource: pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[pattern_schema]

Example data

Content-Type: application/json
[ {
  "filter" : "aeiou",
  "constant" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "type" : "integer",
    "value" : "aeiou"
  } ],
  "field" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "from" : "aeiou",
    "type" : "integer"
  } ],
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "filter-type" : "grok",
  "event-id" : "aeiou"
} ]

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
get /config/ingest/syslog/
Retrieve syslog (retrieveIcebergIngestSyslog)
Retrieve operation of resource: syslog

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

syslog_schema

Example data

Content-Type: application/json
{
  "syslog" : {
    "port" : 0,
    "pattern" : [ {
      "filter" : "aeiou",
      "constant" : [ {
        "name" : "aeiou",
        "description" : "aeiou",
        "type" : "integer",
        "value" : "aeiou"
      } ],
      "field" : [ {
        "name" : "aeiou",
        "description" : "aeiou",
        "from" : "aeiou",
        "type" : "integer"
      } ],
      "name" : "aeiou",
      "description" : "aeiou",
      "key-fields" : [ "aeiou" ],
      "filter-type" : "grok",
      "event-id" : "aeiou"
    } ],
    "pattern-set" : [ {
      "name" : "aeiou",
      "pattern-names" : [ "aeiou" ],
      "description" : "aeiou"
    } ]
  }
}

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 syslog_schema

400

Internal Error

Up
get /config/ingest/syslog/pattern/{name}/
Retrieve pattern by ID (retrieveIcebergIngestSyslogPatternById)
Retrieve operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

pattern_schema

Example data

Content-Type: application/json
{
  "filter" : "aeiou",
  "constant" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "type" : "integer",
    "value" : "aeiou"
  } ],
  "field" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "from" : "aeiou",
    "type" : "integer"
  } ],
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "filter-type" : "grok",
  "event-id" : "aeiou"
}

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 pattern_schema

400

Internal Error

Up
get /config/ingest/syslog/pattern/
Retrieve pattern (retrieveIcebergIngestSyslogPatternIds)
Retrieve operation of resource: pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/syslog/pattern-set/{name}/
Retrieve pattern-set by ID (retrieveIcebergIngestSyslogPatternSetById)
Retrieve operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

pattern-set_schema

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "pattern-names" : [ "aeiou" ],
  "description" : "aeiou"
}

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 pattern-set_schema

400

Internal Error

Up
get /config/ingest/syslog/pattern-set/
Retrieve pattern-set (retrieveIcebergIngestSyslogPatternSetIds)
Retrieve operation of resource: pattern-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/ingest/syslog/pattern-sets/
Retrieve pattern-set by ID (retrieveIcebergIngestSyslogPatternSets)
Retrieve operation of resource: pattern-set

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[pattern-set_schema]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "pattern-names" : [ "aeiou" ],
  "description" : "aeiou"
} ]

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
get /config/ingest/syslog/patterns/
Retrieve pattern by ID (retrieveIcebergIngestSyslogPatterns)
Retrieve operation of resource: pattern

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[pattern_schema]

Example data

Content-Type: application/json
[ {
  "filter" : "aeiou",
  "constant" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "type" : "integer",
    "value" : "aeiou"
  } ],
  "field" : [ {
    "name" : "aeiou",
    "description" : "aeiou",
    "from" : "aeiou",
    "type" : "integer"
  } ],
  "name" : "aeiou",
  "description" : "aeiou",
  "key-fields" : [ "aeiou" ],
  "filter-type" : "grok",
  "event-id" : "aeiou"
} ]

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
get /config/profile/data-summarization/raw/{name}/
Retrieve raw-data-summarization by ID (retrieveIcebergProfileDataSummarizationRawById)
Retrieve operation of resource: raw-data-summarization

Path parameters

name (required)
Path Parameter — Name of raw-data-summarization

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

raw_schema

Example data

Content-Type: application/json
{
  "path" : [ {
    "name" : "aeiou",
    "aggregation-functions" : [ "latest" ]
  } ],
  "name" : "aeiou",
  "data-type" : [ {
    "name" : "string",
    "aggregation-functions" : [ "latest" ]
  } ]
}

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 raw_schema

400

Internal Error

Up
get /config/profile/data-summarizations/raw/
Retrieve raw-data-summarization (retrieveIcebergProfileDataSummarizationsRaw)
Retrieve operation of resource: raw-data-summarization

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

raw_schema

Example data

Content-Type: application/json
{
  "path" : [ {
    "name" : "aeiou",
    "aggregation-functions" : [ "latest" ]
  } ],
  "name" : "aeiou",
  "data-type" : [ {
    "name" : "string",
    "aggregation-functions" : [ "latest" ]
  } ]
}

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 raw_schema

400

Internal Error

Up
get /config/profile/security/ca-profile/{name}/
Retrieve ca-profile by ID (retrieveIcebergProfileSecurityCaProfileById)
Retrieve operation of resource: ca-profile

Path parameters

name (required)
Path Parameter — Name of ca-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ca-profile_schema

Example data

Content-Type: application/json
{
  "certificate-authority-crt" : "aeiou",
  "name" : "aeiou"
}

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 ca-profile_schema

400

Internal Error

Up
get /config/profile/security/ca-profiles/
Retrieve ca-profile (retrieveIcebergProfileSecurityCaProfiles)
Retrieve entire ca-profiles configuration.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/profile/security/local-certificate/{name}/
Retrieve local-certificate by ID (retrieveIcebergProfileSecurityLocalCertificateById)
Retrieve operation of resource: local-certificate

Path parameters

name (required)
Path Parameter — Name of local-certificate

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

local-certificate_schema

Example data

Content-Type: application/json
{
  "client-crt" : "aeiou",
  "name" : "aeiou",
  "client-key" : "aeiou"
}

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 local-certificate_schema

400

Internal Error

Up
get /config/profile/security/local-certificates/
Retrieve local-certificate (retrieveIcebergProfileSecurityLocalCertificates)
Retrieve entire local-certificates configuration.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/profile/security/ssh-key-profile/{name}/
Retrieve ssh-key-profile by ID (retrieveIcebergProfileSecuritySshKeyProfileById)
Retrieve operation of resource: ssh-key-profile

Path parameters

name (required)
Path Parameter — Name of ssh-key-profile

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

ssh-key-profile_schema

Example data

Content-Type: application/json
{
  "ssh-private-key-file" : "aeiou",
  "ssh-private-key-passphrase" : "aeiou",
  "name" : "aeiou"
}

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 ssh-key-profile_schema

400

Internal Error

Up
get /config/profile/security/ssh-key-profiles/
Retrieve ssh-key-profile (retrieveIcebergProfileSecuritySshKeyProfiles)
Retrieve entire ssh-key-profiles configuration.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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
get /config/profiles/
Retrieve profile (retrieveIcebergProfiles)
Retrieve entire profile configuration.

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

profiles_schema

Example data

Content-Type: application/json
{
  "profile" : {
    "security" : {
      "ca-profile" : [ {
        "certificate-authority-crt" : "aeiou",
        "name" : "aeiou"
      } ],
      "ssh-key-profile" : [ {
        "ssh-private-key-file" : "aeiou",
        "ssh-private-key-passphrase" : "aeiou",
        "name" : "aeiou"
      } ],
      "local-certificate" : [ {
        "client-crt" : "aeiou",
        "name" : "aeiou",
        "client-key" : "aeiou"
      } ]
    },
    "data-summarization" : {
      "raw" : [ {
        "path" : [ {
          "name" : "aeiou",
          "aggregation-functions" : [ "latest" ]
        } ],
        "name" : "aeiou",
        "data-type" : [ {
          "name" : "string",
          "aggregation-functions" : [ "latest" ]
        } ]
      } ]
    }
  }
}

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 profiles_schema

400

Internal Error

Up
get /config/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:

Request headers

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

Up
put /config/ingest/byoi/custom-plugin/{name}/
Update custom-plugin by ID (updateHealthbotIngestByoiCustomPluginById)
Update operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request body

custom_plugin custom-plugin_schema (required)
Body Parameter — custom_pluginbody object

Request headers

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 /config/ingest/byoi/default-plugin/tlive-kafka-oc/{name}/
Update tlive-kafka-oc by ID (updateHealthbotIngestByoiDefaultPluginTliveKafkaById)
Update operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request body

tlive_kafka tlive-kafka-oc_schema (required)
Body Parameter — tlive_kafka body object

Request headers

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 /config/ingest/byoi/ingest-mapping/{name}/
Update ingest-mapping by ID (updateHealthbotIngestByoiIngestMappingById)
Update ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request body

ingest_mapping ingest-mapping_schema (required)
Body Parameter — ingest_mappingbody object

Request headers

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 /config/ingest/frequency-profile/{name}/
Update frequency-profile by ID (updateHealthbotIngestFrequencyProfileById)
Update operation of resource: frequency-profile

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

frequency_profile frequency-profile_schema (required)
Body Parameter — frequency_profilebody object

Request headers

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 /config/ingest-settings/byoi/custom-plugin/{name}/
Update custom-plugin by ID (updateHealthbotIngestSettingsByoiCustomPluginById)
Update operation of resource: custom-plugin

Path parameters

name (required)
Path Parameter — Name of custom-plugin

Consumes

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

Request body

custom_plugin custom-plugin_schema (required)
Body Parameter — custom_pluginbody object

Request headers

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 /config/ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/
Update tlive-kafka-oc by ID (updateHealthbotIngestSettingsByoiDefaultPluginTliveKafkaById)
Update operation of resource: tlive-kafka-oc

Path parameters

name (required)
Path Parameter — Name of tlive-kafka-oc

Consumes

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

Request body

tlive_kafka tlive-kafka-oc_schema (required)
Body Parameter — tlive_kafka body object

Request headers

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 /config/ingest-settings/byoi/ingest-mapping/{name}/
Update ingest-mapping by ID (updateHealthbotIngestSettingsByoiIngestMappingById)
Update ingest-mapping by name

Path parameters

name (required)
Path Parameter — Name of ingest-mapping

Consumes

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

Request body

ingest_mapping ingest-mapping_schema (required)
Body Parameter — ingest_mappingbody object

Request headers

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 /config/ingest-settings/frequency-profile/{name}/
Update frequency-profile by ID (updateHealthbotIngestSettingsFrequencyProfileById)
Update operation of resource: frequency-profile

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

frequency_profile frequency-profile_schema (required)
Body Parameter — frequency_profilebody object

Request headers

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 /config/ingest-settings/data-enrichment/tagging-profile/{name}/
Update tagging-profile by ID (updateHealthbotIngestSettingsTaggingProfileById)
Update operation of resource: tagging-profile

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

tagging_profile tagging-profile_schema (required)
Body Parameter — tagging_profilebody object

Request headers

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 /config/ingest-settings/data-enrichment/tagging-profiles/
Update tagging-profile by ID (updateHealthbotIngestSettingsTaggingProfiles)
Update operation of resource: tagging-profile

Consumes

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

Request body

tagging_profiles tagging-profiles_schema (required)
Body Parameter — tagging_profilebody object

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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 /config/ingest/sflow/
Update sflow by ID (updateHealthbotIngestSflow)
Update operation of resource: sflow

Consumes

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

Request body

sflow sflow_schema (required)
Body Parameter — sflowbody object

Request headers

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 /config/ingest/sflow/counter-record/{record_name}/
Update counter-record by ID (updateHealthbotIngestSflowCounterRecordById)
Update operation of resource: counter-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request body

counter_record counter-record_schema (required)
Body Parameter — counter_recordbody object

Request headers

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 /config/ingest/sflow/flow-record/{record_name}/
Update flow-record by ID (updateHealthbotIngestSflowFlowRecordById)
Update operation of resource: flow-record

Path parameters

record_name (required)
Path Parameter — ID of record-name

Consumes

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

Request body

flow_record flow-record_schema (required)
Body Parameter — flow_recordbody object

Request headers

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 /config/ingest/sflow/protocol/{protocol_name}/
Update protocol by ID (updateHealthbotIngestSflowProtocolById)
Update operation of resource: protocol

Path parameters

protocol_name (required)
Path Parameter — ID of protocol-name

Consumes

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

Request body

protocol protocol_schema (required)
Body Parameter — protocolbody object

Request headers

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 /config/ingest/sflow/sample/{sample_name}/
Update sample by ID (updateHealthbotIngestSflowSampleById)
Update operation of resource: sample

Path parameters

sample_name (required)
Path Parameter — ID of sample-name

Consumes

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

Request body

sample sample_schema (required)
Body Parameter — samplebody object

Request headers

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 /config/ingest/data-enrichment/tagging-profile/{name}/
Update tagging-profile by ID (updateHealthbotIngestTaggingProfileById)
Update operation of resource: tagging-profile

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

tagging_profile tagging-profile_schema (required)
Body Parameter — tagging_profilebody object

Request headers

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 /config/ingest/data-enrichment/tagging-profiles/
Update tagging-profile by ID (updateHealthbotIngestTaggingProfiles)
Update operation of resource: tagging-profile

Consumes

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

Request body

tagging_profiles tagging-profiles_schema (required)
Body Parameter — tagging_profilebody object

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "aeiou" ]

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 /config/organization/{organization_name}/
Update organization by ID (updateHealthbotOrganizationOrganizationById)
Update operation of resource: organization

Path parameters

organization_name (required)
Path Parameter — ID of organization-name

Consumes

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

Request body

organization organization_schema (required)
Body Parameter — organizationbody object

Request headers

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 /config/system/tsdb/
Update time-series-database by ID (updateHealthbotSystemTimeSeriesDatabaseTimeSeriesDatabaseById)
Update operation of resource: time-series-database

Consumes

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

Request body

time_series_database tsdb_schema (required)
Body Parameter — time_series_databasebody object

Query parameters

force_tsdb (optional)
Query Parameter — force update tsdb when force is set to True default: false

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 /config/ingest/
Update ingest by ID (updateIcebergIngest)
Update operation of resource: ingest

Consumes

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

Request body

ingest_settings ingest-settings_schema (required)
Body Parameter — ingest_settingsbody object

Request headers

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 /config/ingest/flow/
Update flow by ID (updateIcebergIngestFlow)
Update operation of resource: flow

Consumes

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

Request body

flow flow_schema (required)
Body Parameter — flowbody object

Request headers

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 /config/ingest/flow/template/{name}/
Update template by ID (updateIcebergIngestFlowTemplateById)
Update operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request body

template template_schema (required)
Body Parameter — templatebody object

Request headers

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 /config/ingest/native-gpb/
Update native-gpb by ID (updateIcebergIngestNativeGpb)
Update operation of resource: native-gpb

Consumes

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

Request body

native_gpb native-gpb_schema (required)
Body Parameter — native_gpbbody object

Request headers

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 /config/ingest-settings/
Update ingest-settings by ID (updateIcebergIngestSettings)
Update operation of resource: ingest-settings

Consumes

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

Request body

ingest_settings ingest-settings_schema (required)
Body Parameter — ingest_settingsbody object

Request headers

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 /config/ingest-settings/flow/
Update flow by ID (updateIcebergIngestSettingsFlow)
Update operation of resource: flow

Consumes

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

Request body

flow flow_schema (required)
Body Parameter — flowbody object

Request headers

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 /config/ingest-settings/flow/template/{name}/
Update template by ID (updateIcebergIngestSettingsFlowTemplateById)
Update operation of resource: template

Path parameters

name (required)
Path Parameter — Name of template

Consumes

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

Request body

template template_schema (required)
Body Parameter — templatebody object

Request headers

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 /config/ingest-settings/syslog/
Update syslog by ID (updateIcebergIngestSettingsSyslog)
Update operation of resource: syslog

Consumes

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

Request body

syslog syslog_schema (required)
Body Parameter — syslogbody object

Request headers

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 /config/ingest-settings/syslog/pattern/{name}/
Update pattern by ID (updateIcebergIngestSettingsSyslogPatternById)
Update operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request body

pattern pattern_schema (required)
Body Parameter — patternbody object

Request headers

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 /config/ingest-settings/syslog/pattern-set/{name}/
Update pattern-set by ID (updateIcebergIngestSettingsSyslogPatternSetById)
Update operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request body

pattern_set pattern-set_schema (required)
Body Parameter — pattern_setbody object

Request headers

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 /config/ingest/syslog/
Update syslog by ID (updateIcebergIngestSyslog)
Update operation of resource: syslog

Consumes

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

Request body

syslog syslog_schema (required)
Body Parameter — syslogbody object

Request headers

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 /config/ingest/syslog/pattern/{name}/
Update pattern by ID (updateIcebergIngestSyslogPatternById)
Update operation of resource: pattern

Path parameters

name (required)
Path Parameter — Name of pattern

Consumes

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

Request body

pattern pattern_schema (required)
Body Parameter — patternbody object

Request headers

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 /config/ingest/syslog/pattern-set/{name}/
Update pattern-set by ID (updateIcebergIngestSyslogPatternSetById)
Update operation of resource: pattern-set

Path parameters

name (required)
Path Parameter — Name of pattern-set

Consumes

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

Request body

pattern_set pattern-set_schema (required)
Body Parameter — pattern_setbody object

Request headers

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 /config/profile/data-summarization/raw/{name}/
Update raw-data-summarization by ID (updateIcebergProfileDataSummarizationRawById)
Update operation of resource: raw-data-summarization

Path parameters

name (required)
Path Parameter — Name of raw-data-summarization

Consumes

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

Request body

raw_data_summarization raw_schema (required)
Body Parameter — raw_data_summarizationbody object

Request headers

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 /config/profile/security/ca-profile/{name}/
Update ca-profile by ID (updateIcebergProfileSecurityCaProfileById)
Update operation of resource: ca-profile

Path parameters

name (required)
Path Parameter — Name of ca-profile

Consumes

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

Request body

ca_profile ca-profile_schema (required)
Body Parameter — ca_profilebody object

Request headers

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 /config/profile/security/local-certificate/{name}/
Update local-certificate by ID (updateIcebergProfileSecurityLocalCertificateById)
Update operation of resource: local-certificate

Path parameters

name (required)
Path Parameter — Name of local-certificate

Consumes

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

Request body

local_certificate local-certificate_schema (required)
Body Parameter — local_certificatebody object

Request headers

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 /config/profile/security/ssh-key-profile/{name}/
Update ssh-key-profile by ID (updateIcebergProfileSecuritySshKeyProfileById)
Update operation of resource: ssh-key-profile

Path parameters

name (required)
Path Parameter — Name of ssh-key-profile

Consumes

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

Request body

ssh_key_profile ssh-key-profile_schema (required)
Body Parameter — ssh_key_profilebody object

Request headers

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 /config/profiles/
Update profile by ID (updateIcebergProfiles)
Update entire profile configuration.

Consumes

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

Request body

profile profiles_schema (required)
Body Parameter — profilebody object

Request headers

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

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 /config/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:

Request headers

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" : {
    "initial-sync" : true,
    "gnmi" : {
      "enable" : true,
      "encoding" : "protobuf"
    },
    "port" : 39501
  },
  "outbound-ssh" : {
    "disable" : true
  },
  "timezone" : "aeiou",
  "description" : "aeiou",
  "snmp" : {
    "port" : 9607,
    "v2" : {
      "community" : "aeiou"
    }
  },
  "syslog" : {
    "source-ip-addresses" : [ "aeiou" ],
    "hostnames" : [ "aeiou" ]
  },
  "device-id" : "aeiou",
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "iAgent" : {
    "port" : 5249
  },
  "system-id" : "aeiou",
  "vendor" : {
    "arista" : {
      "operating-system" : "eos"
    },
    "linux" : {
      "operating-system" : "aeiou"
    },
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    },
    "other-vendor" : {
      "operating-system" : "aeiou",
      "vendor-name" : "aeiou"
    },
    "paloalto" : {
      "operating-system" : "panos"
    }
  },
  "host" : "aeiou",
  "variable" : [ {
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "flow" : {
    "source-ip-addresses" : [ "aeiou" ]
  },
  "authentication" : {
    "password" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "ssh" : {
      "ssh-key-profile" : "aeiou",
      "username" : "aeiou"
    },
    "ssl" : {
      "ca-profile" : "aeiou",
      "server-common-name" : "aeiou",
      "local-certificate" : "aeiou"
    }
  },
  "tagging-profile" : [ "aeiou" ]
}

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 /config/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:

Request headers

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" : {
    "initial-sync" : true,
    "gnmi" : {
      "enable" : true,
      "encoding" : "protobuf"
    },
    "port" : 39501
  },
  "outbound-ssh" : {
    "disable" : true
  },
  "timezone" : "aeiou",
  "description" : "aeiou",
  "snmp" : {
    "port" : 9607,
    "v2" : {
      "community" : "aeiou"
    }
  },
  "syslog" : {
    "source-ip-addresses" : [ "aeiou" ],
    "hostnames" : [ "aeiou" ]
  },
  "device-id" : "aeiou",
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "iAgent" : {
    "port" : 5249
  },
  "system-id" : "aeiou",
  "vendor" : {
    "arista" : {
      "operating-system" : "eos"
    },
    "linux" : {
      "operating-system" : "aeiou"
    },
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    },
    "other-vendor" : {
      "operating-system" : "aeiou",
      "vendor-name" : "aeiou"
    },
    "paloalto" : {
      "operating-system" : "panos"
    }
  },
  "host" : "aeiou",
  "variable" : [ {
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "flow" : {
    "source-ip-addresses" : [ "aeiou" ]
  },
  "authentication" : {
    "password" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "ssh" : {
      "ssh-key-profile" : "aeiou",
      "username" : "aeiou"
    },
    "ssl" : {
      "ca-profile" : "aeiou",
      "server-common-name" : "aeiou",
      "local-certificate" : "aeiou"
    }
  },
  "tagging-profile" : [ "aeiou" ]
}

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 /config/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:

Request headers

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" : {
    "initial-sync" : true,
    "gnmi" : {
      "enable" : true,
      "encoding" : "protobuf"
    },
    "port" : 39501
  },
  "outbound-ssh" : {
    "disable" : true
  },
  "timezone" : "aeiou",
  "description" : "aeiou",
  "snmp" : {
    "port" : 9607,
    "v2" : {
      "community" : "aeiou"
    }
  },
  "syslog" : {
    "source-ip-addresses" : [ "aeiou" ],
    "hostnames" : [ "aeiou" ]
  },
  "device-id" : "aeiou",
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "iAgent" : {
    "port" : 5249
  },
  "system-id" : "aeiou",
  "vendor" : {
    "arista" : {
      "operating-system" : "eos"
    },
    "linux" : {
      "operating-system" : "aeiou"
    },
    "juniper" : {
      "operating-system" : "junos"
    },
    "cisco" : {
      "operating-system" : "iosxr"
    },
    "other-vendor" : {
      "operating-system" : "aeiou",
      "vendor-name" : "aeiou"
    },
    "paloalto" : {
      "operating-system" : "panos"
    }
  },
  "host" : "aeiou",
  "variable" : [ {
    "instance-id" : "aeiou",
    "rule" : "aeiou",
    "variable-value" : [ {
      "name" : "aeiou",
      "value" : "aeiou"
    } ],
    "playbook" : "aeiou"
  } ],
  "flow" : {
    "source-ip-addresses" : [ "aeiou" ]
  },
  "authentication" : {
    "password" : {
      "password" : "aeiou",
      "username" : "aeiou"
    },
    "ssh" : {
      "ssh-key-profile" : "aeiou",
      "username" : "aeiou"
    },
    "ssl" : {
      "ca-profile" : "aeiou",
      "server-common-name" : "aeiou",
      "local-certificate" : "aeiou"
    }
  },
  "tagging-profile" : [ "aeiou" ]
}

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

Instanceschedulestate

Up
get /config/instances-schedule-state/{group_type}/{group_name}/
Get scheduled state of playbook instances with schedule. (retrieveInstancesScheduleState)
Retrieve the scheduled state of instances with an active scheduler attached to it and present under the group with name passed in the path parameter.

Path parameters

group_name (required)
Path Parameter — Group name
group_type (required)
Path Parameter — Group type

Consumes

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

Request headers

Return type

instances_schedule_state_schema

Example data

Content-Type: application/json
{
  "instance" : [ {
    "group-name" : "aeiou",
    "group-type" : "device-group",
    "name" : "aeiou",
    "rule" : "aeiou",
    "state" : "active",
    "playbook" : "aeiou"
  } ]
}

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 instances_schedule_state_schema

400

Internal Error

Up
put /config/instances-schedule-state/{group_type}/{group_name}/
Update scheduled state of playbook instances with schedule. (updateInstancesScheduleState)
Update the scheduled state of instances with active scheduler attached to it and present under the group with name passed in the path parameter.

Path parameters

group_name (required)
Path Parameter — Group name
group_type (required)
Path Parameter — Group type

Consumes

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

Request body

instances_schedule_state instances_schedule_state_schema (required)
Body Parameter — List of instances and their scheduled state

Request headers

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

License

Up
post /license/keys/
Add license from file. (createIcebergAddLicenseFromFile)
Add license keys from file.

Consumes

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

Request headers

Form parameters

license_file (required)
Form Parameter — License key file content

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "license-id" : "license-id-string"
}

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 inline_response_200_1

Example data

Content-Type: application/json
{license-id=license-id-string}

default

unexpected error Error

Up
delete /license/keys/
Delete all licenses. (deleteIcebergDeleteAllLicense)
Delete all the previously added license keys.

Consumes

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

Request headers

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 /license/key/{license_id}/
Delete a license. (deleteIcebergDeleteLicenseById)
Delete a license matching the license id.

Path parameters

license_id (required)
Path Parameter — License id

Consumes

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

Request headers

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 /license/keys/
List of available license id's. (retrieveIcebergGetAllLicenseId)
Get the list of all available license id's.

Consumes

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

Request headers

Return type

array[String]

Example data

Content-Type: application/json
[ "license-id-1", "license-id-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
[license-id-1, license-id-2]

default

unexpected error Error

Up
get /license/status/
Status of all the licensed features. (retrieveIcebergLicenseFeaturesInfo)
Get the status of all the licensed features. Also provides the compliance info per feature

Consumes

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

Request headers

Return type

license-features_schema

Example data

Content-Type: application/json
{
  "license-feature" : [ {
    "license-remaining" : 0,
    "license-total" : 0,
    "feature-name" : "aeiou",
    "license-requested" : 0,
    "mode" : "invalid",
    "feature-id" : 0,
    "validity-type" : "invalid",
    "end-date" : 0,
    "feature-description" : "aeiou",
    "license-usage" : 0,
    "compliance" : true,
    "valid-until" : "aeiou",
    "max-remaining-days" : 0
  } ]
}

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 license-features_schema

default

unexpected error Error

Up
get /license/key/{license_id}/
Download license file. (retrieveIcebergLicenseFileByLicenseId)
Download the specified license file based on license id.

Path parameters

license_id (required)
Path Parameter — License id

Consumes

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

Request headers

Return type

File

Example data

Content-Type: application/json
"LICENSE 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
LICENSE FILE CONTENT

default

unexpected error Error

Up
get /license/keys/contents/
Get the contents of all licenses. (retrieveIcebergLicenseKeyContents)
Get the license key contents for all the available licenses.

Consumes

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

Request headers

Return type

license-keys_schema

Example data

Content-Type: application/json
{
  "license-key" : [ {
    "mode" : "invalid",
    "end-date" : "2000-01-23T04:56:07.000+00:00",
    "validity-type" : "invalid",
    "features" : [ {
      "feature-id" : 0,
      "feature-description" : "aeiou",
      "capacity-flag" : true,
      "feature-name" : "aeiou",
      "capacity-value" : 0
    } ],
    "customer-id" : "aeiou",
    "license-id" : "aeiou",
    "start-date" : "2000-01-23T04:56:07.000+00:00",
    "order-type" : "unknown",
    "version" : 1,
    "sku-name" : "aeiou",
    "sw-serial-id" : "aeiou"
  } ]
}

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 license-keys_schema

default

unexpected error Error

Up
get /license/key/{license_id}/contents/
Get the contents of a license. (retrieveIcebergLicenseKeyContentsById)
Get the license key contents by the license id.

Path parameters

license_id (required)
Path Parameter — License id

Consumes

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

Request headers

Return type

license-key_schema

Example data

Content-Type: application/json
{
  "mode" : "invalid",
  "end-date" : "2000-01-23T04:56:07.000+00:00",
  "validity-type" : "invalid",
  "features" : [ {
    "feature-id" : 0,
    "feature-description" : "aeiou",
    "capacity-flag" : true,
    "feature-name" : "aeiou",
    "capacity-value" : 0
  } ],
  "customer-id" : "aeiou",
  "license-id" : "aeiou",
  "start-date" : "2000-01-23T04:56:07.000+00:00",
  "order-type" : "unknown",
  "version" : 1,
  "sku-name" : "aeiou",
  "sw-serial-id" : "aeiou"
}

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 license-key_schema

default

unexpected error Error

Up
put /license/keys/
Update the license. (updateIcebergReplaceLicense)
Update existing license keys with the new one provided in this request.

Consumes

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

Request body

license_raw_keys license-raw-keys_schema (required)
Body Parameter — License raw keys contents

Request headers

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "license-id" : "license-id-string"
}

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 inline_response_200_1

Example data

Content-Type: application/json
{license-id=license-id-string}

default

unexpected error Error

Logs

Up
get /logs/device-group/{device_group_name}/
Logs for the given device-group. (retrieveLogsForDeviceGroup)
Get the logs for all the services for the given {device_group_name}

Path parameters

device_group_name (required)
Path Parameter — Device group name

Consumes

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

Request headers

Query parameters

download (optional)
Query Parameter — Download the logs default: true
filename (optional)
Query Parameter — Name of the log 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

400

Internal Error

Up
get /logs/device-group/{device_group_name}/service/{service_name}/
Get the logs for the given service running for the given device-group. (retrieveLogsForDeviceGroupService)
Get the logs for the service {service_name} for the given {device_group_name}

Path parameters

device_group_name (required)
Path Parameter — Device group name
service_name (required)
Path Parameter — Device-group service name

Consumes

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

Request headers

Query parameters

download (optional)
Query Parameter — Download the logs default: true
filename (optional)
Query Parameter — Name of the log file
number_of_lines (optional)
Query Parameter — Number of lines to show from the end of the logs default: 100000

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
get /logs/network-group/{network_group_name}/
Logs for the given network group. (retrieveLogsForNetworkGroup)
Get the logs for the service {service_name} for the given {network_group_name}

Path parameters

network_group_name (required)
Path Parameter — Network group name

Consumes

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

Request headers

Query parameters

download (optional)
Query Parameter — Download the logs default: true
filename (optional)
Query Parameter — Name of the log 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

400

Internal Error

Up
get /logs/network-group/{network_group_name}/service/{service_name}/
Get the logs for the given service running for the given network-group. (retrieveLogsForNetworkGroupService)
Get the logs for all the services for the given {network_group_name}

Path parameters

network_group_name (required)
Path Parameter — Network group name
service_name (required)
Path Parameter — Network group service name

Consumes

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

Request headers

Query parameters

download (optional)
Query Parameter — Download the logs default: true
filename (optional)
Query Parameter — Name of the log file
number_of_lines (optional)
Query Parameter — Number of lines to show from the end of the logs default: 100000

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

Organization

Up
post /config/organization/{organization_name}/site/{site_name}/edge/{edge_name}/
Create edge by ID (createHealthbotOrganizationSiteEdgeEdgeById)
Create operation of resource: edge

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name
edge_name (required)
Path Parameter — ID of edge-name

Consumes

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

Request body

edge edge_schema (required)
Body Parameter — edgebody object

Request headers

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 /config/organization/{organization_name}/site/{site_name}/
Create site by ID (createHealthbotOrganizationSiteSiteById)
Create operation of resource: site

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name

Consumes

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

Request body

site site_schema (required)
Body Parameter — sitebody object

Request headers

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 /config/organization/{organization_name}/site/{site_name}/edge/{edge_name}/
Delete edge by ID (deleteHealthbotOrganizationSiteEdgeEdgeById)
Delete operation of resource: edge

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name
edge_name (required)
Path Parameter — ID of edge-name

Consumes

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

Request headers

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 /config/organization/{organization_name}/site/{site_name}/
Delete site by ID (deleteHealthbotOrganizationSiteSiteById)
Delete operation of resource: site

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name

Consumes

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

Request headers

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 /config/organization/{organization_name}/site/{site_name}/edge/{edge_name}/
Retrieve edge by ID (retrieveHealthbotOrganizationSiteEdgeEdgeById)
Retrieve operation of resource: edge

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name
edge_name (required)
Path Parameter — ID of edge-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

edge_schema

Example data

Content-Type: application/json
{
  "edge-name" : "aeiou",
  "description" : "aeiou",
  "edge-id" : "aeiou"
}

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 edge_schema

400

Internal Error

Up
get /config/organization/{organization_name}/site/{site_name}/
Retrieve site by ID (retrieveHealthbotOrganizationSiteSiteById)
Retrieve operation of resource: site

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name

Consumes

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

Request headers

Query parameters

working (optional)
Query Parameter — true queries undeployed configuration

Return type

site_schema

Example data

Content-Type: application/json
{
  "edge" : [ {
    "edge-name" : "aeiou",
    "description" : "aeiou",
    "edge-id" : "aeiou"
  } ],
  "site-name" : "aeiou",
  "description" : "aeiou"
}

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 site_schema

400

Internal Error

Up
put /config/organization/{organization_name}/site/{site_name}/edge/{edge_name}/
Update edge by ID (updateHealthbotOrganizationSiteEdgeEdgeById)
Update operation of resource: edge

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name
edge_name (required)
Path Parameter — ID of edge-name

Consumes

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

Request body

edge edge_schema (required)
Body Parameter — edgebody object

Request headers

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 /config/organization/{organization_name}/site/{site_name}/
Update site by ID (updateHealthbotOrganizationSiteSiteById)
Update operation of resource: site

Path parameters

organization_name (required)
Path Parameter — ID of organization-name
site_name (required)
Path Parameter — ID of site-name

Consumes

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

Request body

site site_schema (required)
Body Parameter — sitebody object

Request headers

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

Services

Up
post /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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 /config/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:

Request headers

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

System

Up
get /tsdb/query
TSDB query (queryTsdb)
Query TSDB

Consumes

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

Query parameters

db (required)
Query Parameter — Name of the database. Multiple databases should be separated by ','. '*' can be used to specify all databases.
deviceGroup (required)
Query Parameter — Name of the deviceGroup(s). Multiple device groups should be separated by ','. This can be used in combination with device, but is not mandatory. If device is given, then query will be executed only for that particular devices in the given device group, else all devices in group will be considered. Given devices will be applicable for all give device-groups.
device (required)
Query Parameter — Name of the device. Multiple device should be separated by ','. This should be used along with deviceGroup. Without deviceGroup, this config will not be considered
measurement (optional)
Query Parameter — Name of the measurement. Optional if topic/rule/trigger is used
topic (optional)
Query Parameter — Name of Healthbot topic. Optional if measurement is used
rule (optional)
Query Parameter — Name of Healthbot rule. Required if topic is used. Optional if measurement is used
trigger (optional)
Query Parameter — Name of Healthbot trigger. Optional if measurement is used or rule table is being queried
fields (optional)
Query Parameter — Fields that needs to be retrieved. Use * for to query all fields. Eg: fields=field1, field2
order (optional)
Query Parameter — Sort points in descending order based on time. By default points will be sorted in ascending order. Eg: order=desc
groupBy (optional)
Query Parameter — Group results based on specified tags. Use * to group by all tags. Eg: groupBy=key1, key2
limit (optional)
Query Parameter — Limit number of points in the result. If groupBy is used limit is applied per group. Eg: limit=10
where (optional)
Query Parameter — Where clause filters data based on fields, tags, and/or timestamps. Eg: where="interface-name" = 'ge-0/0/1' and "in-pkts" > 0
q (optional)
Query Parameter — Influx query string. Use this when custom query format does not support a query

Return type

tsdb_results

Example data

Content-Type: application/json
{
  "results" : [ {
    "database" : "aeiou",
    "series" : [ {
      "columns" : [ "aeiou" ],
      "values" : [ [ "aeiou" ] ],
      "name" : "aeiou",
      "tags" : {
        "key" : "aeiou"
      }
    } ],
    "statement_id" : 0
  } ]
}

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. NOTE: the "values" in the query result is a list of list. Elements in this list can be of any type string/integer/float/boolean. Because of the limitation in swagger 2.0, this information could not be encoded. So for now it is maked as string tsdb_results

400

Bad Request TsdbError

500

Innternal Error TsdbError

Up
post /tsdb/query
TSDB query (queryTsdbPost)
Query TSDB

Consumes

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

Request body

tsdb_query_body tsdb_post_body (optional)
Body Parameter — Query TSDB body object

Query parameters

db (required)
Query Parameter — Name of the database. Multiple databases should be separated by ','. '*' can be used to specify all databases.
deviceGroup (required)
Query Parameter — Name of the deviceGroup(s). Multiple device groups should be separated by ','. This can be used in combination with device, but is not mandatory. If device is given, then query will be executed only for that particular devices in the given device group, else all devices in group will be considered. Given devices will be applicable for all give device-groups.
device (required)
Query Parameter — Name of the device. Multiple device should be separated by ','. This should be used along with deviceGroup. Without deviceGroup, this config will not be considered
measurement (optional)
Query Parameter — Name of the measurement. Optional if topic/rule/trigger is used
topic (optional)
Query Parameter — Name of Healthbot topic. Optional if measurement is used
rule (optional)
Query Parameter — Name of Healthbot rule. Required if topic is used. Optional if measurement is used
trigger (optional)
Query Parameter — Name of Healthbot trigger. Optional if measurement is used or rule table is being queried
fields (optional)
Query Parameter — Fields that needs to be retrieved. Use * for to query all fields. Eg: fields=field1, field2
order (optional)
Query Parameter — Sort points in descending order based on time. By default points will be sorted in ascending order. Eg: order=desc
groupBy (optional)
Query Parameter — Group results based on specified tags. Use * to group by all tags. Eg: groupBy=key1, key2
limit (optional)
Query Parameter — Limit number of points in the result. If groupBy is used limit is applied per group. Eg: limit=10
where (optional)
Query Parameter — Where clause filters data based on fields, tags, and/or timestamps. Eg: where="interface-name" = 'ge-0/0/1' and "in-pkts" > 0
q (optional)
Query Parameter — Influx query string. Use this when custom query format does not support a query

Return type

tsdb_results

Example data

Content-Type: application/json
{
  "results" : [ {
    "database" : "aeiou",
    "series" : [ {
      "columns" : [ "aeiou" ],
      "values" : [ [ "aeiou" ] ],
      "name" : "aeiou",
      "tags" : {
        "key" : "aeiou"
      }
    } ],
    "statement_id" : 0
  } ]
}

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. NOTE: the "values" in the query result is a list of list. Elements in this list can be of any type string/integer/float/boolean. Because of the limitation in swagger 2.0, this information could not be encoded. So for now it is maked as string tsdb_results

400

Bad Request TsdbError

500

Innternal Error TsdbError

Up
get /nodes/
List of available nodes (retrieveAvailableNodes)
Get the list of available nodes in the installation.

Consumes

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

Request headers

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 /config/sensor/device-group/{device_group_name}/
Get all All API's. (retrieveSensorDeviceGroup)
GET sensors subscribed for a device-group

Path parameters

device_group_name (required)
Path Parameter — Device Group

Consumes

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

Request headers

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

Subscribed sensors for device-group

default

unexpected error Error

Up
get /system-details/
Retrieve system details. (retrieveSystemDetails)
Retrieve system details for HealthBot system.

Consumes

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

Request headers

Query parameters

service_name (optional)
Query Parameter — service name takes in the name of the service for which details are required.

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 /tsdb-counters/
TSDB counters (retrieveTsdbCounters)
Get TSDB counters

Consumes

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

Request headers

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

Models

[ Jump to Methods ]

Table of Contents

  1. Error -
  2. TsdbError -
  3. TsdbError_results -
  4. affected-groups -
  5. apply-macro_schema -
  6. applymacro_schema_data -
  7. associated_group_schema -
  8. associated_role_schema -
  9. associated_user_schema -
  10. associated_user_schema_inner -
  11. ca-profile_schema -
  12. command-rpc -
  13. commit-job -
  14. counter-record_schema -
  15. credential -
  16. custom-plugin_schema -
  17. custom-plugins_schema -
  18. customplugin_schema_parameters -
  19. customplugin_schema_securityparameters -
  20. customplugin_schema_securityparameters_tls -
  21. customplugin_schema_securityparameters_userauthentication -
  22. datastore_schema -
  23. debug-arguments_schema -
  24. debug-job-response_schema -
  25. destination_schema -
  26. destination_schema_disk -
  27. destination_schema_email -
  28. destinations_schema -
  29. device-field-capture_schema -
  30. device-group-field-capture_schema -
  31. device-group_schema -
  32. device-groups_schema -
  33. deviceGroupHealthTree -
  34. deviceHealthSchema -
  35. deviceHealthTree -
  36. device_schema -
  37. device_schema_flow -
  38. device_schema_iAgent -
  39. device_schema_openconfig -
  40. device_schema_outboundssh -
  41. device_schema_snmp -
  42. device_schema_snmp_v2 -
  43. device_schema_syslog -
  44. device_schema_variable -
  45. device_schema_vendor -
  46. device_schema_vendor_arista -
  47. device_schema_vendor_cisco -
  48. device_schema_vendor_juniper -
  49. device_schema_vendor_linux -
  50. device_schema_vendor_othervendor -
  51. device_schema_vendor_paloalto -
  52. devicegroup_schema_authentication -
  53. devicegroup_schema_authentication_password -
  54. devicegroup_schema_authentication_ssh -
  55. devicegroup_schema_authentication_ssl -
  56. devicegroup_schema_flow -
  57. devicegroup_schema_flow_netflow -
  58. devicegroup_schema_flow_sflow -
  59. devicegroup_schema_logging -
  60. devicegroup_schema_logging_MLmodelbuilder -
  61. devicegroup_schema_logging_byoi -
  62. devicegroup_schema_logging_byoi_service -
  63. devicegroup_schema_logging_flow -
  64. devicegroup_schema_logging_iAgent -
  65. devicegroup_schema_logging_nativegpb -
  66. devicegroup_schema_logging_nonsensorrules -
  67. devicegroup_schema_logging_openconfig -
  68. devicegroup_schema_logging_reportsgeneration -
  69. devicegroup_schema_logging_sflow -
  70. devicegroup_schema_logging_snmp -
  71. devicegroup_schema_logging_syslog -
  72. devicegroup_schema_logging_triggerevaluation -
  73. devicegroup_schema_nativegpb -
  74. devicegroup_schema_notification -
  75. devicegroup_schema_openconfig -
  76. devicegroup_schema_openconfig_gnmi -
  77. devicegroup_schema_outboundssh -
  78. devicegroup_schema_publish -
  79. devicegroup_schema_rawdata -
  80. devicegroup_schema_rawdata_summarize -
  81. devicegroup_schema_scheduler -
  82. devicegroup_schema_syslog -
  83. devicegroup_schema_variable -
  84. devicegroup_schema_variablevalue -
  85. devices_schema -
  86. edge_schema -
  87. event -
  88. field-capture_schema -
  89. field-field-capture_schema -
  90. flow-record_schema -
  91. flow_schema -
  92. flow_schema_flow -
  93. flow_schema_flow_recognitionpattern -
  94. flow_schema_flow_template -
  95. frequency-profile_schema -
  96. frequencyprofile_schema_nonsensor -
  97. frequencyprofile_schema_sensor -
  98. group -
  99. groupHealthSchema -
  100. groupgroupid_roles -
  101. groupgroupid_users -
  102. groups -
  103. healthSchema -
  104. ingest-mapping_schema -
  105. ingest-mappings_schema -
  106. ingest-settings_schema -
  107. ingestmapping_schema_iAgent -
  108. ingestmapping_schema_iAgent_useplugin -
  109. inline_response_200 -
  110. inline_response_200_1 -
  111. inline_response_200_2 -
  112. inline_response_200_3 -
  113. inline_response_200_4 -
  114. inline_response_200_5 -
  115. inline_response_200_6 -
  116. inline_response_200_7 -
  117. inline_response_200_8 -
  118. inline_response_200_9 -
  119. instance_schedule_state_schema -
  120. instances_schedule_state_schema -
  121. lhs-rhs-group -
  122. license-feature_schema -
  123. license-features_schema -
  124. license-key_schema -
  125. license-keys_schema -
  126. license-raw-key_schema -
  127. license-raw-keys_schema -
  128. licensekey_schema_features -
  129. local-certificate_schema -
  130. native-gpb_schema -
  131. nativegpb_schema_nativegpb -
  132. network-group_schema -
  133. network-groups_schema -
  134. networkHealthTree -
  135. networkgroup_schema_logging -
  136. networkgroup_schema_notification -
  137. networkgroup_schema_publish -
  138. notification_schema -
  139. notification_schema_emails -
  140. notification_schema_emails_filter -
  141. notification_schema_httppost -
  142. notification_schema_httppost_basic -
  143. notification_schema_kafkapublish -
  144. notification_schema_kafkapublish_sasl -
  145. notification_schema_microsoftteams -
  146. notification_schema_slack -
  147. notifications_schema -
  148. organization_schema -
  149. organizations_schema -
  150. password -
  151. pattern-set_schema -
  152. pattern_schema -
  153. pattern_schema_constant -
  154. pattern_schema_field -
  155. playbook_schema -
  156. playbooks_schema -
  157. profile_schema -
  158. profile_schema_datasummarization -
  159. profile_schema_datasummarization_path -
  160. profile_schema_datasummarization_raw -
  161. profile_schema_security -
  162. profiles_schema -
  163. profiles_schema_profile -
  164. protocol_schema -
  165. raw-data-summarizations_schema -
  166. raw_schema -
  167. raw_schema_datatype -
  168. raw_schema_path -
  169. refreshToken -
  170. report-generation_schema -
  171. report_schema -
  172. report_schema_canvaspanel -
  173. report_schema_graphcanvas -
  174. reports_schema -
  175. retention-policies_schema -
  176. retention-policy_schema -
  177. role_schema -
  178. role_schema_inner -
  179. rule-field-capture_schema -
  180. rule_schema -
  181. rule_schema_argument -
  182. rule_schema_byoi -
  183. rule_schema_byoi_plugin -
  184. rule_schema_byoi_plugin_parameters -
  185. rule_schema_constant -
  186. rule_schema_dataifmissing -
  187. rule_schema_field -
  188. rule_schema_flow -
  189. rule_schema_formula -
  190. rule_schema_formula_1 -
  191. rule_schema_formula_1_and -
  192. rule_schema_formula_1_or -
  193. rule_schema_formula_1_unique -
  194. rule_schema_formula_1_unless -
  195. rule_schema_formula_anomalydetection -
  196. rule_schema_formula_concatenate -
  197. rule_schema_formula_count -
  198. rule_schema_formula_dynamicthreshold -
  199. rule_schema_formula_elapsedtime -
  200. rule_schema_formula_eval -
  201. rule_schema_formula_max -
  202. rule_schema_formula_mean -
  203. rule_schema_formula_microburst -
  204. rule_schema_formula_min -
  205. rule_schema_formula_outlierdetection -
  206. rule_schema_formula_outlierdetection_algorithm -
  207. rule_schema_formula_outlierdetection_algorithm_dbscan -
  208. rule_schema_formula_outlierdetection_algorithm_dbscan_sensitivity -
  209. rule_schema_formula_outlierdetection_algorithm_kfold3sigma -
  210. rule_schema_formula_predict -
  211. rule_schema_formula_rateofchange -
  212. rule_schema_formula_stddev -
  213. rule_schema_formula_sum -
  214. rule_schema_formula_userdefinedfunction -
  215. rule_schema_formula_userdefinedfunction_argument -
  216. rule_schema_formula_valuedifference -
  217. rule_schema_function -
  218. rule_schema_iAgent -
  219. rule_schema_iAgent_args -
  220. rule_schema_nativegpb -
  221. rule_schema_openconfig -
  222. rule_schema_reference -
  223. rule_schema_reference_dataifmissing -
  224. rule_schema_ruleproperties -
  225. rule_schema_ruleproperties_catalogue -
  226. rule_schema_ruleproperties_helperfiles -
  227. rule_schema_ruleproperties_supporteddevices -
  228. rule_schema_ruleproperties_supporteddevices_juniper -
  229. rule_schema_ruleproperties_supporteddevices_juniper_operatingsystem -
  230. rule_schema_ruleproperties_supporteddevices_juniper_products -
  231. rule_schema_ruleproperties_supporteddevices_juniper_releases -
  232. rule_schema_ruleproperties_supporteddevices_othervendor -
  233. rule_schema_sensor -
  234. rule_schema_sensor_1 -
  235. rule_schema_sflow -
  236. rule_schema_snmp -
  237. rule_schema_syslog -
  238. rule_schema_term -
  239. rule_schema_then -
  240. rule_schema_then_argument -
  241. rule_schema_then_status -
  242. rule_schema_then_userdefinedaction -
  243. rule_schema_trigger -
  244. rule_schema_variable -
  245. rule_schema_vector -
  246. rule_schema_when -
  247. rule_schema_when_doesnotmatchwith -
  248. rule_schema_when_equalto -
  249. rule_schema_when_exists -
  250. rule_schema_when_increasingatleastbyrate -
  251. rule_schema_when_increasingatleastbyvalue -
  252. rule_schema_when_maxrateofincrease -
  253. rule_schema_when_range -
  254. rule_schema_when_userdefinedfunction -
  255. rule_schema_where -
  256. sample_schema -
  257. scheduler_schema -
  258. scheduler_schema_repeat -
  259. scheduler_schema_repeat_interval -
  260. scheduler_schema_runfor -
  261. schedulers_schema -
  262. serviceStatus -
  263. sflow_schema -
  264. sflow_schema_sflow -
  265. sflow_schema_sflow_counterrecord -
  266. sflow_schema_sflow_field -
  267. sflow_schema_sflow_protocol -
  268. sflow_schema_sflow_sample -
  269. sflow_schema_sflow_sizebasedonfield -
  270. sflow_schema_sflow_sizebasedonfield_then -
  271. sflow_schema_sflow_sizebasedonfield_then_1 -
  272. sflow_schema_sflow_sizebasedonfield_whenequal -
  273. site_schema -
  274. ssh-key-profile_schema -
  275. syslog_schema -
  276. syslog_schema_syslog -
  277. system-settings_schema -
  278. table_schema -
  279. tagging-profile_schema -
  280. tagging-profiles_schema -
  281. taggingprofile_schema_policy -
  282. taggingprofile_schema_term -
  283. taggingprofile_schema_then -
  284. taggingprofile_schema_then_addfield -
  285. taggingprofile_schema_then_addkey -
  286. taggingprofile_schema_when -
  287. taggingprofile_schema_when_doesnotmatchwith -
  288. taggingprofile_schema_when_equalto -
  289. taggingprofile_schema_when_eval -
  290. taggingprofile_schema_when_matcheswithscheduler -
  291. template_schema -
  292. time-range-mandatory -
  293. tlive-kafka-oc_schema -
  294. tlive-kafka-ocs_schema -
  295. tlivekafkaoc_schema_security -
  296. tlivekafkaoc_schema_security_sasl -
  297. token -
  298. topic-field-capture_schema -
  299. topic_schema -
  300. topics_schema -
  301. trigger_schema -
  302. trigger_schema_triggers -
  303. tsdb_post_body -
  304. tsdb_post_body_items -
  305. tsdb_results -
  306. tsdb_results_results -
  307. tsdb_results_series -
  308. tsdb_schema -
  309. user -
  310. user_1 -
  311. user_schema -
  312. user_schema_groups -
  313. when-lhs-rhs-group -

Error - Up

detail
status
Integer format: int32

TsdbError - Up

results (optional)

TsdbError_results - Up

statement_id (optional)
Integer format: int32
error (optional)
String format: string

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

associated_group_schema - Up

list of groups associated

associated_role_schema - Up

list of roles associated

associated_user_schema - Up

list of users associated

associated_user_schema_inner - Up

userId (optional)
userName (optional)

ca-profile_schema - Up

certificate-authority-crt
String Certificate Authority certificate file name. Should be of pattern .+.crt format: string
name
String Certificate Authority profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* 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

counter-record_schema - Up

enterprise
Integer Enterprise to which record belongs format: int32
field
format
Integer Format of record format: int32
record-name
String Name of record format: string

credential - Up

userName (optional)
String username of the user
password (optional)
String Password of the user

custom-plugin_schema - Up

name
String Name is the identifier of this config, referred in sensor config under topic/rule format: string
parameters (optional)
array[customplugin_schema_parameters] Plugin specific parameters (config)
plugin-name (optional)
String Name of the loaded input plugin of BYOI format: string
security-parameters (optional)
service-name (optional)
String Name of the service (docker container) which implements this plugin format: string

custom-plugins_schema - Up

custom-plugin

customplugin_schema_parameters - Up

key
String Key of the parameter format: string
value (optional)
String Value of the parameter format: string

customplugin_schema_securityparameters - Up

Plugin specific security parameters
tls (optional)
user-authentication (optional)

customplugin_schema_securityparameters_tls - Up

ca-profile (optional)
String CA profile name format: string
insecure-skip-verify (optional)
Boolean Use TLS but skip verification of certificate chain and host
local-certificate-profile (optional)
String Local certificate profile name format: string

customplugin_schema_securityparameters_userauthentication - Up

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

datastore_schema - Up

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

debug-arguments_schema - Up

arguments
Object Optional key/value pair arguments to table

debug-job-response_schema - Up

job-id (optional)
UUID format: uuid
job-status (optional)
Enum:
finished
started
error
pending
job-details (optional)
debug-data (optional)
debug-type (optional)
Enum:
scenario
service
debug-name (optional)

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-field-capture_schema - Up

device-group-field-capture_schema - Up

device-group_schema - Up

authentication (optional)
edge (optional)
String JFM: edge this device group belongs to. This should be of the format ..
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)
flow (optional)
ingest-frequency (optional)
array[String] format: string
raw-data (optional)
notification (optional)
open-config (optional)
outbound-ssh (optional)
playbooks (optional)
publish (optional)
reports (optional)
retention-policy (optional)
String Name of the retention policy to be applied
scheduler (optional)
array[devicegroup_schema_scheduler] List of schedulers associated with the playbook instances
variable (optional)
array[devicegroup_schema_variable] Playbook variable configuration
syslog (optional)
tagging-profile (optional)
array[String] format: string
timezone (optional)
String Timezone in the format +/-hh:mm, Example: -08:00 format: string

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
uuid (optional)
UUID EMS: uuid of the EMS-advertised device format: uuid
flow (optional)
host
String Name or IP of the device format: string
iAgent (optional)
open-config (optional)
outbound-ssh (optional)
snmp (optional)
syslog (optional)
tagging-profile (optional)
array[String] format: string
timezone (optional)
String Timezone in the format +/-hh:mm, Example: -08:00 format: string
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_flow - Up

source-ip-addresses (optional)
array[String] format: string

device_schema_iAgent - Up

port (optional)
Integer Netconf port format: int32

device_schema_openconfig - Up

initial-sync (optional)
Boolean If true, enable initial sync packets processing
gnmi (optional)
port
Integer Port on which gRPC connection needs to be established format: int32

device_schema_outboundssh - Up

Disable Outbound-SSH service for a device
disable (optional)
Boolean If true, disable Outbound-SSH service for the device

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_syslog - Up

source-ip-addresses (optional)
array[String] format: string
hostnames (optional)
array[String] 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
arista (optional)
cisco (optional)
juniper (optional)
linux (optional)
other-vendor (optional)
paloalto (optional)

device_schema_vendor_arista - Up

Arista device
operating-system
String Operating system of the device
Enum:
eos

device_schema_vendor_cisco - Up

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

device_schema_vendor_juniper - Up

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

device_schema_vendor_linux - Up

Linux device
operating-system
String Distribution/Flavour of linux, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

device_schema_vendor_othervendor - Up

Other vendor device
operating-system (optional)
String Vendor operating system, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
vendor-name
String Vendor-name, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string

device_schema_vendor_paloalto - Up

Pal Alto device
operating-system
String Operating system of the device
Enum:
panos

devicegroup_schema_authentication - Up

Common authentication parameters
password (optional)
ssh (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_ssh - Up

SSH Authentication parameters
ssh-key-profile
String Name of the ssh-key-profile to be used format: string
username
String Username for authentication format: string

devicegroup_schema_authentication_ssl - Up

SSL Authentication parameters
ca-profile
String Name of the ca-profile to be used format: string
local-certificate (optional)
String Name of the local-certificate-profile to be used format: string
server-common-name
String Common name used while creating server certificate format: string

devicegroup_schema_flow - Up

Flow ingest related parameters
deploy-nodes (optional)
array[String] format: string
netflow (optional)
sflow (optional)

devicegroup_schema_flow_netflow - Up

NetFlow specific parameters in Flow ingest
ports (optional)
array[Integer] format: int32

devicegroup_schema_flow_sflow - Up

sFlow specific parameters in Flow ingest
ports (optional)
array[Integer] format: int32

devicegroup_schema_logging - Up

Logging configuration
iAgent (optional)
log-level (optional)
String Global log level