Paragon Insights APIs
API interface for PI application
Version: Paragon Automation 23.2
BasePath:/api/v2
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /config/app-settings/
Change runtime app-settings (healthbotAlterAppSettings)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
app_settings
object (optional)
Body Parameter — Maintenance endpoint to change app-settings. Not accessible externally.
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Bad Request
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
Body Parameter — Token object
Return type
Example data
Content-Type: application/json
{
"tokenExpires" : "aeiou",
"refreshTokenExpires" : "aeiou",
"accessToken" : "aeiou",
"refreshToken" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_3
400
Internal Error
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
Body Parameter — topics body object
Return type
Example data
Content-Type: application/json
{
"tokenExpires" : "aeiou",
"refreshTokenExpires" : "aeiou",
"accessToken" : "aeiou",
"refreshToken" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_3
400
Internal Error
User logout (userLogout)
User logout
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — request body object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request body
Body Parameter — organizations body object
Request headers
Produces
This API call produces the following media types according to the 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}/resource/{resource_name}/
Update or create a resource (createHealthbotTopicResourceResourceById)
Create/Update a resource by resource-name. The resource-name specified in URL and the request body must match. If the resource already exists then, the existing resource's configuration will be updated with the new content
Path parameters
topic_name (required)
Path Parameter — ID of topic-name
resource_name (required)
Path Parameter — ID of resource-name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — resourcebody object
Request headers
Produces
This API call produces the following media types according to the 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. [Note: This API can be used freely in standalone Insights. However, for Paragon Automation, devices are managed by EMS services, DO NOT USE this API to modify device configuration. For PA, this API should only be used for modifying device specific variables or playbook start/stop.]
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
Body Parameter — devicebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — device_groupbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — device-groupsbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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. [Note: This API can be used freely in standalone Insights. However, for Paragon Automation, devices are managed by EMS services, DO NOT USE this API to modify device configuration. For PA, this API should only be used for modifying device specific variables or playbook start/stop.]
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Request body
Body Parameter — devicesbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — network_groupbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — network-groupsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — notificationbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — notificationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — playbookbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — playbooksbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — retention-policiesbody object object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — retention_policybody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulerbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulersbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulerbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulersbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request body
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 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
Body Parameter — rulebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — topicbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request body
Body Parameter — topicsbody object
Request headers
Produces
This API call produces the following media types according to the 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 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 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 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}/resource/{resource_name}/
Delete resource (deleteHealthbotTopicResourceResourceById)
Delete a resource by 'resource-name'
Path parameters
topic_name (required)
Path Parameter — ID of topic-name
resource_name (required)
Path Parameter — ID of resource-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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
400
Internal Error
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
Body Parameter — set new password
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
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 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/device-group/{device_group_name}/device/
Remove devices from group. (removeIcebergDevicesFromGroup)
Remove the list of devices from the device 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:
application/jsonmultipart/form-data
Request body
Body Parameter — device list
Request headers
Produces
This API call produces the following media types according to the 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}/variable/
Overwrite a network-group. (removeIcebergNetworkGroupNetworkGroupById)
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
Body Parameter — network_groupbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal 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:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"network-groups" : [ "aeiou" ],
"device-groups" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"service1" : "status1",
"service2" : "status2"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"triggers" : [ {
"name" : "aeiou",
"fields" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Trigger info for a device group.
trigger_schema
default
unexpected error
Error
Up
get /device/{device_id}/trigger_info/
Get trigger info for device-groups containing the device. (retrieveDeviceTriggerInfo)
Get information about the triggers in device-groups having the provided device.
Path parameters
device_id (required)
Path Parameter — Name of device
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"triggers" : [ {
"name" : "aeiou",
"fields" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Trigger info for device-groups having the provided device.
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
organizations_schema
400
Internal Error
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 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
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
},
"port" : 39501
},
"server-monitoring" : "",
"use-ingest-receive-time" : [ "{}" ],
"outbound-ssh" : {
"disable" : true
},
"timezone" : "aeiou",
"description" : "aeiou",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "aeiou",
"source-id" : {
"source-ip-addresses" : [ "aeiou" ]
}
},
"v3" : {
"source-id" : {
"source-ip-addresses" : [ "aeiou" ],
"context-engine-id" : "aeiou"
},
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"source-ip-addresses" : [ "aeiou" ],
"hostnames" : [ "aeiou" ]
},
"device-id" : "aeiou",
"uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"iAgent" : {
"port" : 5249
},
"marked-for-delete" : true,
"system-id" : "aeiou",
"vendor" : {
"arista" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "eos",
"platform" : "aeiou"
},
"linux" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"platform" : "aeiou"
},
"juniper" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "junos",
"platform" : "aeiou"
},
"cisco" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "iosxr",
"platform" : "aeiou"
},
"other-vendor" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"vendor-name" : "aeiou",
"platform" : "aeiou"
},
"paloalto" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "panos",
"platform" : "aeiou"
}
},
"name" : "aeiou",
"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 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 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
Example data
Content-Type: application/json
{
"reports" : [ "aeiou" ],
"field-data" : {
"rollup" : {
"profile" : [ "aeiou" ]
}
},
"outbound-ssh" : {
"ports" : [ 5 ]
},
"timezone" : "aeiou",
"ingest-frequency" : [ "aeiou" ],
"description" : "aeiou",
"playbooks" : [ "aeiou" ],
"snmp" : {
"notification-ports" : [ 2 ],
"port" : 7,
"v2" : {
"community" : "aeiou"
},
"v3" : {
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"ports" : [ 60957 ]
},
"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 ]
},
"action-scheduler" : {
"disable-trigger-action-schedulers" : true
},
"flow" : {
"netflow" : {
"ports" : [ 1 ]
},
"ifa" : {
"deploy-nodes" : [ "aeiou" ],
"ports" : [ 6 ]
},
"sflow" : {
"ports" : [ 5 ]
},
"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"
}
},
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
}
},
"use-ingest-receive-time" : [ "{}" ],
"devices" : [ "aeiou" ],
"paragon-active-assurance" : {
"paa-setup" : "aeiou"
},
"root-cause-analysis" : {
"no-rca" : [ "{}" ],
"exclude-resources" : [ "aeiou" ],
"dynamic-resources" : [ "aeiou" ]
},
"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" ]
},
"server-monitoring" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"sflow" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"ifa" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"resource-discovery" : {
"log-level" : "error"
},
"snmp-notification" : {
"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"
} ]
}
},
"tagging-profile" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the 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
Example data
Content-Type: application/json
{
"device-group" : [ {
"reports" : [ "aeiou" ],
"field-data" : {
"rollup" : {
"profile" : [ "aeiou" ]
}
},
"outbound-ssh" : {
"ports" : [ 5 ]
},
"timezone" : "aeiou",
"ingest-frequency" : [ "aeiou" ],
"description" : "aeiou",
"playbooks" : [ "aeiou" ],
"snmp" : {
"notification-ports" : [ 2 ],
"port" : 7,
"v2" : {
"community" : "aeiou"
},
"v3" : {
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"ports" : [ 60957 ]
},
"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 ]
},
"action-scheduler" : {
"disable-trigger-action-schedulers" : true
},
"flow" : {
"netflow" : {
"ports" : [ 1 ]
},
"ifa" : {
"deploy-nodes" : [ "aeiou" ],
"ports" : [ 6 ]
},
"sflow" : {
"ports" : [ 5 ]
},
"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"
}
},
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
}
},
"use-ingest-receive-time" : [ "{}" ],
"devices" : [ "aeiou" ],
"paragon-active-assurance" : {
"paa-setup" : "aeiou"
},
"root-cause-analysis" : {
"no-rca" : [ "{}" ],
"exclude-resources" : [ "aeiou" ],
"dynamic-resources" : [ "aeiou" ]
},
"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" ]
},
"server-monitoring" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"sflow" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"ifa" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"resource-discovery" : {
"log-level" : "error"
},
"snmp-notification" : {
"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"
} ]
}
},
"tagging-profile" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
device-groups_schema
400
Internal Error
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
Example data
Content-Type: application/json
{
"device" : [ {
"owner" : "aeiou",
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
},
"port" : 39501
},
"server-monitoring" : "",
"use-ingest-receive-time" : [ "{}" ],
"outbound-ssh" : {
"disable" : true
},
"timezone" : "aeiou",
"description" : "aeiou",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "aeiou",
"source-id" : {
"source-ip-addresses" : [ "aeiou" ]
}
},
"v3" : {
"source-id" : {
"source-ip-addresses" : [ "aeiou" ],
"context-engine-id" : "aeiou"
},
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"source-ip-addresses" : [ "aeiou" ],
"hostnames" : [ "aeiou" ]
},
"device-id" : "aeiou",
"uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"iAgent" : {
"port" : 5249
},
"marked-for-delete" : true,
"system-id" : "aeiou",
"vendor" : {
"arista" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "eos",
"platform" : "aeiou"
},
"linux" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"platform" : "aeiou"
},
"juniper" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "junos",
"platform" : "aeiou"
},
"cisco" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "iosxr",
"platform" : "aeiou"
},
"other-vendor" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"vendor-name" : "aeiou",
"platform" : "aeiou"
},
"paloalto" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "panos",
"platform" : "aeiou"
}
},
"name" : "aeiou",
"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 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 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
Example data
Content-Type: application/json
{
"reports" : [ "aeiou" ],
"ingest-frequency" : [ "aeiou" ],
"description" : "aeiou",
"playbooks" : [ "aeiou" ],
"scheduler" : [ {
"schedule" : "aeiou",
"instance-id" : "aeiou",
"rule" : "aeiou",
"playbook" : "aeiou"
} ],
"root-cause-analysis" : {
"no-rca" : [ "{}" ],
"exclude-resources" : [ "aeiou" ],
"dynamic-resources" : [ "aeiou" ]
},
"notification" : {
"normal" : [ "aeiou" ],
"major" : [ "aeiou" ],
"minor" : [ "aeiou" ],
"enable" : [ "{}" ]
},
"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"
} ],
"action-scheduler" : {
"disable-trigger-action-schedulers" : true
},
"logging" : {
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"resource-discovery" : {
"log-level" : "error"
},
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
}
},
"tagging-profile" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the 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
Example data
Content-Type: application/json
{
"network-group" : [ {
"reports" : [ "aeiou" ],
"ingest-frequency" : [ "aeiou" ],
"description" : "aeiou",
"playbooks" : [ "aeiou" ],
"scheduler" : [ {
"schedule" : "aeiou",
"instance-id" : "aeiou",
"rule" : "aeiou",
"playbook" : "aeiou"
} ],
"root-cause-analysis" : {
"no-rca" : [ "{}" ],
"exclude-resources" : [ "aeiou" ],
"dynamic-resources" : [ "aeiou" ]
},
"notification" : {
"normal" : [ "aeiou" ],
"major" : [ "aeiou" ],
"minor" : [ "aeiou" ],
"enable" : [ "{}" ]
},
"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"
} ],
"action-scheduler" : {
"disable-trigger-action-schedulers" : true
},
"logging" : {
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"resource-discovery" : {
"log-level" : "error"
},
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
}
},
"tagging-profile" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the 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 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
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"
},
"amqp-publish" : {
"vhost" : "aeiou",
"sasl" : {
"ca-profile" : "aeiou",
"password" : "aeiou",
"server-common-name" : "aeiou",
"local-certificate" : "aeiou",
"username" : "aeiou"
},
"port" : 5249,
"host" : "aeiou",
"exchange" : "aeiou",
"routing-key" : "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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/x-gzip
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
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"
},
"amqp-publish" : {
"vhost" : "aeiou",
"sasl" : {
"ca-profile" : "aeiou",
"password" : "aeiou",
"server-common-name" : "aeiou",
"local-certificate" : "aeiou",
"username" : "aeiou"
},
"port" : 5249,
"host" : "aeiou",
"exchange" : "aeiou",
"routing-key" : "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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
notifications_schema
400
Internal Error
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 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
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 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
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 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
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 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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
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 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
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
system-settings_schema
400
Internal Error
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
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the 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 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
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
rule_schema
400
Internal Error
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 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
Example data
Content-Type: application/json
{
"sub-topics" : [ "aeiou" ],
"resource" : [ {
"depends-on" : [ {
"depends-on-multiple-instances" : true,
"with-capture-group" : [ "" ],
"description" : "aeiou",
"resource-name" : "aeiou",
"term" : [ {
"next" : true,
"term-name" : "aeiou",
"with-capture-group" : [ "" ],
"get-dependencies-from-cache" : {
"path" : "aeiou"
},
"for-every-network-group" : {
"in-groups" : [ "aeiou" ],
"label-as" : "aeiou",
"across-all-network-groups" : true
},
"user-defined-function" : {
"argument" : [ "" ],
"function-name" : "aeiou"
},
"locate-resource" : [ {
"with-capture-group" : [ {
"field-name" : "aeiou",
"capture-group-name" : "aeiou",
"expression" : "aeiou",
"ignore-case" : true
} ],
"resource" : "aeiou",
"where" : {
"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" : [ {
"right-operand" : "aeiou",
"ignore-case" : "",
"left-operand" : "aeiou"
} ],
"less-than" : [ "" ],
"greater-than" : [ "" ],
"user-defined-function" : [ {
"argument" : [ {
"argument-name" : "aeiou",
"value" : "aeiou"
} ],
"function-name" : "aeiou"
} ],
"not-equal-to" : [ "" ]
},
"label-as" : "aeiou"
} ],
"for-every-device" : {
"in-groups" : [ "aeiou" ],
"across-all-device-groups" : true,
"label-as" : "aeiou"
}
} ],
"triggered-by" : [ "aeiou" ]
} ],
"field" : [ {
"field-name" : "aeiou",
"description" : "aeiou",
"source" : {
"rule" : [ {
"field-name" : "aeiou",
"rule-name" : "aeiou"
} ]
},
"type" : "string"
} ],
"keys" : [ "aeiou" ],
"function" : [ {
"path" : "aeiou",
"argument" : [ {
"argument-name" : "aeiou",
"mandatory" : ""
} ],
"function-name" : "aeiou",
"method" : "aeiou",
"description" : "aeiou"
} ],
"description" : "aeiou",
"resource-name" : "aeiou",
"is-default" : true,
"is-modified" : true
} ],
"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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/x-gzip
Responses
200
Successful operation
topic_schema
400
Internal Error
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
Example data
Content-Type: application/json
{
"topic" : [ {
"sub-topics" : [ "aeiou" ],
"resource" : [ {
"depends-on" : [ {
"depends-on-multiple-instances" : true,
"with-capture-group" : [ "" ],
"description" : "aeiou",
"resource-name" : "aeiou",
"term" : [ {
"next" : true,
"term-name" : "aeiou",
"with-capture-group" : [ "" ],
"get-dependencies-from-cache" : {
"path" : "aeiou"
},
"for-every-network-group" : {
"in-groups" : [ "aeiou" ],
"label-as" : "aeiou",
"across-all-network-groups" : true
},
"user-defined-function" : {
"argument" : [ "" ],
"function-name" : "aeiou"
},
"locate-resource" : [ {
"with-capture-group" : [ {
"field-name" : "aeiou",
"capture-group-name" : "aeiou",
"expression" : "aeiou",
"ignore-case" : true
} ],
"resource" : "aeiou",
"where" : {
"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" : [ {
"right-operand" : "aeiou",
"ignore-case" : "",
"left-operand" : "aeiou"
} ],
"less-than" : [ "" ],
"greater-than" : [ "" ],
"user-defined-function" : [ {
"argument" : [ {
"argument-name" : "aeiou",
"value" : "aeiou"
} ],
"function-name" : "aeiou"
} ],
"not-equal-to" : [ "" ]
},
"label-as" : "aeiou"
} ],
"for-every-device" : {
"in-groups" : [ "aeiou" ],
"across-all-device-groups" : true,
"label-as" : "aeiou"
}
} ],
"triggered-by" : [ "aeiou" ]
} ],
"field" : [ {
"field-name" : "aeiou",
"description" : "aeiou",
"source" : {
"rule" : [ {
"field-name" : "aeiou",
"rule-name" : "aeiou"
} ]
},
"type" : "string"
} ],
"keys" : [ "aeiou" ],
"function" : [ {
"path" : "aeiou",
"argument" : [ {
"argument-name" : "aeiou",
"mandatory" : ""
} ],
"function-name" : "aeiou",
"method" : "aeiou",
"description" : "aeiou"
} ],
"description" : "aeiou",
"resource-name" : "aeiou",
"is-default" : true,
"is-modified" : true
} ],
"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 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:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"service1" : "status1",
"service2" : "status2"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Return type
Example data
Content-Type: application/json
{
"triggers" : [ {
"name" : "aeiou",
"fields" : [ "aeiou" ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Trigger info for a network group.
trigger_schema
default
unexpected error
Error
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the 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
Query parameters
ems_sanity (optional)
Query Parameter — DEBUG (Use with caution): roll-back a faulty transaction in HB-EMS communication default: false
Produces
This API call produces the following media types according to the 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
Body Parameter — organizations body object
Request headers
Produces
This API call produces the following media types according to the 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}/resource/{resource_name}/
Overwrite a resource (updateHealthbotTopicResourceResourceById)
Overwrite a rule by the resource-name. The resource-name specified in URL and the request body must match.
Path parameters
topic_name (required)
Path Parameter — ID of topic-name
resource_name (required)
Path Parameter — ID of resource-name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — resourcebody object
Request headers
Produces
This API call produces the following media types according to the 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. [Note: This API can be used freely in standalone Insights. However, for Paragon Automation, devices are managed by EMS services, DO NOT USE this API to modify device configuration. For PA, this API should only be used for modifying device specific variables or playbook start/stop.]
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
Body Parameter — devicebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — device_groupbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — device-groupsbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — devicesbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — network_groupbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — network-groupsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — notificationbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — notificationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — playbookbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — playbooksbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — retention-policies body object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — retention_policybody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulerbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulersbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — destinationsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — reportsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulerbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — schedulersbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request body
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 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
Body Parameter — rulebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — topicbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — topicsbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
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 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 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
Example data
Content-Type: application/json
{
"group-name" : "aeiou",
"value" : "{}",
"key" : "aeiou"
}
Produces
This API call produces the following media types according to the 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
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request body
Body Parameter — Debug arguments object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Successful operation
default
Unexpected error
Error
Take backup of Grafana configuration (backupGrafana)
Take backup of Grafana configuration
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Request headers
Return type
File
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
File
default
unexpected error
Error
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:
application/jsonmultipart/form-data
Request headers
Return type
File
Example data
Content-Type:
Produces
This API call produces the following media types according to the 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/dynamic-tagging/key/
Creates Dynamic-tagging key-value (createDynamicTaggingByKey)
Creates a key in Dynamic-tagging
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Dynamic-tagging object containing key-value pair
Request headers
Query parameters
key_name (required)
Query Parameter — Dynamic-tagging Key
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal 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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Successful operation
default
unexpected error
Error
Up
post /config/deployment/
Create deployment by ID (createHealthbotDeploymentDeploymentById)
Create operation of resource: deployment
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — deployment body object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
post /config/dynamic-tagging/keys/
Create dynamic-tagging by ID (createHealthbotDynamicTagging)
Create operation of resource: dynamic-tagging
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — dynamic_taggingbody 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 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/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
Body Parameter — custom_pluginbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tlive_kafkabody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ingest_mappingbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — frequency_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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/ifa/
Create ifa by ID (createHealthbotIngestIfa)
Create operation of resource: ifa
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — ifabody object
Request headers
Produces
This API call produces the following media types according to the 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/ifa/device/{id}/
Create device by ID (createHealthbotIngestIfaDeviceById)
Create operation of resource: device
Path parameters
id (required)
Path Parameter — ID of ifa device
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — devicebody object
Request headers
Produces
This API call produces the following media types according to the 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/outbound-ssh/
Create outbound-ssh by ID (createHealthbotIngestOutboundSsh)
Create operation of resource: outbound-ssh
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — outbound_ssh body object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — custom_pluginbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tlive_kafkabody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ingest_mappingbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — frequency_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tagging_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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
Body Parameter — sflowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — counter_recordbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flow_recordbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — protocolbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — samplebody object
Request headers
Produces
This API call produces the following media types according to the 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/snmp-notification/
Create snmp-notification by ID (createHealthbotIngestSnmpNotification)
Create operation of resource: snmp-notification
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — snmp_notification body object
Request headers
Produces
This API call produces the following media types according to the 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/snmp-notification/v3/usm/user/{name}/
Create SNMPv3 user by UserName(ID) (createHealthbotIngestSnmpNotificationV3UsmUserById)
Create operation of resource: snmp v3 usm user
Path parameters
name (required)
Path Parameter — User Name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — snmp_v3_usm user object
Request headers
Produces
This API call produces the following media types according to the 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/header-pattern/{name}/
Create pattern by ID (createHealthbotIngestSyslogHeaderPatternById)
Create operation of resource: header-pattern
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
Body Parameter — header_patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tagging_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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
Body Parameter — organizationbody object
Request headers
Produces
This API call produces the following media types according to the 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/rollup-summarization/field-profile/{profile_id}/
Create field-profile by ID (createHealthbotProfileRollupSummarizationFieldProfileFieldProfileById)
Create operation of resource: field-profile
Path parameters
profile_id (required)
Path Parameter — ID of profile-id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — field_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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/trigger_action/
Create trigger-action (createHealthbotSystemTriggerAction)
Create operation of resource: trigger-action
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — trigger_action object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — ingest_settingsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — templatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — native_gpbbody object
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request body
Body Parameter — ingest_settingsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — templatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — syslogbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — pattern_setbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — syslogbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — pattern_setbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — raw_data_summarizationbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ca_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — local_certificatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ssh_key_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — profilebody object
Request headers
Produces
This API call produces the following media types according to the 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/paa/{paa_name}/
Update paa by paa name (createIngestPaaByPaaName)
Create operation of resource: paa by paa_name
Path parameters
paa_name (required)
Path Parameter — name of paa setup
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — paa body object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
delete /config/dynamic-tagging/key/
Delete Dynamic-tagging key-value (deleteDynamicTaggingByKey)
Update a key in Dynamic-tagging
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
key_name (required)
Query Parameter — Dynamic-tagging Key
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Query parameters
input_path (optional)
Query Parameter — Input path
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
204
Successful operation
default
unexpected error
Error
Up
delete /config/deployment/
Delete deployment by ID (deleteHealthbotDeploymentDeploymentById)
Delete operation of resource: deployment
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
400
Internal Error
Up
delete /config/dynamic-tagging/keys/
Delete dynamic-tagging by ID (deleteHealthbotDynamicTagging)
Delete operation of resource: dynamic-tagging
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 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/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 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 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 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 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/ifa/
Delete ifa by ID (deleteHealthbotIngestIfa)
Delete operation of resource: ifa
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 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/ifa/device/{id}/
Delete device by ID (deleteHealthbotIngestIfaDeviceById)
Delete operation of resource: device
Path parameters
id (required)
Path Parameter — ID of ifa device
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 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/outbound-ssh/
Delete outbound-ssh by ID (deleteHealthbotIngestOutboundSsh)
Delete operation of resource: outbound-ssh
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 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/paa/{paa_name}/
Delete paa setup by paa name (deleteHealthbotIngestPaaByPaaName)
Delete operation of resource: paa by paa name
Path parameters
paa_name (required)
Path Parameter — name of paa setup
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 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 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 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 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 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 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 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 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 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 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 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 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/snmp-notification/
Delete snmp-notification (deleteHealthbotIngestSnmpNotification)
Delete operation of resource: snmp-notification
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 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/snmp-notification/v3/usm/user/{name}/
Delete SNMPv3 user by UserName(ID) (deleteHealthbotIngestSnmpNotificationV3UsmUserById)
Delete operation of resource: snmp v3 usm user
Path parameters
name (required)
Path Parameter — User 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 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/header-pattern/{name}/
Delete pattern by ID (deleteHealthbotIngestSyslogHeaderPatternById)
Delete operation of resource: header-pattern
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 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 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 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 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/rollup-summarization/field-profile/{profile_id}/
Delete field-profile by ID (deleteHealthbotProfileRollupSummarizationFieldProfileFieldProfileById)
Delete operation of resource: field-profile
Path parameters
profile_id (required)
Path Parameter — ID of profile-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 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 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/trigger_action/
Delete trigger-action schedulers (deleteHealthbotSystemTriggerAction)
Delete operation of resource: trigger-action
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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
400
Internal Error
Up
get /config/dynamic-tagging/key/
Get value of corresponding Dynamic-tagging key (getDynamicTaggingByKey)
Get Value of corresponding key from dynamic-tagging
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
key_name (required)
Query Parameter — Dynamic-tagging Key
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
String
400
Internal Error
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:
application/jsonmultipart/form-data
Query parameters
xpath (required)
Query Parameter — XPATH
timestamp (optional)
Query Parameter — Timestamp
Return type
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Successful operation
field-capture_schema
default
unexpected error
Error
Login to grafana (grafanaLogin)
Login to Grafana
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal 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
Body Parameter — command-rpc object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
default
Unexpected error
Error
Up
post /grafana/restore/
Restore Grafana configuration (restoreGrafana)
Restore Grafana configuration
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Query parameters
job_id (optional)
Query Parameter — Id of Job format: uuid
job_status (optional)
Query Parameter — Type of job
Return type
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
Example data
Content-Type: application/json
[ {
"db_name" : "aeiou",
"retention_policy" : "aeiou",
"name" : "aeiou",
"type" : "Prediction table"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
List of tags in the given table
Example data
Content-Type: application/json
[Value-1, Value-2]
default
unexpected error
Error
(retrieveDebugJobs)
Return the status of the last "/debug/" job
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Successful creation of job.
default
unexpected error
Error
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
List of events
default
unexpected error
Error
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:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/octet-streamapplication/json
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/octet-streamapplication/json
Responses
200
Successful operation
File
Example data
Content-Type: application/json
FILE CONTENT
default
unexpected error
Error
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:
application/jsonmultipart/form-data
Request headers
Return type
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 Parameter — device-group-name of device-group
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 Parameter — device-id of device
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 Parameter — network-group-name of network-group
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Health Tree of network-group
networkHealthTree
default
unexpected error
Error
Up
get /config/deployment/
Retrieve deployment (retrieveHealthbotDeploymentDeployment)
Retrieve operation of resource: deployment
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
Example data
Content-Type: application/json
{
"deployment" : {
"kubernetes" : {
"loadbalancer" : {
"snmp-proxy" : {
"virtual-ip-address" : "aeiou"
}
}
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
deployment_schema
400
Internal Error
Up
post /deployed-device-details/
Get device-identifying details by for specified UUIDs. (retrieveHealthbotDeviceDetailsByUuids)
Get device-identifying details (device-id and TSDB databases if playbooks are deployed on it) for all the UUIDs present in the request body.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — device_uuids object
Request headers
Return type
Example data
Content-Type: application/json
[ {
"1000-1000-1000-1000" : {
"device-id" : "r1",
"groups" : [ "Core1", "Core2" ],
"databases" : {
"Core1" : "Core1:r1",
"Core2" : "Core2:r1"
}
}
}, {
"2000-2000-2000-2000" : {
"device-id" : "r2",
"groups" : [ "Core1", "Core3" ],
"databases" : {
"Core1" : "Core1:r2",
"Core2" : "Core3:r2"
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
device-details_schema
Example data
Content-Type: application/json
[{1000-1000-1000-1000={device-id=r1, groups=[Core1, Core2], databases={Core1=Core1:r1, Core2=Core2:r1}}}, {2000-2000-2000-2000={device-id=r2, groups=[Core1, Core3], databases={Core1=Core1:r2, Core2=Core3:r2}}}]
500
Internal Server Error
Up
get /config/dynamic-tagging/keys/
Retrieve dynamic-tagging by ID (retrieveHealthbotDynamicTagging)
Retrieve operation of resource: dynamic-tagging
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
[ "aeiou" ]
Produces
This API call produces the following media types according to the 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/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
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 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
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 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
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 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 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
Example data
Content-Type: application/json
{
"open-config" : "",
"netflow" : "",
"server-monitoring" : "",
"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 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 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 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
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 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/ifa/
Retrieve ifa (retrieveHealthbotIngestIfa)
Retrieve operation of resource: ifa
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
Example data
Content-Type: application/json
{
"device" : [ {
"name" : "aeiou",
"id" : 0
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
ifa_schema
400
Internal Error
Up
get /config/ingest/ifa/device/{id}/
Retrieve device by ID (retrieveHealthbotIngestIfaDeviceById)
Retrieve operation of resource: device
Path parameters
id (required)
Path Parameter — ID of ifa 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 undeployed configuration
Return type
Example data
Content-Type: application/json
{
"name" : "aeiou",
"id" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
ifa_device_schema
400
Internal Error
Up
get /config/ingest/ifa/device/
Retrieve device (retrieveHealthbotIngestIfaDeviceIds)
Retrieve operation of resource: 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 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 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/ifa/devices/
Retrieve devices (retrieveHealthbotIngestIfaDevices)
Retrieve operation of resource: 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 undeployed configuration
Return type
Example data
Content-Type: application/json
[ {
"name" : "aeiou",
"id" : 0
} ]
Produces
This API call produces the following media types according to the 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/outbound-ssh/
Retrieve outbound-ssh (retrieveHealthbotIngestOutboundSsh)
Retrieve operation of resource: outbound-ssh
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
Example data
Content-Type: application/json
{
"outbound-ssh" : {
"port" : 5249
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
outbound-ssh_schema
400
Internal Error
Up
get /config/ingest/paa/{paa_name}/
Retrieve paa setup config by paa name (retrieveHealthbotIngestPaaByPaaName)
Retrieve operation of resource: paa by paa_name
Path parameters
paa_name (required)
Path Parameter — name of paa setup
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
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" ],
"name" : "aeiou",
"paa-account" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
paa-setup_schema
404
Setup not found
500
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
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 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
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 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
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 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 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
Example data
Content-Type: application/json
{
"open-config" : "",
"netflow" : "",
"server-monitoring" : "",
"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 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 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 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
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 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/paa/
Retrieve paas (retrieveHealthbotIngestSettingsPaa)
Retrieve operation of resource: paa
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
Example data
Content-Type: application/json
{
"paa-setup" : [ {
"security" : {
"sasl" : {
"password" : "aeiou",
"username" : "aeiou"
},
"tls" : {
"local-certificate-profile" : "aeiou",
"ca-profile" : "aeiou",
"insecure-skip-verify" : true
}
},
"brokers" : [ "aeiou" ],
"name" : "aeiou",
"paa-account" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
paa-setup_schemas
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
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" : [ {
"in-memory" : true,
"name" : "aeiou",
"type" : "string",
"value" : "aeiou"
} ],
"add-key" : [ {
"in-memory" : true,
"name" : "aeiou",
"value" : "aeiou"
} ]
},
"when" : {
"less-than-or-equal-to" : [ "" ],
"equal-to" : [ {
"in-memory" : true,
"right-operand" : "aeiou",
"left-operand" : "aeiou"
} ],
"eval" : [ {
"expression" : "aeiou"
} ],
"greater-than-or-equal-to" : [ "" ],
"does-not-match-with" : [ {
"in-memory" : true,
"right-operand" : "aeiou",
"left-operand" : "aeiou"
} ],
"matches-with" : [ "" ],
"does-not-match-with-scheduler" : "",
"exists" : [ {
"path" : "aeiou",
"field" : "aeiou",
"in-memory" : true
} ],
"less-than" : [ "" ],
"greater-than" : [ "" ],
"not-equal-to" : [ "" ],
"matches-with-scheduler" : {
"scheduler" : "aeiou",
"in-memory" : true,
"time" : "aeiou"
}
}
} ]
} ]
}
Produces
This API call produces the following media types according to the 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 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
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 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
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 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
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 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
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 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
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 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/snmp-notification/
Retrieve snmp-notification (retrieveHealthbotIngestSnmpNotification)
Retrieve operation of resource: snmp-notification
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
Example data
Content-Type: application/json
{
"snmp-notification" : {
"port" : 0,
"engine-id" : "aeiou",
"v3" : {
"usm" : {
"users" : [ {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
} ]
}
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
snmp-notification_schema
400
Internal Error
Up
get /config/ingest/snmp-notification/v3/usm/user/{name}/
Retrieve SNMPv3 user by UserName(ID) (retrieveHealthbotIngestSnmpNotificationV3UsmUserById)
Retrieve operation of resource: snmp v3 usm user
Path parameters
name (required)
Path Parameter — User 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
Example data
Content-Type: application/json
{
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
snmpv3-usm-user_schema
400
Internal Error
Up
get /config/ingest/snmp-notification/v3/usm/user/
Retrieve snmp v3 usm user names (retrieveHealthbotIngestSnmpNotificationV3UsmUsernames)
Retrieve operation of resource: snmp v3 usm user 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 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 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/snmp-notification/v3/usm/users/
Retrieve SNMP v3 USM users (retrieveHealthbotIngestSnmpNotificationV3UsmUsers)
Retrieve operation of resource: SNMP v3 USM users
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
Example data
Content-Type: application/json
[ {
"users" : [ {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
} ]
} ]
Produces
This API call produces the following media types according to the 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/header-pattern/{name}/
Retrieve pattern by ID (retrieveHealthbotIngestSyslogHeaderPatternById)
Retrieve operation of resource: header-pattern
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
Example data
Content-Type: application/json
{
"filter" : "aeiou",
"field" : [ {
"name" : "aeiou",
"description" : "aeiou",
"from" : "aeiou",
"type" : "integer"
} ],
"name" : "aeiou",
"description" : "aeiou",
"key-fields" : [ "aeiou" ],
"filter-type" : "regex"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
header-pattern_schema
400
Internal Error
Up
get /config/ingest/syslog/header-pattern/
Retrieve header pattern names (retrieveHealthbotIngestSyslogHeaderPatternIds)
Retrieve operation of resource: header-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 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/header-patterns/
Retrieve header patterns (retrieveHealthbotIngestSyslogHeaderPatterns)
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
Example data
Content-Type: application/json
[ {
"filter" : "aeiou",
"field" : [ {
"name" : "aeiou",
"description" : "aeiou",
"from" : "aeiou",
"type" : "integer"
} ],
"name" : "aeiou",
"description" : "aeiou",
"key-fields" : [ "aeiou" ],
"filter-type" : "regex"
} ]
Produces
This API call produces the following media types according to the 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/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
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" : [ {
"in-memory" : true,
"name" : "aeiou",
"type" : "string",
"value" : "aeiou"
} ],
"add-key" : [ {
"in-memory" : true,
"name" : "aeiou",
"value" : "aeiou"
} ]
},
"when" : {
"less-than-or-equal-to" : [ "" ],
"equal-to" : [ {
"in-memory" : true,
"right-operand" : "aeiou",
"left-operand" : "aeiou"
} ],
"eval" : [ {
"expression" : "aeiou"
} ],
"greater-than-or-equal-to" : [ "" ],
"does-not-match-with" : [ {
"in-memory" : true,
"right-operand" : "aeiou",
"left-operand" : "aeiou"
} ],
"matches-with" : [ "" ],
"does-not-match-with-scheduler" : "",
"exists" : [ {
"path" : "aeiou",
"field" : "aeiou",
"in-memory" : true
} ],
"less-than" : [ "" ],
"greater-than" : [ "" ],
"not-equal-to" : [ "" ],
"matches-with-scheduler" : {
"scheduler" : "aeiou",
"in-memory" : true,
"time" : "aeiou"
}
}
} ]
} ]
}
Produces
This API call produces the following media types according to the 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 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 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
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 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/profile/rollup-summarization/field-profile/{profile_id}/
Retrieve field-profile by ID (retrieveHealthbotProfileRollupSummarizationFieldProfileFieldProfileById)
Retrieve operation of resource: field-profile
Path parameters
profile_id (required)
Path Parameter — ID of profile-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 undeployed configuration
Return type
Example data
Content-Type: application/json
{
"data-rollup-order" : [ {
"instance-id" : "aeiou",
"interval" : "aeiou",
"retention-policy" : "aeiou"
} ],
"database" : [ {
"database-name" : "aeiou",
"measurement" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"measurement-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
} ],
"profile-id" : "aeiou",
"rule" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"rule-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
rollup-summarization_schema
400
Internal Error
Up
get /config/profile/rollup-summarization/field-profile/
Retrieve field-profile (retrieveHealthbotProfileRollupSummarizationFieldProfileProfile)
Retrieve operation of resource: field-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
Example data
Content-Type: application/json
{
"field-profile" : [ {
"data-rollup-order" : [ {
"instance-id" : "aeiou",
"interval" : "aeiou",
"retention-policy" : "aeiou"
} ],
"database" : [ {
"database-name" : "aeiou",
"measurement" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"measurement-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
} ],
"profile-id" : "aeiou",
"rule" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"rule-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
rollup-summarizations_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
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 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/system/trigger_action/
Retrieve trigger-action (retrieveHealthbotSystemTriggerAction)
Retrieve operation of resource: trigger-action
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
Example data
Content-Type: application/json
{
"schedulers" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
trigger_action_schema
400
Internal Error
Up
get /config/topic/{topic_name}/resource/
List all resource-names in a topic (retrieveHealthbotTopicResourceResource)
Get a list of all the resource-name`s 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
[ "resource-1", "resource-2" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
Example data
Content-Type: application/json
[resource-1, resource-2]
400
Internal Error
Up
get /config/topic/{topic_name}/resource/{resource_name}/
Get a resource's configuration (retrieveHealthbotTopicResourceResourceById)
Get the configuration details of a resource by resource-name
Path parameters
topic_name (required)
Path Parameter — ID of topic-name
resource_name (required)
Path Parameter — ID of resource-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 .resource file
Return type
Example data
Content-Type: application/json
{
"depends-on" : [ {
"depends-on-multiple-instances" : true,
"with-capture-group" : [ "" ],
"description" : "aeiou",
"resource-name" : "aeiou",
"term" : [ {
"next" : true,
"term-name" : "aeiou",
"with-capture-group" : [ "" ],
"get-dependencies-from-cache" : {
"path" : "aeiou"
},
"for-every-network-group" : {
"in-groups" : [ "aeiou" ],
"label-as" : "aeiou",
"across-all-network-groups" : true
},
"user-defined-function" : {
"argument" : [ "" ],
"function-name" : "aeiou"
},
"locate-resource" : [ {
"with-capture-group" : [ {
"field-name" : "aeiou",
"capture-group-name" : "aeiou",
"expression" : "aeiou",
"ignore-case" : true
} ],
"resource" : "aeiou",
"where" : {
"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" : [ {
"right-operand" : "aeiou",
"ignore-case" : "",
"left-operand" : "aeiou"
} ],
"less-than" : [ "" ],
"greater-than" : [ "" ],
"user-defined-function" : [ {
"argument" : [ {
"argument-name" : "aeiou",
"value" : "aeiou"
} ],
"function-name" : "aeiou"
} ],
"not-equal-to" : [ "" ]
},
"label-as" : "aeiou"
} ],
"for-every-device" : {
"in-groups" : [ "aeiou" ],
"across-all-device-groups" : true,
"label-as" : "aeiou"
}
} ],
"triggered-by" : [ "aeiou" ]
} ],
"field" : [ {
"field-name" : "aeiou",
"description" : "aeiou",
"source" : {
"rule" : [ {
"field-name" : "aeiou",
"rule-name" : "aeiou"
} ]
},
"type" : "string"
} ],
"keys" : [ "aeiou" ],
"function" : [ {
"path" : "aeiou",
"argument" : [ {
"argument-name" : "aeiou",
"mandatory" : ""
} ],
"function-name" : "aeiou",
"method" : "aeiou",
"description" : "aeiou"
} ],
"description" : "aeiou",
"resource-name" : "aeiou",
"is-default" : true,
"is-modified" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
resource_schema
400
Internal Error
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
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the 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
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 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
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 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 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
Example data
Content-Type: application/json
{
"native-gpb" : {
"port" : 5249
}
}
Produces
This API call produces the following media types according to the 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
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the 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
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 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
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 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 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
Example data
Content-Type: application/json
{
"syslog" : {
"header-pattern" : [ {
"filter" : "aeiou",
"field" : [ {
"name" : "aeiou",
"description" : "aeiou",
"from" : "aeiou",
"type" : "integer"
} ],
"name" : "aeiou",
"description" : "aeiou",
"key-fields" : [ "aeiou" ],
"filter-type" : "regex"
} ],
"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 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
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 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 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
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 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 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
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 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
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 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
Example data
Content-Type: application/json
{
"syslog" : {
"header-pattern" : [ {
"filter" : "aeiou",
"field" : [ {
"name" : "aeiou",
"description" : "aeiou",
"from" : "aeiou",
"type" : "integer"
} ],
"name" : "aeiou",
"description" : "aeiou",
"key-fields" : [ "aeiou" ],
"filter-type" : "regex"
} ],
"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 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
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 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 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
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 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 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
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 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
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 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
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 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
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 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
Example data
Content-Type: application/json
{
"certificate-authority-crt" : "aeiou",
"name" : "aeiou"
}
Produces
This API call produces the following media types according to the 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 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
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 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 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
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 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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Example data
Content-Type: application/json
{
"profile" : {
"rollup-summarization" : {
"field-profile" : [ {
"data-rollup-order" : [ {
"instance-id" : "aeiou",
"interval" : "aeiou",
"retention-policy" : "aeiou"
} ],
"database" : [ {
"database-name" : "aeiou",
"measurement" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"measurement-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
} ],
"profile-id" : "aeiou",
"rule" : [ {
"field" : [ {
"aggregate-function" : [ "mean" ],
"name" : "aeiou"
} ],
"rule-name" : "aeiou",
"apply-on-existing-data" : ""
} ]
} ]
},
"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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
profiles_schema
400
Internal Error
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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/dynamic-tagging/key/
Updates Dynamic-tagging key-value (updateDynamicTaggingByKey)
Update operation of Dynamic-tagging key
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Dynamic-tagging object containing key-value pair
Request headers
Query parameters
key_name (required)
Query Parameter — Dynamic-tagging Key
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
put /config/deployment/
Update deployment by ID (updateHealthbotDeploymentDeploymentById)
Update operation of resource: deployment
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — deploymentbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
put /config/dynamic-tagging/keys/
Update dynamic-tagging by ID (updateHealthbotDynamicTagging)
Update operation of resource: dynamic-tagging
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — dynamic_taggingbody 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 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/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
Body Parameter — custom_pluginbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tlive_kafka body object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ingest_mappingbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — frequency_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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/ifa/
Update ifa by ID (updateHealthbotIngestIfa)
Update operation of resource: ifa
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — ifabody object
Request headers
Produces
This API call produces the following media types according to the 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/ifa/device/{id}/
Update device by ID (updateHealthbotIngestIfaDeviceById)
Update operation of resource: device
Path parameters
id (required)
Path Parameter — ID of ifa device
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — devicebody object
Request headers
Produces
This API call produces the following media types according to the 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/outbound-ssh/
Update outbound-ssh by ID (updateHealthbotIngestOutboundSsh)
Update operation of resource: outbound-ssh
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — outbound_sshbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — custom_pluginbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tlive_kafka body object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ingest_mappingbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — frequency_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tagging_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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
Body Parameter — sflowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — counter_recordbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flow_recordbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — protocolbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — samplebody object
Request headers
Produces
This API call produces the following media types according to the 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/snmp-notification/
Update snmp-notification by ID (updateHealthbotIngestSnmpNotification)
Update operation of resource: snmp-notification
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — snmp_notification body object
Request headers
Produces
This API call produces the following media types according to the 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/snmp-notification/v3/usm/user/{name}/
Update SNMPv3 user by UserName(ID) (updateHealthbotIngestSnmpNotificationV3UsmUserById)
Update operation of resource: snmp v3 usm user
Path parameters
name (required)
Path Parameter — User Name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — snmp_v3_usm user object
Request headers
Produces
This API call produces the following media types according to the 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/header-pattern/{name}/
Update pattern by ID (updateHealthbotIngestSyslogHeaderPatternById)
Update operation of resource: header-pattern
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
Body Parameter — header_patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — tagging_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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
Body Parameter — organizationbody object
Request headers
Produces
This API call produces the following media types according to the 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/rollup-summarization/field-profile/{profile_id}/
Update field-profile by ID (updateHealthbotProfileRollupSummarizationFieldProfileFieldProfileById)
Update operation of resource: field-profile
Path parameters
profile_id (required)
Path Parameter — ID of profile-id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — field_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
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 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/trigger_action/
Update trigger-action (updateHealthbotSystemTriggerAction)
Update operation of resource: trigger-action
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — trigger_action object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — ingest_settingsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — templatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — native_gpbbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ingest_settingsbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — flowbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — templatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — syslogbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — pattern_setbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — syslogbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — patternbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — pattern_setbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — raw_data_summarizationbody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ca_profilebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — local_certificatebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — ssh_key_profilebody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — profilebody object
Request headers
Produces
This API call produces the following media types according to the 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/paa/{paa_name}/
Update paa by paa name (updateIngestPaaByPaaName)
Update operation of resource: paa by paa_name
Path parameters
paa_name (required)
Path Parameter — name of paa setup
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — paa body object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful loaded HTML page
default
unexpected error
Error
Get all All API's. (retrieveInsightsApi)
GET static api documentation
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful loaded HTML page
default
unexpected error
Error
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:
application/jsonmultipart/form-data
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
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
},
"port" : 39501
},
"server-monitoring" : "",
"use-ingest-receive-time" : [ "{}" ],
"outbound-ssh" : {
"disable" : true
},
"timezone" : "aeiou",
"description" : "aeiou",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "aeiou",
"source-id" : {
"source-ip-addresses" : [ "aeiou" ]
}
},
"v3" : {
"source-id" : {
"source-ip-addresses" : [ "aeiou" ],
"context-engine-id" : "aeiou"
},
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"source-ip-addresses" : [ "aeiou" ],
"hostnames" : [ "aeiou" ]
},
"device-id" : "aeiou",
"uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"iAgent" : {
"port" : 5249
},
"marked-for-delete" : true,
"system-id" : "aeiou",
"vendor" : {
"arista" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "eos",
"platform" : "aeiou"
},
"linux" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"platform" : "aeiou"
},
"juniper" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "junos",
"platform" : "aeiou"
},
"cisco" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "iosxr",
"platform" : "aeiou"
},
"other-vendor" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"vendor-name" : "aeiou",
"platform" : "aeiou"
},
"paloalto" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "panos",
"platform" : "aeiou"
}
},
"name" : "aeiou",
"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 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:
application/jsonmultipart/form-data
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
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
},
"port" : 39501
},
"server-monitoring" : "",
"use-ingest-receive-time" : [ "{}" ],
"outbound-ssh" : {
"disable" : true
},
"timezone" : "aeiou",
"description" : "aeiou",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "aeiou",
"source-id" : {
"source-ip-addresses" : [ "aeiou" ]
}
},
"v3" : {
"source-id" : {
"source-ip-addresses" : [ "aeiou" ],
"context-engine-id" : "aeiou"
},
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"source-ip-addresses" : [ "aeiou" ],
"hostnames" : [ "aeiou" ]
},
"device-id" : "aeiou",
"uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"iAgent" : {
"port" : 5249
},
"marked-for-delete" : true,
"system-id" : "aeiou",
"vendor" : {
"arista" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "eos",
"platform" : "aeiou"
},
"linux" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"platform" : "aeiou"
},
"juniper" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "junos",
"platform" : "aeiou"
},
"cisco" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "iosxr",
"platform" : "aeiou"
},
"other-vendor" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"vendor-name" : "aeiou",
"platform" : "aeiou"
},
"paloalto" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "panos",
"platform" : "aeiou"
}
},
"name" : "aeiou",
"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 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:
application/jsonmultipart/form-data
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
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"open-config" : {
"initial-sync" : true,
"gnmi" : {
"enable" : true,
"encoding" : "protobuf"
},
"port" : 39501
},
"server-monitoring" : "",
"use-ingest-receive-time" : [ "{}" ],
"outbound-ssh" : {
"disable" : true
},
"timezone" : "aeiou",
"description" : "aeiou",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "aeiou",
"source-id" : {
"source-ip-addresses" : [ "aeiou" ]
}
},
"v3" : {
"source-id" : {
"source-ip-addresses" : [ "aeiou" ],
"context-engine-id" : "aeiou"
},
"usm" : {
"privacy-none" : "",
"authentication-none" : "",
"privacy" : {
"protocol" : "DES",
"passphrase" : "aeiou"
},
"snmp-proxy-forwarder" : {
"security-engine-id" : "aeiou"
},
"authentication" : {
"protocol" : "MD5",
"passphrase" : "aeiou"
},
"username" : "aeiou"
}
}
},
"syslog" : {
"source-ip-addresses" : [ "aeiou" ],
"hostnames" : [ "aeiou" ]
},
"device-id" : "aeiou",
"uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"iAgent" : {
"port" : 5249
},
"marked-for-delete" : true,
"system-id" : "aeiou",
"vendor" : {
"arista" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "eos",
"platform" : "aeiou"
},
"linux" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"platform" : "aeiou"
},
"juniper" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "junos",
"platform" : "aeiou"
},
"cisco" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "iosxr",
"platform" : "aeiou"
},
"other-vendor" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "aeiou",
"vendor-name" : "aeiou",
"platform" : "aeiou"
},
"paloalto" : {
"product" : "aeiou",
"release" : "aeiou",
"operating-system" : "panos",
"platform" : "aeiou"
}
},
"name" : "aeiou",
"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 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/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
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 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
Body Parameter — List of instances and their scheduled state
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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
Example data
Content-Type: application/json
{
"license-id" : "license-id-string"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_2
Example data
Content-Type: application/json
{license-id=license-id-string}
default
unexpected error
Error
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the 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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
default
unexpected error
Error
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:
application/jsonmultipart/form-data
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 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
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:
application/jsonmultipart/form-data
Request headers
Return type
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 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 request header;
the media type will be conveyed by the
Content-Type response header.
application/octet-streamapplication/json
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:
application/jsonmultipart/form-data
Request headers
Return type
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 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
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 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
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
Body Parameter — License raw keys contents
Request headers
Return type
Example data
Content-Type: application/json
{
"license-id" : "license-id-string"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_2
Example data
Content-Type: application/json
{license-id=license-id-string}
default
unexpected error
Error
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/gzipapplication/json
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/gzipapplication/jsontext/plain
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/gzipapplication/json
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/gzipapplication/jsontext/plain
Responses
200
Successful operation
400
Internal Error
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
Body Parameter — edgebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — sitebody object
Request headers
Produces
This API call produces the following media types according to the 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 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 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
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 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
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 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
Body Parameter — edgebody object
Request headers
Produces
This API call produces the following media types according to the 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
Body Parameter — sitebody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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 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 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
Up
get /config/rca/generate-resource-dependencies
Resource dependencies (generateResourceDependencies)
Get resource dependency events. Internal API
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
default
unexpected error
Error
TSDB query (queryTsdb)
Query TSDB
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
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
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 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
TSDB query (queryTsdbPost)
Query TSDB
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
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
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 request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
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
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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the 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:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the 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
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:
application/jsonmultipart/form-data
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
default
unexpected error
Error
TSDB counters (retrieveTsdbCounters)
Get TSDB counters
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonmultipart/form-data
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
default
unexpected error
Error
Decode string with Junos (junosdecode)
Decode string with Junos
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — String to Encode with Junos
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200
default
unexpected error
Error
Encode string with Junos (junosencode)
Encode string with Junos
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — String to Encode with Junos
Request headers
Return type
Example data
Content-Type: application/json
{
"data" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200
default
unexpected error
Error
Up
post /config/workflow/{workflow_name}/
Create workflow by ID (createHealthbotWorkflowWorkflowById)
Create operation of resource: workflow
Path parameters
workflow_name (required)
Path Parameter — ID of workflow-name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — workflowbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
post /config/workflows/
Create workflow by ID (createHealthbotWorkflowsWorkflowById)
Create/Update multiple workflows. The new content for the existing workflows updates the existing content and the new workflows are created.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — workflowbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
delete /config/workflow/{workflow_name}/
Delete workflow by ID (deleteHealthbotWorkflowWorkflowById)
Delete operation of resource: workflow
Path parameters
workflow_name (required)
Path Parameter — ID of workflow-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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
delete /config/workflows/
Delete workflow by ID (deleteHealthbotWorkflowsWorkflowById)
Delete operation of resource: workflow
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Retrieve workflow (retrieveHealthbotWorkflowWorkflow)
Retrieve operation of resource: workflow
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
get /config/workflow/{workflow_name}/
Retrieve workflow by ID (retrieveHealthbotWorkflowWorkflowById)
Retrieve operation of resource: workflow
Path parameters
workflow_name (required)
Path Parameter — ID of workflow-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
Example data
Content-Type: application/json
{
"argument" : "",
"task" : [ {
"parallel" : [ "{}" ],
"task-name" : "aeiou",
"step" : [ {
"suspend" : {
"duration" : "aeiou"
},
"workflow" : {
"name" : "aeiou"
},
"condition-description" : "aeiou",
"cli-command" : [ {
"environment" : [ "aeiou" ],
"delay" : "10s",
"repeat" : 2.3021358869347654518833223846741020679473876953125,
"device-group" : [ "aeiou" ],
"ignore" : [ "{}" ],
"arguments" : [ "aeiou" ],
"type" : "data-xml",
"command-tag" : "aeiou",
"device" : [ "aeiou" ],
"commands" : [ {
"command" : "aeiou"
} ]
} ],
"description" : "aeiou",
"step-name" : "aeiou",
"executable" : [ "" ],
"netconf-command" : [ "" ],
"dependencies" : [ "aeiou" ],
"output" : [ {
"artifact" : {
"path" : "aeiou"
},
"result" : [ "{}" ],
"regex" : {
"pattern" : "aeiou"
},
"data-xml" : {
"xpath" : "aeiou"
},
"grok" : {
"pattern" : "aeiou"
},
"name" : "aeiou",
"description" : "aeiou",
"json" : {
"jqpath" : "aeiou"
},
"command-tag" : "aeiou"
} ],
"notification" : [ {
"payload" : "aeiou",
"tag" : "aeiou"
} ],
"input" : [ {
"artifact" : [ "{}" ],
"name" : "aeiou",
"value" : "aeiou"
} ],
"condition" : [ "aeiou" ],
"task" : {
"name" : "aeiou"
},
"condition-type" : "any"
} ]
} ],
"workflow-name" : "aeiou",
"log-level" : "info",
"batch" : 1,
"description" : "aeiou",
"exit-task" : "aeiou",
"entry-task" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_schema
400
Internal Error
Up
get /config/workflows/
Retrieve workflow by ID (retrieveHealthbotWorkflowsWorkflowById)
Retrieve operation of resource: workflow
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
Example data
Content-Type: application/json
{
"workflow" : [ {
"argument" : "",
"task" : [ {
"parallel" : [ "{}" ],
"task-name" : "aeiou",
"step" : [ {
"suspend" : {
"duration" : "aeiou"
},
"workflow" : {
"name" : "aeiou"
},
"condition-description" : "aeiou",
"cli-command" : [ {
"environment" : [ "aeiou" ],
"delay" : "10s",
"repeat" : 2.3021358869347654518833223846741020679473876953125,
"device-group" : [ "aeiou" ],
"ignore" : [ "{}" ],
"arguments" : [ "aeiou" ],
"type" : "data-xml",
"command-tag" : "aeiou",
"device" : [ "aeiou" ],
"commands" : [ {
"command" : "aeiou"
} ]
} ],
"description" : "aeiou",
"step-name" : "aeiou",
"executable" : [ "" ],
"netconf-command" : [ "" ],
"dependencies" : [ "aeiou" ],
"output" : [ {
"artifact" : {
"path" : "aeiou"
},
"result" : [ "{}" ],
"regex" : {
"pattern" : "aeiou"
},
"data-xml" : {
"xpath" : "aeiou"
},
"grok" : {
"pattern" : "aeiou"
},
"name" : "aeiou",
"description" : "aeiou",
"json" : {
"jqpath" : "aeiou"
},
"command-tag" : "aeiou"
} ],
"notification" : [ {
"payload" : "aeiou",
"tag" : "aeiou"
} ],
"input" : [ {
"artifact" : [ "{}" ],
"name" : "aeiou",
"value" : "aeiou"
} ],
"condition" : [ "aeiou" ],
"task" : {
"name" : "aeiou"
},
"condition-type" : "any"
} ]
} ],
"workflow-name" : "aeiou",
"log-level" : "info",
"batch" : 1,
"description" : "aeiou",
"exit-task" : "aeiou",
"entry-task" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflows_schema
400
Internal Error
Up
put /config/workflow/{workflow_name}/
Update workflow by ID (updateHealthbotWorkflowWorkflowById)
Update operation of resource: workflow
Path parameters
workflow_name (required)
Path Parameter — ID of workflow-name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — workflowbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
put /config/workflows/
Update workflow by ID (updateHealthbotWorkflowsWorkflowById)
Update operation of resource: workflow
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — workflowbody object
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
post /workflow-instance/{workflow_name}/
Create workflow by ID (createHealthbotWorkflowInstanceById)
Create operation of resource: workflow instance
Path parameters
workflow_name (required)
Path Parameter — ID of workflow-name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — workflowbody object
Request headers
Return type
Example data
Content-Type: application/json
{
"argument" : "",
"devices" : [ "aeiou" ],
"batch" : 1,
"workflow-instance-name" : "aeiou",
"description" : "aeiou",
"message" : "aeiou",
"finished-at" : "aeiou",
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou",
"workflow-name" : "aeiou",
"started-at" : "aeiou",
"device-groups" : [ "aeiou" ],
"created-at" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"parameters" : [ {
"value-from" : "aeiou",
"name" : "aeiou",
"value" : "aeiou"
} ],
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"status" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_instance_schema
400
Internal Error
Up
delete /workflow-instance/{workflow_name}/
Delete workflow instance by ID (deleteHealthbotWorkflowInstanceById)
Delete operation of resource: workflow instance
Path parameters
workflow_name (required)
Path Parameter — Name of the workflow
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
workflow_instance_name (optional)
Query Parameter — ID of workflow instance
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
delete /workflow-instances/
Delete workflow by ID (deleteHealthbotWorkflowInstances)
Delete operation of resource: workflow instances
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
get /workflow-instance/{workflow_name}/
Retrieve workflow by ID (retrieveHealthbotWorkflowInstanceById)
Retrieve operation of resource: workflow instance
Path parameters
workflow_name (required)
Path Parameter — Name of the workflow
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
workflow_instance_name (optional)
Query Parameter — Name of the workflow instance
extensive (optional)
Query Parameter — Get extensive information including logs
Return type
Example data
Content-Type: application/json
{
"workflow" : [ {
"argument" : "",
"devices" : [ "aeiou" ],
"batch" : 1,
"workflow-instance-name" : "aeiou",
"description" : "aeiou",
"message" : "aeiou",
"finished-at" : "aeiou",
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou",
"workflow-name" : "aeiou",
"started-at" : "aeiou",
"device-groups" : [ "aeiou" ],
"created-at" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"parameters" : [ {
"value-from" : "aeiou",
"name" : "aeiou",
"value" : "aeiou"
} ],
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_instances_schema
400
Internal Error
Up
get /workflow-instances/
Retrieve workflow instances (retrieveHealthbotWorkflowInstances)
Retrieve operation of all workflow instances
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"workflow" : [ {
"argument" : "",
"devices" : [ "aeiou" ],
"batch" : 1,
"workflow-instance-name" : "aeiou",
"description" : "aeiou",
"message" : "aeiou",
"finished-at" : "aeiou",
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou",
"workflow-name" : "aeiou",
"started-at" : "aeiou",
"device-groups" : [ "aeiou" ],
"created-at" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"parameters" : [ {
"value-from" : "aeiou",
"name" : "aeiou",
"value" : "aeiou"
} ],
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_instances_schema
400
Internal Error
Up
put /workflow-instance/{workflow_name}/
Retrieve workflow by ID (updateHealthbotWorkflowInstanceById)
Update operation of resource: workflow instance
Path parameters
workflow_name (required)
Path Parameter — Name of the workflow
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
operation (required)
Query Parameter — Name of the update operation
workflow_instance_name (optional)
Query Parameter — Name of the workflow instance
Return type
Example data
Content-Type: application/json
{
"workflow" : [ {
"argument" : "",
"devices" : [ "aeiou" ],
"batch" : 1,
"workflow-instance-name" : "aeiou",
"description" : "aeiou",
"message" : "aeiou",
"finished-at" : "aeiou",
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou",
"workflow-name" : "aeiou",
"started-at" : "aeiou",
"device-groups" : [ "aeiou" ],
"created-at" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"parameters" : [ {
"value-from" : "aeiou",
"name" : "aeiou",
"value" : "aeiou"
} ],
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_instances_schema
400
Internal Error
Up
put /workflow-instances/
Update workflow instances (updateHealthbotWorkflowInstances)
Update operation of all workflow instances
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
operation (required)
Query Parameter — Name of the update operation
Return type
Example data
Content-Type: application/json
{
"workflow" : [ {
"argument" : "",
"devices" : [ "aeiou" ],
"batch" : 1,
"workflow-instance-name" : "aeiou",
"description" : "aeiou",
"message" : "aeiou",
"finished-at" : "aeiou",
"timeout" : "aeiou",
"pod-gc-strategy" : "aeiou",
"workflow-name" : "aeiou",
"started-at" : "aeiou",
"device-groups" : [ "aeiou" ],
"created-at" : "aeiou",
"cron-options" : {
"failed-jobs-history-limit" : 6,
"schedule" : "aeiou",
"starting-deadline-duration" : "aeiou",
"concurrency-policy" : "allow",
"description" : "aeiou",
"successful-jobs-history-limit" : 0
},
"parameters" : [ {
"value-from" : "aeiou",
"name" : "aeiou",
"value" : "aeiou"
} ],
"retry" : {
"backoff" : {
"duration" : "aeiou",
"factor" : 5,
"max-duration" : "aeiou"
},
"limit" : 5
},
"status" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_instances_schema
400
Internal Error
Up
get /workflow-statistics/
Retrieve workflow statistics (retrieveHealthbotWorkflowStatistics)
Retrieve operation of all workflow instances statistics
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"total_succeeded" : 0,
"total_suspended" : 0,
"description" : "aeiou",
"total_failed" : 0,
"total_run" : 0,
"total_running" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
workflow_statistics_schema
400
Internal Error
[ Jump to Methods ]
Table of Contents
Error - TsdbError - TsdbError_results - affected-groups - apply-macro_schema - applymacro_schema_data - associated_group_schema - associated_role_schema - associated_role_schema_inner - associated_user_schema - associated_user_schema_inner - ca-profile_schema - command-rpc - commit-job - counter-record_schema - credenetial - credential - custom-plugin_schema - custom-plugins_schema - customplugin_schema_parameters - customplugin_schema_securityparameters - customplugin_schema_securityparameters_tls - customplugin_schema_securityparameters_userauthentication - data - data_1 - datastore_schema - debug-arguments_schema - debug-job-response_schema - deployment_schema - deployment_schema_deployment - deployment_schema_deployment_kubernetes - deployment_schema_deployment_kubernetes_loadbalancer - deployment_schema_deployment_kubernetes_loadbalancer_snmpproxy - destination_schema - destination_schema_disk - destination_schema_email - destinations_schema - device-details_schema - device-field-capture_schema - device-group-field-capture_schema - device-group_schema - device-groups_schema - deviceGroupHealthTree - deviceHealthSchema - deviceHealthTree - device_schema - device_schema_flow - device_schema_iAgent - device_schema_openconfig - device_schema_outboundssh - device_schema_snmp - device_schema_snmp_v2 - device_schema_snmp_v2_sourceid - device_schema_snmp_v3 - device_schema_snmp_v3_sourceid - device_schema_snmp_v3_usm - device_schema_syslog - device_schema_variable - device_schema_vendor - device_schema_vendor_arista - device_schema_vendor_cisco - device_schema_vendor_juniper - device_schema_vendor_linux - device_schema_vendor_othervendor - device_schema_vendor_paloalto - devicegroup_schema_actionscheduler - devicegroup_schema_authentication - devicegroup_schema_authentication_password - devicegroup_schema_authentication_ssh - devicegroup_schema_authentication_ssl - devicegroup_schema_fielddata - devicegroup_schema_fielddata_rollup - devicegroup_schema_flow - devicegroup_schema_flow_ifa - devicegroup_schema_flow_netflow - devicegroup_schema_flow_sflow - devicegroup_schema_logging - devicegroup_schema_logging_MLmodelbuilder - devicegroup_schema_logging_byoi - devicegroup_schema_logging_byoi_service - devicegroup_schema_logging_flow - devicegroup_schema_logging_iAgent - devicegroup_schema_logging_ifa - devicegroup_schema_logging_nativegpb - devicegroup_schema_logging_nonsensorrules - devicegroup_schema_logging_openconfig - devicegroup_schema_logging_reportsgeneration - devicegroup_schema_logging_resourcediscovery - devicegroup_schema_logging_servermonitoring - devicegroup_schema_logging_sflow - devicegroup_schema_logging_snmp - devicegroup_schema_logging_snmpnotification - devicegroup_schema_logging_syslog - devicegroup_schema_logging_triggerevaluation - devicegroup_schema_nativegpb - devicegroup_schema_notification - devicegroup_schema_openconfig - devicegroup_schema_openconfig_gnmi - devicegroup_schema_outboundssh - devicegroup_schema_paragonactiveassurance - devicegroup_schema_publish - devicegroup_schema_rawdata - devicegroup_schema_rawdata_summarize - devicegroup_schema_rootcauseanalysis - devicegroup_schema_scheduler - devicegroup_schema_snmp - devicegroup_schema_snmp_v2 - devicegroup_schema_snmp_v3 - devicegroup_schema_snmp_v3_usm - devicegroup_schema_snmp_v3_usm_snmpproxyforwarder - devicegroup_schema_syslog - devicegroup_schema_variable - devicegroup_schema_variablevalue - devices - devices_schema - dynamic_tagging_schema_object - dynamic_taggings_schema_object - edge_schema - event - field-capture_schema - field-field-capture_schema - flow-record_schema - flow_schema - flow_schema_flow - flow_schema_flow_recognitionpattern - flow_schema_flow_template - frequency-profile_schema - frequencyprofile_schema_nonsensor - frequencyprofile_schema_sensor - groupHealthSchema - header-pattern_schema - headerpattern_schema_field - healthSchema - ifa_device_schema - ifa_schema - ifa_schema_device - ingest-mapping_schema - ingest-mappings_schema - ingest-settings_schema - ingestmapping_schema_iAgent - ingestmapping_schema_iAgent_useplugin - inline_response_200 - inline_response_200_1 - inline_response_200_2 - inline_response_200_3 - instance_schedule_state_schema - instances_schedule_state_schema - lhs-rhs-group - license-feature_schema - license-features_schema - license-key_schema - license-keys_schema - license-raw-key_schema - license-raw-keys_schema - licensekey_schema_features - local-certificate_schema - native-gpb_schema - nativegpb_schema_nativegpb - network-group_schema - network-groups_schema - network-variable-schema - networkHealthTree - networkgroup_schema_logging - networkgroup_schema_notification - networkgroup_schema_publish - notification_schema - notification_schema_amqppublish - notification_schema_amqppublish_sasl - notification_schema_emails - notification_schema_emails_filter - notification_schema_httppost - notification_schema_httppost_basic - notification_schema_kafkapublish - notification_schema_kafkapublish_sasl - notification_schema_microsoftteams - notification_schema_slack - notifications_schema - organization_schema - organizations_schema - outbound-ssh_schema - outboundssh_schema_outboundssh - paa-setup_schema - paa-setup_schemas - paasetup_schema_security - paasetup_schema_security_sasl - panel_data_schema - panel_data_schema_addGroupByTag - panel_data_schema_addWhereCondition - panel_data_schema_addWhereCondition_keyOrField - panel_data_schema_addWhereCondition_keyOrFieldValue - panel_data_schema_addWhereCondition_operator - panel_data_schema_changeWhereKeyField - panel_data_schema_groupByFill - panel_data_schema_groupByTime - panel_data_schema_selectedAggregation - panel_data_schema_selectedDevice - panel_data_schema_selectedDropdown - panel_data_schema_selectedField - panel_data_schema_selectedGroup - panel_data_schema_selectedLogicalOperator - panel_data_schema_selectedTopic - panel_data_schema_selectedTransformation - panel_schema - panel_schema_panelQuery - panel_schema_panelType - panel_schema_timeRange - panel_schema_unitType - pattern-set_schema - pattern_schema - pattern_schema_constant - pattern_schema_field - pin_graphs - pin_graphs_query - pin_graphs_query_where - pin_graphs_query_where_where_clause - playbook_schema - playbooks_schema - profile_schema - profile_schema_datasummarization - profile_schema_datasummarization_path - profile_schema_datasummarization_raw - profile_schema_rollupsummarization - profile_schema_security - profiles_schema - profiles_schema_profile - protocol_schema - raw-data-summarizations_schema - raw_schema - raw_schema_datatype - raw_schema_path - refreshToken - report-generation_schema - report_schema - report_schema_canvaspanel - report_schema_graphcanvas - reports_schema - resource_schema - resource_schema_argument - resource_schema_dependson - resource_schema_field - resource_schema_foreverydevice - resource_schema_foreverynetworkgroup - resource_schema_function - resource_schema_getdependenciesfromcache - resource_schema_locateresource - resource_schema_source - resource_schema_source_rule - resource_schema_term - resource_schema_userdefinedfunction - resource_schema_where - resource_schema_where_argument - resource_schema_where_doesnotmatchwith - resource_schema_where_equalto - resource_schema_where_matcheswith - resource_schema_where_userdefinedfunction - resource_schema_withcapturegroup - retention-policies_schema - retention-policy_schema - role_schema - role_schema_inner - rollup-summarization_schema - rollup-summarizations_schema - rollupsummarization_schema_database - rollupsummarization_schema_datarolluporder - rollupsummarization_schema_field - rollupsummarization_schema_field_1 - rollupsummarization_schema_measurement - rollupsummarization_schema_rule - rule-field-capture_schema - rule_schema - rule_schema_argument - rule_schema_byoi - rule_schema_byoi_plugin - rule_schema_byoi_plugin_parameters - rule_schema_constant - rule_schema_dataifmissing - rule_schema_field - rule_schema_flow - rule_schema_formula - rule_schema_formula_1 - rule_schema_formula_1_and - rule_schema_formula_1_or - rule_schema_formula_1_unique - rule_schema_formula_1_unless - rule_schema_formula_anomalydetection - rule_schema_formula_concatenate - rule_schema_formula_count - rule_schema_formula_dynamicthreshold - rule_schema_formula_elapsedtime - rule_schema_formula_eval - rule_schema_formula_max - rule_schema_formula_mean - rule_schema_formula_microburst - rule_schema_formula_min - rule_schema_formula_outlierdetection - rule_schema_formula_outlierdetection_algorithm - rule_schema_formula_outlierdetection_algorithm_dbscan - rule_schema_formula_outlierdetection_algorithm_dbscan_sensitivity - rule_schema_formula_outlierdetection_algorithm_kfold3sigma - rule_schema_formula_predict - rule_schema_formula_rateofchange - rule_schema_formula_stddev - rule_schema_formula_sum - rule_schema_formula_userdefinedfunction - rule_schema_formula_userdefinedfunction_argument - rule_schema_formula_valuedifference - rule_schema_function - rule_schema_iAgent - rule_schema_iAgent_args - rule_schema_nativegpb - rule_schema_openconfig - rule_schema_prehook - rule_schema_redirectto - rule_schema_reference - rule_schema_reference_dataifmissing - rule_schema_return - rule_schema_ruleproperties - rule_schema_ruleproperties_catalogue - rule_schema_ruleproperties_helperfiles - rule_schema_ruleproperties_isscalingrule - rule_schema_ruleproperties_supporteddevices - rule_schema_ruleproperties_supporteddevices_juniper - rule_schema_ruleproperties_supporteddevices_juniper_operatingsystem - rule_schema_ruleproperties_supporteddevices_juniper_platforms - rule_schema_ruleproperties_supporteddevices_juniper_products - rule_schema_ruleproperties_supporteddevices_juniper_releases - rule_schema_ruleproperties_supporteddevices_juniper_releases_1 - rule_schema_ruleproperties_supporteddevices_operatingsystems - rule_schema_ruleproperties_supporteddevices_othervendor - rule_schema_ruleproperties_supporteddevices_platforms - rule_schema_ruleproperties_supporteddevices_products - rule_schema_ruleproperties_supporteddevices_releases - rule_schema_sensor - rule_schema_sensor_1 - rule_schema_sflow - rule_schema_snmp - rule_schema_snmpnotification - rule_schema_syslog - rule_schema_term - rule_schema_then - rule_schema_then_argument - rule_schema_then_retry - rule_schema_then_retry_backoff - rule_schema_then_status - rule_schema_then_userdefinedaction - rule_schema_then_workflow - rule_schema_trigger - rule_schema_variable - rule_schema_vector - rule_schema_when - rule_schema_when_doesnotmatchwith - rule_schema_when_equalto - rule_schema_when_exists - rule_schema_when_increasingatleastbyrate - rule_schema_when_increasingatleastbyvalue - rule_schema_when_matcheswithprevious - rule_schema_when_maxrateofincrease - rule_schema_when_range - rule_schema_when_userdefinedfunction - rule_schema_where - sample_schema - scheduler_schema - scheduler_schema_repeat - scheduler_schema_repeat_interval - scheduler_schema_runfor - schedulers_schema - serviceStatus - sflow_schema - sflow_schema_sflow - sflow_schema_sflow_counterrecord - sflow_schema_sflow_field - sflow_schema_sflow_protocol - sflow_schema_sflow_sample - sflow_schema_sflow_sizebasedonfield - sflow_schema_sflow_sizebasedonfield_then - sflow_schema_sflow_sizebasedonfield_then_1 - sflow_schema_sflow_sizebasedonfield_whenequal - site_schema - snmp-notification_schema - snmpnotification_schema_snmpnotification - snmpnotification_schema_snmpnotification_v3 - snmpnotification_schema_snmpnotification_v3_usm - snmpv3-usm-user_schema - snmpv3-usm-users_schema - snmpv3usmuser_schema_authentication - snmpv3usmuser_schema_privacy - ssh-key-profile_schema - syslog_schema - syslog_schema_syslog - system-settings_schema - table_schema - tagging-profile_schema - tagging-profiles_schema - taggingprofile_schema_policy - taggingprofile_schema_term - taggingprofile_schema_then - taggingprofile_schema_then_addfield - taggingprofile_schema_then_addkey - taggingprofile_schema_when - taggingprofile_schema_when_doesnotmatchwith - taggingprofile_schema_when_equalto - taggingprofile_schema_when_eval - taggingprofile_schema_when_exists - taggingprofile_schema_when_matcheswithscheduler - template_schema - time-range-mandatory - tlive-kafka-oc_schema - tlive-kafka-ocs_schema - tlivekafkaoc_schema_security - tlivekafkaoc_schema_security_sasl - token - topic-field-capture_schema - topic_schema - topics_schema - trigger_action_schema - trigger_schema - trigger_schema_triggers - tsdb_post_body - tsdb_post_body_items - tsdb_post_body_items_deviceAggregation - tsdb_post_body_items_outerQueries - tsdb_results - tsdb_results_results - tsdb_results_series - tsdb_schema - user_schema - user_schema_groups - uuid_object - when-lhs-rhs-group - workflow_argument_group_schema - workflow_argument_group_schema_inner - workflow_command_schema - workflow_command_schema_commands - workflow_cron_options_schema - workflow_instance_schema - workflow_instance_schema_parameters - workflow_instances_schema - workflow_notification_schema - workflow_schema - workflow_schema_artifact - workflow_schema_dataxml - workflow_schema_grok - workflow_schema_input - workflow_schema_json - workflow_schema_output - workflow_schema_regex - workflow_schema_step - workflow_schema_suspend - workflow_schema_task - workflow_schema_task_1 - workflow_schema_workflow - workflow_statistics_schema - workflows_schema -
statement_id (optional)
error (optional)
device-groups (optional)
network-groups (optional)
data (optional)
name
String Name of the macro to be expanded format: string
name
String Keyword part of the keyword-value pair format: string
value (optional)
String Value part of the keyword-value pair format: string
list of groups associated
roleId (optional)
roleName (optional)
userId (optional)
userName (optional)
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
args (optional)
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
target (optional)
String To run command on FPC, specifiy FPC target
username
String Username to connect to device
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
email (optional)
oldpassword (optional)
newpassword (optional)
name
String Name is the identifier of this config, referred in sensor config under topic/rule format: string
parameters (optional)
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
key
String Key of the parameter format: string
value (optional)
String Value of the parameter format: string
Plugin specific security parameters
tls (optional)
user-authentication (optional)
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
User authentication
password
String Password format: string
username
String Username format: string
group-name (optional)
key (optional)
value (optional)
arguments
Object Optional key/value pair arguments to table
job-id (optional)
job-status (optional)
finished
started
error
pending
job-details (optional)
debug-data (optional)
debug-type (optional)
scenario
service
debug-name (optional)
Configurable deployment settings
Kubernetes deployment configuration
Loadbalancer deployment configuration
Loadbalancer deployment configuration for SNMP Notifications
virtual-ip-address
String load balancer virtual ipv4 address exclusive for SNMP format: string
disk (optional)
email (optional)
name
String Name of the destination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
Store report on disk
max-reports (optional)
Integer Maximux repots to store on disk format: int32
Send report over email
id (optional)
String Email ID format: string
authentication (optional)
edge (optional)
String JFM: edge this device group belongs to. This should be of the format
..
action-scheduler (optional)
description (optional)
String Description about the device group format: string
device-group-name
String Name of the group. Should be of pattern [a-zA-Z][a-zA-Z0-9-]* format: string
devices (optional)
logging (optional)
native-gpb (optional)
flow (optional)
ingest-frequency (optional)
raw-data (optional)
field-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
root-cause-analysis (optional)
scheduler (optional)
variable (optional)
snmp (optional)
syslog (optional)
paragon-active-assurance (optional)
tagging-profile (optional)
timezone (optional)
String Timezone in the format +/-hh:mm, Example: -08:00 format: string
use-ingest-receive-time (optional)
array[Object] Enable using ingest receive time in formulas like elapsed-time and rate-of-change
children
color (optional)
green
yellow
red
data (optional)
name
timestamp (optional)
children
color (optional)
green
yellow
red
data (optional)
name
timestamp (optional)
authentication (optional)
description (optional)
String Description about the device format: string
name (optional)
String Name for the device. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* 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)
server-monitoring (optional)
outbound-ssh (optional)
owner (optional)
String Owner of the device: this is a read-only attribute and should not be added to the request payload, value if added will be discarded. format: string
snmp (optional)
syslog (optional)
tagging-profile (optional)
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
use-ingest-receive-time (optional)
array[Object] Enable using ingest receive time in formulas like elapsed-time and rate-of-change
variable (optional)
vendor (optional)
marked-for-delete (optional)
source-ip-addresses (optional)
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
Disable Outbound-SSH service for a device
disable (optional)
Boolean If true, disable Outbound-SSH service for the device
SNMP ingest related configuration for a device
port (optional)
Integer Port on which SNMP requests need to be sent. Port 161 is used if not configured. format: int32
v2 (optional)
v3 (optional)
SNMP version 2 configuration
community (optional)
String Community name. 'public' will be used if not configured format: string
source-id (optional)
Configuration which is required to identify the sender of the SNMP trap/inform message
SNMP version 3 configuration
source-id (optional)
usm (optional)
Configuration which is required to identify the sender/receiver of the SNMP message
context-engine-id
String Context engine-id for the SNMP agent running in the device in Hex Format Eg: '80001f8880bd5b8d052eb40d6000000000' format: string
source-ip-addresses (optional)
SNMP User Security Model configuration
authentication (optional)
authentication-none (optional)
array[null] Configure no authentication for the SNMPv3 user
privacy-none (optional)
privacy (optional)
snmp-proxy-forwarder (optional)
username
String SNMPv3 username format: string
source-ip-addresses (optional)
hostnames (optional)
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)
Vendor specific configuration
arista (optional)
cisco (optional)
juniper (optional)
linux (optional)
other-vendor (optional)
paloalto (optional)
Arista device
operating-system
String Operating system of the device
eos
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
Cisco device
operating-system
String Operating system of the device
iosxr
nxos
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
Juniper device
operating-system
String Operating system of the device
junos
junosEvolved
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
Linux device
operating-system
String Distribution/Flavour of linux, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
Other vendor device
operating-system (optional)
String Vendor operating system, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
vendor-name
String Vendor-name, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
Palo Alto device
operating-system
String Operating system of the device
panos
platform (optional)
String Platform name of the device, Example: MX240 format: string
product (optional)
String Product category of the device, Example: MX format: string
release (optional)
String Release string of the device, Example: 19.2R1 format: string
disable-trigger-action-schedulers (optional)
Boolean If true, disable trigger-action-schedulers service
Common authentication parameters
password (optional)
ssh (optional)
ssl (optional)
password
String Password for authentication format: string
username
String Username for authentication format: string
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
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
Enables data rollup summarization of tsdb
Flow ingest related parameters
deploy-nodes (optional)
ifa (optional)
netflow (optional)
sflow (optional)
Inband Flow Analyzer specific parameters in Flow ingest
ports (optional)
deploy-nodes (optional)
NetFlow specific parameters in Flow ingest
sFlow specific parameters in Flow ingest
Logging configuration
iAgent (optional)
log-level (optional)
error
debug
warn
info
native-gpb (optional)
non-sensor-rules (optional)
open-config (optional)
server-monitoring (optional)
reports-generation (optional)
snmp (optional)
trigger-evaluation (optional)
ML-model-builder (optional)
resource-discovery (optional)
flow (optional)
sflow (optional)
ifa (optional)
byoi (optional)
snmp-notification (optional)
syslog (optional)
Service responsible for building the model for Machine Learning
log-level
error
debug
warn
info
Service responsible for the custom BYOI plugins
daemons (optional)
log-level
error
debug
warn
info
name
String Name of the service format: string
Service responsible for flow data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for iAgent sensor data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for Inband Flow Analyzer data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for native-gpb-sensor data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for non-sensor and network-rules
daemons (optional)
log-level
error
debug
warn
info
Service responsible for openconfig sensor data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for generating reports
log-level
error
debug
warn
info
Service responsible for discovering resources
log-level
error
debug
warn
info
Service responsible for server-monitoring sensor data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for sflow data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for SNMP data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for SNMP Notification data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for Syslog data collection
daemons (optional)
log-level
error
debug
warn
info
Service responsible for trigger-evaluation
log-level
error
debug
warn
info
enable (optional)
major (optional)
minor (optional)
no-initial-normal-notify-suppression (optional)
Boolean If true, Don't suppress the initial normal notifications
normal (optional)
initial-sync (optional)
Boolean If true, enable initial sync packets processing
gnmi (optional)
enable (optional)
encoding (optional)
String Encoding to be used, default is protobuf
protobuf
json
json_ietf
Configure the ports to enable Outbound-SSH service initiated by the devices to connect to the healthbot
paa-setup (optional)
String Name of configured Paragon Active Assurance setup
destination
field (optional)
sensor (optional)
persist (optional)
Object Enables persist-raw-data
summarize (optional)
Enables persist-summarize-data
summarization-profile (optional)
time-span
String Timespan for aggregate functions format: string
Setting for root cause analysis
no-rca (optional)
dynamic-resources (optional)
exclude-resources (optional)
instance-id
String Unique ID of the variable instance. This should be unique per playbook and rule combination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
playbook
String Name of the playbook in which the variable instance needs to be used
rule
String Name of the rule. This should be of the format
/
schedule
String Name of the schedule that play/pauses the playbook instance automatically
SNMP ingest related configuration for a device-group
notification-ports (optional)
port (optional)
Integer Port on which SNMP requests need to be sent. Port 161 is used if not configured. format: int32
v2 (optional)
v3 (optional)
SNMP version 2 configuration
community (optional)
String Community name. 'public' will be used if not configured format: string
SNMP version 3 configuration
SNMP User Security Model configuration
authentication (optional)
authentication-none (optional)
array[null] Configure no authentication for the SNMPv3 user
privacy (optional)
privacy-none (optional)
snmp-proxy-forwarder (optional)
username
String SNMPv3 username format: string
SNMP Proxy forwarder configuration
security-engine-id (optional)
String Security engine id of the proxy forwarder agent format: string
instance-id
String Unique ID of the variable instance. This should be unique per playbook and rule combination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
playbook
String Name of the playbook in which the variable instance needs to be used
rule
String Name of the rule. This must be of the format
/ format: string
running-state (optional)
String Current running state of the playbook instance
running
paused
variable-value (optional)
name
String Variable name used in the playbook/rule. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
value
String Value for the variable format: string
key
String Dynamic-tagging key name format: string
description (optional)
String Description about the edge format: string
edge-id
String uuid of the edge in string format: string
edge-name
String Name of the edge. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
color (optional)
yellow
red
event_name (optional)
frequency (optional)
timestamp (optional)
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
Flow ingest configuration
exclude-fields (optional)
include-fields (optional)
description (optional)
String Template description. format: string
key-fields (optional)
name
String Name of the template. format: string
priority (optional)
Integer Priority given to template during matching. format: int32
protocol-version (optional)
v9
v10
recognition-pattern (optional)
name
String Frequency profile name format: string
non-sensor (optional)
sensor (optional)
frequency
String Sensor subscription duration. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s. A frequency of zero should be used only in case of events subscription format: string
rule-name
String Name of non-sensor or network rule i.e topic-name/rule-name format: string
frequency
String Sensor subscription duration. Specify integer >= 0 followed by seconds/minutes/hours/days/weeks/years. Eg: 2seconds. A frequency of zero should be used only in case of events subscription format: string
sensor-name
String Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
description (optional)
String Pattern description format: string
field (optional)
filter
String Regex filter to parse syslog header format: string
filter-type (optional)
String Filter type, default is regex
regex
key-fields (optional)
name
String Name of a pattern. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
description (optional)
String Field description format: string
from
String Field that supplies the value. For a structured syslog, this will be the attribute name from the message. For a grok pattern, this will be name of the field given in the pattern. For a regex pattern, this will be the capture group number prefixed by $, eg: $1, $2 format: string
name
String Field name format: string
type (optional)
integer
unsigned-integer
float
string
device-health (optional)
network-health (optional)
id
Integer Device number format: int32
name (optional)
String Device name format: string
Inband Flow Analyzer ingest configuration
id
Integer Device number format: int32
name (optional)
String Device name format: string
iAgent (optional)
name
String Name of the mapping format: string
native-gpb (optional)
netflow (optional)
open-config (optional)
server-monitoring (optional)
snmp (optional)
syslog (optional)
Ingest related configuration
for-device-groups (optional)
use-plugin (optional)
instance (optional)
String Plugin instance name format: string
name
String BYOI plugin name format: string
type
default-plugin
job-id (optional)
job-result (optional)
job-status (optional)
finished
killed
pending
started
accessToken (optional)
String Access token generated by system
refreshToken (optional)
String Refresh token generated by system
refreshTokenExpires (optional)
String Refresh token validity duration
tokenExpires (optional)
String Access token validity duration
Instance associated with active schedule and its corresponding scheduled state
group-name
group-type
String Type of the group. Can be one of device-group or network-group
device-group
network-group
name
rule
String Name of the rule associated with the instance
playbook
String Name of the playbook associated with the instance
state
String Scheduled state of the instance. Can be one of active or inactive
active
inactive
List of instance associated with active schedule and their corresponding scheduled state
left-operand (optional)
right-operand (optional)
feature-id (optional)
Integer Unique ID of the licensed feature
feature-name
String Name of the licensed feature format: string
feature-description
String Brief description of the licensed feature format: string
license-total
Integer Total license count for feature
license-remaining (optional)
Integer Remaining license count for feature
license-requested (optional)
Integer Local requested license count for feature
license-usage
Integer License feature usage count
max-remaining-days
Integer Maximum remaining time of the feature's license in days
validity-type
invalid
countdown
date-based
permanent
mode
String License mode of operation
invalid
standalone
network
compliance
Boolean Compliance status indicating if the feature usage is in compliance or not
end-date
valid-until
String Validity information of license feature format: string
license-feature (optional)
license-id
String Unique ID of the license format: string
start-date
Date License start date and time format: date-time
end-date
Date License end date and time format: date-time
validity-type
invalid
countdown
date-based
permanent
version
Integer License key version, an integer value indicating version of license vendor info
sku-name
String License stock keeping unit name, indicates category of purchased license format: string
customer-id
String Identification of customer who has purchased this license format: string
order-type
String License purchase order type
unknown
commercial
trial
demo
emergency
lab
education
sw-serial-id (optional)
String Software serial number used for license activation format: string
mode (optional)
String License mode of operation
invalid
standalone
network
features
raw-key
String License key string format: string
feature-id
Integer Unique ID of the licensed feature
feature-name
String Name of the licensed feature format: string
feature-description
String Brief description of the licensed feature format: string
capacity-value
Integer Total capacity of the licensed feature
capacity-flag
Boolean Flag indicating if the feature is capacity or non-capacity type
client-crt
String Client certificate file name. Should be of pattern .+.crt format: string
client-key
String Client Key file name. Should be of pattern .+.key format: string
name
String Local Certificate profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
port (optional)
Integer Port to listen for native-gpb messages format: int32
description (optional)
String Description about the network group format: string
ingest-frequency (optional)
network-group-name
String Name of the network group. Should be of pattern [a-zA-Z][a-zA-Z0-9-]* format: string
publish (optional)
logging (optional)
reports (optional)
root-cause-analysis (optional)
notification (optional)
playbooks (optional)
tagging-profile (optional)
scheduler (optional)
variable (optional)
action-scheduler (optional)
instance-id
String Unique ID of the variable instance. This should be unique per playbook and rule combination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
playbook
String Name of the playbook in which the variable instance needs to be used
rule
String Name of the rule. This must be of the format
/ format: string
children
color (optional)
green
yellow
red
data (optional)
name
timestamp (optional)
Logging configuration
log-level (optional)
error
debug
warn
info
non-sensor-rules (optional)
reports-generation (optional)
trigger-evaluation (optional)
ML-model-builder (optional)
resource-discovery (optional)
enable (optional)
major (optional)
minor (optional)
normal (optional)
destination
field (optional)
description (optional)
String Description about the notification format: string
http-post (optional)
notification-name
String Name of the notification. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
slack (optional)
microsoft-teams (optional)
emails (optional)
kafka-publish (optional)
amqp-publish (optional)
Define amqp notification
exchange
String Name of exchange/routing agent of amqp on which connection has to be instantiated format: string
host
String Host is amqp server/broker valid hostname or IP address format: string
port
Integer Port is amqp server/broker listner port format: int32
routing-key (optional)
String Routing key is a message attribute the exchange looks at when deciding how to route the message to queues. Should be of pattern .
[a-zA-Z0-9_-]+[a-zA-Z0-9._-] , Default value is derived from <device/network-group>.
... format: string
sasl (optional)
vhost (optional)
String Virtual host of amqp on which connection has to be instantiated format: string
Authetication using username and password over TLS connection
ca-profile (optional)
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
password (optional)
String Password for sasl authentication format: string
server-common-name (optional)
String Common name used while creating server certificate format: string
username (optional)
String Username for sasl authentication format: string
Define email notification
Define HTTP endpoint to post the notification
basic (optional)
url
String URL on which http notification needs to be posted format: string
Basic http authetication using username and password
password
String Password for http basic authentication format: string
username
String Username for http basic authentication format: string
Define kafka notification
bootstrap-servers
sasl (optional)
topic (optional)
String Kafka topic to which Healthbot should publish. Should be of pattern .
[a-zA-Z0-9_-]+[a-zA-Z0-9._-] , Default value is derived from <device/network-group>.
... format: string
use-hash-partitioner (optional)
Boolean If true, key will be generated which will be hashed to provide a consistent partition number for the given kafka topic
Authetication using username and password over SSL connection
certificate (optional)
String File path to kafka CA-Certificate. Should be of pattern .+.pem format: string
password (optional)
String Password for sasl_ssl authentication format: string
username (optional)
String Username for sasl_ssl authentication format: string
Define Microsoft Teams Connector channel endpoint to post notification
channel
String Connector channel on which notification is to be posted format: string
Define slack notification
channel
String Channel on which notification should be posted format: string
url
String URL on which slack notification needs to be posted format: string
description (optional)
String Description about the organization format: string
organization-name
String Name of the organization. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
site (optional)
Outbound SSH ingest configuration
port (optional)
Integer Port to listen for Outbound SSH connection format: int32
name
String Paragon Active Assurance setup name format: string
brokers
paa-account
String Paragon Active Assurance account format: string
security (optional)
PAA Kafka specific security parameters
tls (optional)
sasl (optional)
SASL user authentication
password
String Kafka SASL password format: string
username
String Kafka SASL username format: string
addGroupByTag (optional)
addWhereCondition (optional)
changeWhereKeyField (optional)
groupByFill (optional)
groupByTime (optional)
groupType (optional)
String Group type(device/network)
selectedAggregation (optional)
selectedDevice (optional)
selectedDropdown (optional)
selectedField (optional)
selectedGroup (optional)
selectedLogicalOperator (optional)
selectedTopic (optional)
selectedTransformation (optional)
Group by values
dataType (optional)
String Data type of the tag format: string
label (optional)
String label name format: string
type (optional)
String key type or field type format: string
value (optional)
String Value of label format: string
Where condition to filter
keyOrField (optional)
keyOrFieldValue (optional)
operator (optional)
Configured value is field/key type in influx
dataType (optional)
String Data type of the field/key format: string
label (optional)
String label name format: string
type (optional)
String key type or field type format: string
value (optional)
String Value of label format: string
Key or Field value for the where condition
label (optional)
String Name of the panel. format: string
value (optional)
String Name of the panel. format: string
operator for where condition
label (optional)
String Name of the panel. format: string
value (optional)
String Name of the panel. format: string
Group By Fill
label (optional)
String Label Name format: string
value (optional)
String Label Value format: string
Group by time
label (optional)
String Label Name format: string
value (optional)
String Label Value format: string
Aggregation type
label (optional)
String Label Name format: string
value (optional)
String Label value format: string
Device name
label (optional)
String Label Name format: string
value (optional)
String Label Value format: string
Boolean value if selected from dropdown or not
Field selected for the panel
label (optional)
String Label name format: string
value (optional)
String Label value format: string
Device/Network group name
label (optional)
String Label name format: string
type (optional)
String Group type(device/network) format: string
value (optional)
String Label value format: string
Logical operator
value (optional)
String Name of the panel. format: string
Topic name
label (optional)
String Label name(Topic/rule name) format: string
retention-policy (optional)
String Retention policy of the topic format: string
type (optional)
String Type of measurement(field-table/trigger-table/rollup-table) format: string
value (optional)
String Label value format: string
Transformation type
label (optional)
String Label name format: string
value (optional)
String Label value format: string
db (optional)
decimals (optional)
panelData (optional)
panelName (optional)
panelQuery (optional)
panelType (optional)
panelUid (optional)
String Unique identifier for panel
timeRange (optional)
unitType (optional)
yLabel (optional)
yMax (optional)
yMin (optional)
Queries for the configured panel
query
String Panel Query. format: string
Type of chart
label (optional)
String Label name format: string
value (optional)
String Value of the label format: string
Time range configured by user
label (optional)
String Label name format: string
value (optional)
String Value of label format: string
Unit configured
label (optional)
String Label name format: string
value (optional)
String Value of label format: string
Pattern-set details
description (optional)
String Pattern-set description format: string
name
String Name of a pattern-set. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
pattern-names (optional)
Pattern details
constant (optional)
description (optional)
String Pattern description format: string
event-id
String Event id that identifies a log uniquely. Field names also can be part of event-id. Example my-event+$field1 format: string
field (optional)
filter (optional)
String Filter to match a log line format: string
filter-type (optional)
String Filter type, default is grok
grok
key-fields (optional)
name
String Name of a pattern. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
description (optional)
String Constant description format: string
name
String Constant field name format: string
type (optional)
String Data type of constant field
integer
unsigned-integer
float
string
value
String Value of the constant format: string
description (optional)
String Field description format: string
from (optional)
String Field that supplies the value. For a structured syslog, this will be the attribute name from the message. For a grok pattern, this will be name of the field given in the pattern. For a regex pattern, this will be the capture group number prefixed by $, eg: $1, $2 format: string
name
String Field name format: string
type (optional)
integer
unsigned-integer
float
string
Create Panels in a Canvas
graph_name (optional)
graph_description (optional)
graph_type (optional)
String Graph type: Time Series or Histogram or Heatmap
Time Series
Histogram
Heatmap
time_range (optional)
String Time range for the graph
1h
3h
6h
12h
1d
2d
3d
4d
5d
6d
7d
query (optional)
y_label (optional)
String Y Label value in visualization
y_max (optional)
String Y max value in visualization
y_min (optional)
String Y min value in visualization
unit_type (optional)
String unit type value in visualization
Short
Percentage(0-100)
Bits
Bytes
Kilobytes
Megabytes
Gigabytes
Parts per million(ppm)
Parts per billion(ppb)
decimals (optional)
String Decimals value in visualization
Query for the graph
group_name (optional)
String Device/Network group name format: string
group_type (optional)
String Device/Network group type
device
network
device_name (optional)
String label name format: string
measurement_name (optional)
String Measurement name (topic/rule name) format: string
measurement_type (optional)
String Measurement type: Field table/Trigger table/Rollup table
Field table
Trigger table
Rollup table
transformation (optional)
String Transformation value for query
derivative
spread
non-negative-derivative
difference
cumulative-sum
elapsed
field_name (optional)
String Field name of a measurement format: string
field_type (optional)
String Field type of the measurement (int, float, string, uint) format: string
field_aggregation (optional)
String Data aggregation type of the field/key
mean
mode
median
count
sum
integral
distinct
where (optional)
group_by_interval (optional)
String Group by interval of the query format: string
group_by_fill (optional)
String Group by fill value of the query
fill(null)
none
group_by_tag_key (optional)
String Group by tag key value of the query format: string
retention_policy (optional)
String Retention policy name format: string
label name
key (optional)
key
field
operator (optional)
String Operator for where clause
=
!=
=~
!~
value (optional)
String Value for the field_tag_name to be validated format: string
logical_operation (optional)
AND
OR
description (optional)
String Description about this playbook format: string
playbook-name
String Name of the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
rules (optional)
synopsis (optional)
String Short description about this playbook format: string
classification (optional)
String Classification info for this playbook format: string
security (optional)
data-summarization (optional)
rollup-summarization (optional)
aggregation-functions
name
String Sensor field path for which summarization should be changed. Apart from JTI OC sensor path, '
:' should be prepended to the sensor path format: string
data-type (optional)
name
String Name of raw-data summarization profile format: string
path (optional)
Data rollup summarization
Security config
ca-profile (optional)
local-certificate (optional)
ssh-key-profile (optional)
security (optional)
data-summarization (optional)
rollup-summarization (optional)
field
number
Integer Protocol number unique to each protocol format: int32
protocol-name
String Name of protocol format: string
data-type (optional)
name
String Name of raw-data summarization profile format: string
path (optional)
aggregation-functions
name
String Name of the data-type for which summarization should be changed
string
integer
unsigned-integer
boolean
float
aggregation-functions
name
String Sensor field path for which summarization should be changed. Apart from JTI OC sensor path, '
:' should be prepended to the sensor path format: string
destination (optional)
report (optional)
capture-fields (optional)
destination
format
String Generated report format
json
html
pdf
graph-canvas (optional)
name
String Name of the report format: string
schedule
name
String Name of the panel. format: string
canvas-panel (optional)
name
String Name of the canvas. format: string
depends-on (optional)
description (optional)
String Description about the resource format: string
field (optional)
function (optional)
keys (optional)
resource-name
String Name of the resource. Should be of pattern [a-z][a-z0-9-]* format: string
is-default (optional)
Boolean Flag to denote default resource
is-modified (optional)
Boolean Flag to denote if default resource is modified
argument-name
String Name of the argument. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
mandatory (optional)
depends-on-multiple-instances (optional)
Boolean Depends on multiple instances of the depends-on resource. One to many relationship. Eg: ae interface can be dependent on multiple interfaces
description (optional)
String Description about the dependency format: string
resource-name
String Name of dependent resource
/. Should be of pattern [a-z][a-z-](.{1}[a-z0-9-]+)/[a-z][a-z0-9-]* format: string
term
triggered-by (optional)
with-capture-group (optional)
description (optional)
String Description about resource field format: string
field-name
String Name of the resource field. Should be of pattern [a-z][a-zA-Z0-9-]* format: string
source (optional)
type
string
integer
unsigned-integer
float
Loop over all devices
across-all-device-groups (optional)
Boolean evaluate for all device groups
in-groups (optional)
label-as
Loop over all network groups
across-all-network-groups (optional)
Boolean evaluate for all network groups
in-groups (optional)
label-as
argument (optional)
description (optional)
String Description of the function format: string
function-name
String Name of the function. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
method
String Function to be called format: string
path
String File in which function is defined. This is relative path to the data directory format: string
path (optional)
String Instance name given while pushing the dependencies to HealthBot format: string
label-as
resource
String Name of the resource which needs to looped over. Format:
<topic-name/rule-name>. Should be of pattern ([a-zA-Z][a-zA-Z0-9-]:)?[a-z][a-z-](.{1}[a-z0-9-]+)/[a-z][a-z0-9-]. format: string
where (optional)
with-capture-group (optional)
field-name
String Rule field name from where resource field should be populated. Should be of pattern [a-z][a-zA-Z0-9_-]* format: string
rule-name
String Rule name from where the resource needs to be discovered. Format:
/. Should be of pattern [a-z][a-z-](.{1}[a-z0-9-]+)/[a-z][a-z0-9_-]* format: string
for-every-device (optional)
for-every-network-group (optional)
get-dependencies-from-cache (optional)
locate-resource (optional)
next (optional)
Boolean Continue evaluating next term
term-name
String Term name. Should be of pattern [a-zA-Z][a-zA-Z0-9-]* format: string
user-defined-function (optional)
with-capture-group (optional)
User defined function to populate field value
argument (optional)
function-name
String Name of the function that is defined in the resource. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
does-not-match-with (optional)
equal-to (optional)
eval (optional)
greater-than (optional)
greater-than-or-equal-to (optional)
less-than (optional)
less-than-or-equal-to (optional)
matches-with (optional)
not-equal-to (optional)
user-defined-function (optional)
argument-name
String Name of the argument. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
value
String Argument value format: string
left-operand
String Left operand. This is the string in which we have to match the expression format: string
right-operand
String Right operand. This is the match expression format: string
left-operand
String Left operand format: string
right-operand
String right operand format: string
ignore-case (optional)
array[null] Flag to ignore case while matching the string
left-operand
String Left operand. This is the string in which we have to match the expression format: string
right-operand
String Right operand. This is the match expression format: string
argument (optional)
function-name
String Name of the function that is defined in the resource. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
capture-group-name
String Name of the capture group. Should be of pattern [a-zA-Z][a-zA-Z0-9-]* format: string
expression (optional)
String Regular expression to extract sub strings format: string
field-name (optional)
String Name of the local or depending resource field name format: string
ignore-case (optional)
Boolean If true, regex match with be case insensitive
duration (optional)
String Schedule duration in days or hours, Should be of pattern [1-9][0-9]*[dh] format: string
replication (optional)
Integer Number of independent copies if stored in the cluster format: int32
retention-policy-name
String Name of the retention-policy. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
roleId (optional)
roleName (optional)
Data rollup summarization
profile-id (optional)
String Profile-id of data rollup summarization instance. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
rule (optional)
database (optional)
data-rollup-order (optional)
Data rollup summarization
database-name
String Database for which the roll-up summarization profile will be applied. format: string
measurement (optional)
instance-id
String Instance-id/aggregation-id of data rollup summarization instance. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
interval
String Time interval for the data roll up to occur( m/h/d/w representing minutes/hours/days/weeks. Min value: 30m, Max value: 52w ) format: string
retention-policy (optional)
String Retention policy for the data-rollup instance. If not configured, default retention policy will be considered
aggregate-function
name
String Name of the field. Should be of pattern [a-z][a-zA-Z0-9_-]* format: string
aggregate-function
name
String Name of the field. Should be of pattern [a-z][a-zA-Z0-9_-]* format: string
apply-on-existing-data (optional)
array[null] If configured, existing data will also be considered for roll up summarization, else only the newly incoming data will be considered
field (optional)
measurement-name
String Measurement of the database for which the roll-up summarization profile will be applied. format: string
apply-on-existing-data (optional)
array[null] If configured, existing data will also be considered for roll up summarization, else only the newly incoming data will be considered
field (optional)
rule-name
String Rule for which the roll-up summarization profile will be applied. format: string
description (optional)
String Description about the rule format: string
field (optional)
function (optional)
keys (optional)
network-rule (optional)
disable-no-data-alarm (optional)
pre-hook (optional)
post-hook (optional)
redirect-to (optional)
rule-frequency (optional)
String Frequency at which the rule’s field, reference, and vector elements should be computed. Required only when a rule doesn’t have a sensor defined. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
rule-name
String Name of the rule. Should be of pattern [a-z][a-z0-9_-]* format: string
sensor (optional)
synopsis (optional)
String Synopsis about the rule format: string
field-aggregation-time-range (optional)
String How much back in time should we look for field aggregation. Specify positive integer followed by o/s/m/h/d/w/y/offset representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
trigger (optional)
variable (optional)
vector (optional)
rule-properties (optional)
argument-name
String Name of the argument. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
mandatory (optional)
Bring your own ingest ingest plugin config
Input plugin
name
String Name of the input plugin format: string
parameters (optional)
key
String Key of the parameter format: string
value
String Value of the parameter format: string
value
String Value for the constant format: string
Assign value for field in case of data missing. Zero-suppression takes priority over data-if-missing
value (optional)
String Assign given default value for field in case of data missing format: string
constant (optional)
description (optional)
String Description about this field format: string
field-name
String Name of the field. Should be of pattern [a-z][a-zA-Z0-9_-]* format: string
formula (optional)
reference (optional)
sensor (optional)
type (optional)
string
integer
unsigned-integer
float
anomaly-detection (optional)
count (optional)
dynamic-threshold (optional)
eval (optional)
max (optional)
mean (optional)
concatenate (optional)
microburst (optional)
min (optional)
outlier-detection (optional)
predict (optional)
rate-of-change (optional)
elapsed-time (optional)
value-difference (optional)
stddev (optional)
sum (optional)
user-defined-function (optional)
and (optional)
or (optional)
unique (optional)
unless (optional)
AND(intersection) operation between two vectors. Resultant vector is a set with elements common in both vectors
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
OR(union) operation between two vectors. Resultant vector is a set with elements from both the vectors
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
Create a vector with unique elements from another vector
vector-name
String Vector name in which unique elements needs to be computed. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
UNLESS(difference) operation between vectors. Resultant vector is a set with elements in left-vector but not in right-vector
left-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
right-vector
String Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]* format: string
Apply anomaly detection. Learn dynamic threshold value over period
of time and apply it on value
algorithm
String Algorithm used to learn the dynamic threshold value
3sigma
k-means
holt-winters
field-name
String Field name on which anomaly detection needs to be applied format: string
learning-period
String Learning period to learn the dynamic threshold. Should be of pattern [1-9][0-9]*(seconds|minutes|hours|days|weeks|years) format: string
pattern-periodicity (optional)
String Pattern periodicity. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
seasonality (optional)
String Seasonality. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
Find number of occurances
field-name
String Field name on which count operation needs to be performed format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Apply dynamic threshold. Learn dynamic threshold value over period
of time and apply it on value
algorithm
String Algorithm used to learn the dynamic threshold value
3sigma
k-means
field-name
String Field name on which dynamic threshold needs to be applied format: string
learning-period
String Learning period to learn the dynamic threshold. Should be of pattern [1-9][0-9]*(.[0-9]+)?(offset|seconds|minutes|hours|days|weeks|years|o|s|m|h|d|w|y) format: string
pattern-periodicity (optional)
String Pattern periodicity. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
seasonality (optional)
String Seasonality. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
Elapsed time between present and previous value
field-name
String Field name on which elapsed operation needs to be performed format: string
hold-time (optional)
String How long previous value should be stored. Should match the pattern [0-9]*(seconds|minutes|hours|days|weeks|years|offset). Default is 1 day format: string
multiplication-factor (optional)
String Value to be multiplied with calculated time. Default is 1.0. Should be IEEE-754 64-bit floating-point numbers format: string
Evaluates the expression
expression
String Expression for evaluation must be a valid golang expression. Field-name if used in expression must be prefixed with $. operators should be prefix and suffix with spaces. For Example: $a + $b - $c format: string
Find the max value
field-name
String Field name on which max operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Find the mean value
field-name
String Field name on which mean operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Detect microbursts in the egress queues. This has to be used only with qmon sensors
if-name
String Interface name. This should be field name where interface names are being stored format: string
packets
String Queue egress packets. This should be field name where queue egress packets are being stored format: string
percentage
String Queue buffer occupancy percentage. This should be field name where queue buffer occupancy percentage are being stored format: string
queue-no
String Queue numbers. This should be field name where queue numbers are being stored format: string
Find the min value
field-name
String Field name on which min operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Apply outlier detection.
algorithm (optional)
dataset
String Variable containing the list of XPATHs to the data format: string
dbscan (optional)
k-fold-3sigma (optional)
learning-period
String Time period on which to detect outliers format: string
sensitivity (optional)
Sensitivity to outliers: high sensitivity detects more outliers
absolute-percentage (optional)
Double Absolute percentage of members that are to be marked as outliers format: double
level (optional)
String Fuzzy level of outliers to be detected
low
medium
high
learning-period
String Time period on which to detect outliers format: string
sensitivity (optional)
sigma-coefficient (optional)
Double Number of standard deviations past which outliers are marked format: double
Learn baseline threshold based on the ML alogrithms and predict value in future
algorithm
String Algorithm used to create baseline thresholds
median-prediction
holt-winters
hidden-markov
field-name
String Field name on which ML algorithm needs to be applied format: string
learning-period
String Learning period to learn the baseline threshold. Should be of pattern [1-9][0-9]*(.[0-9]+)?(offset|seconds|minutes|hours|days|weeks|years|o|s|m|h|d|w|y) format: string
pattern-periodicity (optional)
String Pattern periodicity. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
seasonality (optional)
String Seasonality. Should be of pattern [1-9][0-9]
(minutes|hours|days|weeks|months)(,[1-9][0-9](minutes|hours|days|weeks|months))* format: string
prediction-offset
String Time offset in future to predict. Should be of pattern [1-9][0-9]*(.[0-9]+)?(offset|seconds|minutes|hours|days|weeks|years|o|s|m|h|d|w|y) format: string
Rate of change between present and previous value
field-name
String Field name on which rate-of-change operation needs to be performed format: string
hold-time (optional)
String How long previous value should be stored. Should match the pattern [0-9]*(seconds|minutes|hours|days|weeks|years|offset). Default is 1 day format: string
multiplication-factor (optional)
String Value to be multiplied with calculated rate. Default is 1.0. Should be IEEE-754 64-bit floating-point numbers format: string
Find the standard deviation
field-name
String Field name on which standard deviation operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Find the sum of values
field-name
String Field name on which sum operation needs to be performed format: string
time-range
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
User defined function to populate field value
argument (optional)
function-name
argument
value
String Argument value format: string
Value difference between present and previous value
field-name
String Field name on which delta operation needs to be performed format: string
hold-time (optional)
String How long previous value should be stored. Should match the pattern [0-9]*(seconds|minutes|hours|days|weeks|years|offset). Default is 1 day format: string
multiplication-factor (optional)
String Value to be multiplied with calculated time. Default is 1.0. Should be IEEE-754 64-bit floating-point numbers format: string
extra-keys (optional)
argument (optional)
return (optional)
description (optional)
String Description of the function format: string
function-name
String Name of the function. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
method
String Function to be called format: string
path
String File in which function is defined. This is relative path to the data directory format: string
args (optional)
file
String File where table and views are defined format: string
frequency
String Frequency at which the iagent should execute the commands and extract the data. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
table
String Table which needs to be used to extract the data format: string
target (optional)
String To run command on FPC, specifiy FPC target (optional) format: string
arg-name
String name of argument format: string
arg-value (optional)
String value of argument format: string
frequency (optional)
String Sensor subscription duration. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s. A frequency of zero should be used only in case of events subscription format: string
port
Integer Port on which the native sensors will be received format: int32
sensor-name
String Sensor to subscribe format: string
frequency
String Sensor subscription duration. Specify integer >= 0 followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s. A frequency of zero should be used only in case of events subscription format: string
sensor-name
String Sensor to subscribe format: string
argument (optional)
workflow-name
String Name of the workflow to trigger format: string
execute-once (optional)
Boolean Execute workflow once with in a device group
mandatory-fields (optional)
name
String Measurement name for redirecting rule data. Format:
/. Should be of pattern [a-z][a-z-](.{1}[a-z0-9-]+)/[a-z][a-z0-9_-]* format: string
data-if-missing (optional)
path
String Reference to a field or trigger in different rule. Format is /topic[topic-name=
]/rule[rule-name=]/field[]/ for field reference and /topic[topic-name=]/rule[rule-name=]/trigger[trigger-name=]/key[condition]/trigger_field for trigger reference. Filtering part where field and key are mentioned is optional format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
Assign value for field in case of data missing
value (optional)
String Assign given default value for field in case of data missing format: string
field-name
String Name of the output field. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
type (optional)
string
integer
unsigned-integer
float
description (optional)
String Description about this field format: string
author (optional)
String E-mail address of the rule writer format: string
catalogue (optional)
contributor (optional)
juniper
external
category (optional)
basic
advanced
comprehensive
is-scaling-rule (optional)
date (optional)
helper-files (optional)
supported-devices (optional)
supported-healthbot-version (optional)
String Healthbot version in which is rule is supported format: string
version (optional)
Integer Rule version, an integer value needs to be incremented for any major change format: int32
apply-macro (optional)
Metadata to classify the rules
file-type
schema
mib
other
list-of-files
Scaling rule
description (optional)
String Description of how the rule affects scaling format: string
Devices in which the sensors used by the rule are supported
juniper (optional)
other-vendor (optional)
sensors (optional)
Supported juniper devices
operating-system (optional)
sensors (optional)
os-name
String Operating system for the supported devices
junos
junosEvolved
products (optional)
sensors (optional)
platform-name
String Platform name, Ex: MX960. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
releases (optional)
sensors (optional)
platforms (optional)
product-name
String Product name, Ex: MX, SRX. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
releases (optional)
sensors (optional)
release-name
String Release name, Should be of pattern (\d){1,2}
.{1}([\w-_.]*) format: string
release-support (optional)
String Specifies the min/max support for this release
max-supported-release
only-on-this-release
min-supported-release
sensors (optional)
platform (optional)
release-name
String Release name, Should be of pattern (\d){1,2}
.{1}([\w-_.]*) format: string
release-support (optional)
String Specifies the min/max support for this release
max-supported-release
only-on-this-release
min-supported-release
os-name
String Operating system for the supported devices format: string
products (optional)
sensors (optional)
apply-macro (optional)
operating-system (optional)
String [Deprecated] Vendor operating system, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
operating-systems (optional)
sensors (optional)
vendor-identifier
String Unique key to identify the other vendor specific products format: string
vendor-name
String Vendor name format: string
platform-name
String Platform name, Ex: MX960 format: string
releases (optional)
sensors (optional)
platforms (optional)
product-name
String Product name, Ex: MX, SRX format: string
sensors (optional)
release-name
String Release name format: string
release-support (optional)
String Specifies the min/max support for this release
max-supported-release
only-on-this-release
min-supported-release
sensors (optional)
data-if-missing (optional)
path
String Sensor path format: string
sensor-name
where (optional)
zero-suppression (optional)
array[Object] Assign zero as default value for field in case of zero-suppression
description (optional)
String Description about the sensor format: string
sflow (optional)
ifa (optional)
flow (optional)
iAgent (optional)
native-gpb (optional)
open-config (optional)
server-monitoring (optional)
sensor-name
String Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
snmp (optional)
snmp-notification (optional)
syslog (optional)
paragon-active-assurance (optional)
synopsis (optional)
String Synopsis about the sensor format: string
byoi (optional)
sensor-name
String Sensor to subscribe format: string
frequency
String Frequency at which data needs to be extracted from given SNMP table. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
scalars (optional)
table (optional)
String OID of an SNMP table format: string
pattern-set
String Pattern-set applicable for this sensor format: string
maximum-hold-period (optional)
String Maximum time (in units of seconds/minutes/hours/days) system will wait for all fields to arrive before flushing all the field data. Default is 1 second format: string
term-name
String Term name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
then (optional)
when (optional)
next (optional)
status (optional)
user-defined-action (optional)
workflow (optional)
argument
value
String Argument value format: string
Retry failed steps
backoff (optional)
limit (optional)
Integer Maximum number of retry attempts format: int32
Backoff retry attempts exponentially
duration (optional)
String Initial duration to wait before retrying failed step format: string
factor (optional)
Integer Wait duration multiplication factor during each retry attempt format: int32
max-duration (optional)
String Maximum duration to wait before retrying a failed step format: string
color
String Color that needs to be shown in the health tree format: string
green
yellow
red
message (optional)
String Descriotion that needs to be show in the health tree format: string
argument (optional)
function-name
argument (optional)
batch (optional)
Integer Maximum parallel steps launched format: int32
log-level (optional)
String Logging level of workflow
info
debug
error
retry (optional)
timeout (optional)
String Maximum time to wait for the step completion before bailing out (default 60 seconds) format: string
workflow-name
String Name of the workflow to trigger format: string
description (optional)
String Description about the trigger format: string
frequency (optional)
String Frequency or time interval at which the trigger needs to be evaluated. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
synopsis (optional)
String Synopsis about the trigger format: string
disable-alarm-deduplication (optional)
array[Object] Disable alarm deduplication, so that alarms are always generated
term
trigger-name
String Trigger name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
description (optional)
String Description about the variable format: string
name
String Variable name used in the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
type
String Type of value supported. This information will be used by UI to display options available for the values
int
integer
unsigned-integer
float
string
boolean
device-group
device
sensor-argument
value (optional)
String Default value for the variable format: string
formula (optional)
path (optional)
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
vector-name
String Name of the vector. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
does-not-match-with (optional)
equal-to (optional)
exists (optional)
matches-with-previous (optional)
does-not-match-with-previous (optional)
greater-than (optional)
greater-than-or-equal-to (optional)
increasing-at-least-by-rate (optional)
increasing-at-least-by-value (optional)
increasing-at-most-by-rate (optional)
increasing-at-most-by-value (optional)
less-than (optional)
less-than-or-equal-to (optional)
matches-with (optional)
max-rate-of-increase (optional)
min-rate-of-increase (optional)
not-equal-to (optional)
range (optional)
user-defined-function (optional)
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
ignore-case (optional)
left-operand
String Left operand. This is the string in which we have to match the expression. format: string
right-operand
String Right operand. This is the match expression. format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
left-operand
String Left operand format: string
right-operand
String right operand format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name which needs to be present format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
per
second
minute
hour
day
week
month
year
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
value (optional)
String Value part of rate. This can be a float or field name from this rule and should match the pattern (\d+(.\d{0,2})?)|($[a-z][a-zA-Z0-9_-]*) format: string
percentage (optional)
String Percentage of change from previous value. This can be a float or field name from this rule and should match the pattern (\d+(.\d{0,2})?)|($[a-z][a-zA-Z0-9_-]*) format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
value (optional)
String Value of increase between current and last reported values format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name which previous and current value needs to be matched format: string
ignore-case (optional)
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name on which rate should be compared format: string
rate (optional)
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
field-name
String Field name on which range should be applied format: string
max
Double Maximum value in the range format: double
min
Double Minumum value in the range format: double
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[Object] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[Object] With this flag, result is set to True if any one of the data matches the condition
latest (optional)
array[Object] With this flag, result is set to True if the latest data matches the condition
argument (optional)
function-name
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
query
String Query to filter ingest data format: string
enterprise
Integer Enterprise to which sample belongs format: int32
field
format
Integer Format of sample format: int32
record-type (optional)
String Type of records in this sample type
flow
counter
sample-name
String Name of sample type format: string
end-time (optional)
String End scheduler at this time format: string
name
String Name of the scheduler format: string
repeat (optional)
start-time
String Start scheduler at this time format: string
run-for (optional)
type (optional)
continuous
discrete
Control when to repeat scheduling
every (optional)
week
day
month
year
interval (optional)
never (optional)
Regular interval repetition
days (optional)
Integer Duration of time in days format: int32
hours (optional)
Integer Duration of time in hours format: int32
minutes (optional)
Integer Duration of time in minutes format: int32
Duration of time for the schedule to run after the start time
days (optional)
Integer Duration of time in days format: int32
hours (optional)
Integer Duration of time in hours format: int32
minutes (optional)
Integer Duration of time in minutes format: int32
Property key is service-name
sFlow ingest configuration
counter-record (optional)
flow-record (optional)
protocol (optional)
sample (optional)
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
description (optional)
String Description of field format: string
export-as (optional)
String Export field as tag/field
tag
field
field-name
String Field name that needs to be exported format: string
next-header (optional)
array[null] Flag to indicate current field points to next header format
size-based-on-field (optional)
size-in-bits (optional)
Integer Field size in bits format: int32
type (optional)
number
string
IpAddress
hardwareAddr
numbers
ASPath
field
number
Integer Protocol number unique to each protocol format: int32
protocol-name
String Name of protocol format: string
enterprise
Integer Enterprise to which sample belongs format: int32
field
format
Integer Format of sample format: int32
record-type (optional)
String Type of records in this sample type
flow
counter
sample-name
String Name of sample type format: string
Current field size derived using previous field values
then (optional)
when-equal (optional)
Field size to be considered when none of comparison passes
size (optional)
String Default field size format: string
Field size to be considered if when-equal is true
size (optional)
String Field size format: string
left-operand
String Left operand can be integer constant or '$' prefixed previous field name format: string
right-operand
String Right operand can be integer constant or '$' prefixed previous field name format: string
then (optional)
description (optional)
String Description about the site format: string
edge (optional)
site-name
String Name of the site. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
snmp-notification (optional)
SNMP Notification messages(Traps/Informs) ingest configuration
engine-id (optional)
String Autogenerated Engine-id for Healthbot in Hex Format Eg: '80001f8880bd5b8d052eb40d6000000000' format: string
port (optional)
Integer Port to listen for SNMP Notification(Traps/Informs) messages format: int32
v3 (optional)
SNMP version 3 configuration for HealthBot
SNMP User Security Model configuration
authentication (optional)
authentication-none (optional)
array[null] Configure no authentication for the SNMPv3 user
privacy (optional)
privacy-none (optional)
username
String SNMPv3 username format: string
Configure authentication for the SNMPv3 user
passphrase
String Passphrase for SNMPv3 authentication format: string
protocol
String SNMPv3 authentication protocol
MD5
SHA
SHA224
SHA256
SHA384
SHA512
Configure privacy for the SNMPv3 user
passphrase
String Passphrase for SNMPv3 privacy format: string
protocol
String SNMPv3 privacy protocol
DES
AES
AES192
AES256
AES192C
AES256C
3DES
name
String SSH Key profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
ssh-private-key-file
String SSH private key file name format: string
ssh-private-key-passphrase
String SSH private key passphrase format: string
port (optional)
Integer Port to listen for syslog messages, default is 514 format: int32
header-pattern (optional)
pattern (optional)
pattern-set (optional)
name
type
Prediction table
Rule Evaluation table
Field table
Sensor table
db_name (optional)
String Database name in which the measurement is present.
retention_policy (optional)
String Retention policy of the measurement
description (optional)
String Description about this tagging profile format: string
name
String Tagging profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
policy (optional)
description (optional)
String Description about policy format: string
name
String Policy name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
rules
term
term-name
String Term name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
then (optional)
when (optional)
add-field (optional)
add-key (optional)
next (optional)
name
String Tagged field name format: string
type (optional)
string
integer
unsigned-integer
float
value
String Tagged value format: string
in-memory (optional)
Boolean Look for value in internal cache
name
String Tagged key field name format: string
value
String Tagged value format: string
in-memory (optional)
Boolean Look for value in internal cache
does-not-match-with (optional)
equal-to (optional)
eval (optional)
exists (optional)
greater-than (optional)
greater-than-or-equal-to (optional)
less-than (optional)
less-than-or-equal-to (optional)
matches-with (optional)
matches-with-scheduler (optional)
does-not-match-with-scheduler (optional)
not-equal-to (optional)
left-operand
String Left operand. This is the string in which we have to match the expression format: string
right-operand
String Right operand. This is the match expression format: string
in-memory (optional)
Boolean Look for right-operand in internal cache
left-operand
String Left operand format: string
right-operand
String right operand format: string
in-memory (optional)
Boolean Look for right-operand in internal cache
expression
String Expression for evaluation must be a valid golang expression. Field-name if used in expression must be prefixed with $. operators should be prefix and suffix with spaces. For Example: $a + $b > $c format: string
field
String This is the string that we need to look for within path when in-memory is set to True, else this contains the field-name that we need to look for in TSDB format: string
path (optional)
String Look for the field value in the given path, if it exist as key in dict or value in list if in-memory is set to true format: string
in-memory (optional)
Boolean Look for field in internal cache path
scheduler
String Name of the scheduler defined within system/scheduler hierarchy format: string
time (optional)
String Field holding time in UNIX time format. Optional default is point time format: string
in-memory (optional)
Boolean Look for time in internal cache
description (optional)
String Template description. format: string
key-fields (optional)
name
String Name of the template. format: string
priority (optional)
Integer Priority given to template during matching. format: int32
protocol-version (optional)
v9
v10
recognition-pattern (optional)
time-range
String How much back in time should we look for data
brokers
collector-settings (optional)
name
String Name of this instance format: string
security (optional)
topics (optional)
Security settings
sasl (optional)
tls (optional)
SASL user authentication
password (optional)
String SASL password format: string
username (optional)
String SASL username format: string
description (optional)
String Description about this topic format: string
resource (optional)
rule (optional)
sub-topics (optional)
synopsis (optional)
String Short description about this topic format: string
topic-name
String Name of the topic. Should be of pattern [a-z][a-z-]
(.{1}[a-z0-9-]+) format: string
Action schedulers associated with triggers
fields (optional)
name (optional)
String Name of the trigger format: string
queryName (optional)
String Name of the query object. Optional. Not used for now
deviceGroup (optional)
String 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 (optional)
String 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
db (optional)
String Name of the database. Multiple databases should be separated by ','. '*' can be used to specify all databases.
topic (optional)
String Name of Healthbot topic. Optional if measurement is used
rule (optional)
String Name of Healthbot rule. Required if topic is used. Optional if measurement is used
trigger (optional)
String Name of Healthbot trigger. Optional if measurement is used or rule table is being queried
measurement (optional)
String Name of the measurement. Optional if topic/rule/trigger is used
where (optional)
String Where clause filters data based on fields, tags, and/or timestamps. Eg: where="interface-name" = 'ge-0/0/1' and "in-pkts" > 0
order (optional)
String Sort points in descending order based on time. By default points will be sorted in ascending order. Eg: order=desc
limit (optional)
Integer Limit number of points in the result. If groupBy is used limit is applied per group. Eg: limit=10 format: int32
fields (optional)
GroupBy (optional)
outerQueries (optional)
deviceAggregation (optional)
addDeviceAsTag (optional)
Boolean Add device-id tag as basis for aggregation
bottomLimit (optional)
Integer Fetch bottom N results format: int32
field
String Field based on whiuch to aggregate data format: string
topLimit (optional)
Integer Fetch Top N results format: int32
fields (optional)
groupBy (optional)
statement_id (optional)
database (optional)
series (optional)
name (optional)
tags (optional)
columns (optional)
values (optional)
dedicate (optional)
Boolean Dedicate given nodes only for tsdb instances. No other services will be spawned on tsdb nodes when set to true
nodes (optional)
replication-factor (optional)
Integer High availability. Number of copies of data to be stored format: int32
userName (optional)
firstName (optional)
lastName (optional)
email (optional)
password (optional)
active (optional)
groups (optional)
groupId (optional)
groupName (optional)
left-operand (optional)
right-operand (optional)
time-range (optional)
String How much back in time should we look for data
description (optional)
String Optional description about the argument format: string
name
String Name of the input argument passed to the workflow. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
value (optional)
String Optional default value for the argument format: string
Workflow command configuration
command-tag
String Command tag format: string
commands (optional)
ignore (optional)
delay (optional)
String Delay between this command's repeated attempts format: string
repeat (optional)
type (optional)
String Type of the data produced or consumed
data-xml
json
text
arguments (optional)
environment (optional)
device (optional)
device-group (optional)
command
String Execute this command format: string
Workflow Cron Workflow Options information
description (optional)
String Description about this cron workflow options format: string
schedule
String Cron expression of time at which workflow will be run format: string
concurrency-policy (optional)
String Policy that determines what to do if multiple Workflows are scheduled at the same time format: string
allow
replace
forbid
starting-deadline-duration (optional)
String Duration after the last successful run during which a missed Workflow will be run format: string
successful-jobs-history-limit (optional)
Integer Number of successful Workflows that will be persisted at a time format: int32
failed-jobs-history-limit (optional)
Integer Policy that determines what to do if multiple Workflows are scheduled at the same time format: int32
Workflow instance information
description (optional)
String Description about this workflow instance format: string
created-at (optional)
String Workflow instance creation time
started-at (optional)
String Workflow instance startup time
finished-at (optional)
String Workflow instance completion time
status (optional)
String Workflow instance current status
message (optional)
String Workflow instance current status message
devices (optional)
device-groups (optional)
parameters (optional)
argument (optional)
cron-options (optional)
batch (optional)
Integer Maximum parallel steps launched format: int32
pod-gc-strategy (optional)
String Garbage Collection Strategy for workflow pods format: string
retry (optional)
timeout (optional)
String Maximum time to wait for the step completion before bailing out (default 60 seconds) format: string
workflow-instance-name (optional)
String Name of the workflow instance format: string
workflow-name
String Name of the workflow. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
name
String Input argument name format: string
value (optional)
String Input argument value format: string
value-from (optional)
String Input argument value-from format: string
Workflow notification configuration
tag
payload (optional)
String Payload of the notification
Workflows configuration
description (optional)
String Description about this workflow format: string
entry-task (optional)
String Starting entry task of this workflow
exit-task (optional)
String Exit/Cleanup task to invoke after the completion of the workflow
log-level (optional)
String Logging level of workflow
info
debug
error
argument (optional)
cron-options (optional)
batch (optional)
Integer Maximum parallel steps launched format: int32
pod-gc-strategy (optional)
String Garbage Collection Strategy for workflow pods format: string
retry (optional)
timeout (optional)
String Maximum time to wait for the step completion before bailing out (default 60 seconds) format: string
task (optional)
workflow-name
String Name of the workflow. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
path (optional)
String Full path of file or directory to be exported as output of this step format: string
Glean output and export using xpath
xpath (optional)
String Export output using xpath format: string
Glean output and export using grok pattern
name
String Input paraameter name passed. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
value (optional)
String Input parameter value passed format: string
artifact (optional)
Glean output and export using json path
jqpath (optional)
String Export output using jqpath format: string
artifact (optional)
command-tag (optional)
String Command tag whose output is used for pattern match format: string
data-xml (optional)
description (optional)
String Exported output field desciption format: string
grok (optional)
json (optional)
name
String Output parameter name exported from the workflow. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
result (optional)
regex (optional)
Glean output using regular expressions
pattern (optional)
String Regular expression based pattern format: string
cli-command (optional)
executable (optional)
netconf-command (optional)
notification (optional)
condition (optional)
condition-description (optional)
String Description of the configured conditions format: string
condition-type (optional)
String Call the step if any of the conditions evaluates to true or all of the conditions evaluate to true (default any)
any
all
dependencies (optional)
description (optional)
String Description about the step being called format: string
input (optional)
output (optional)
step-name
String Name of the step being called. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
suspend (optional)
task (optional)
workflow (optional)
Suspend workflow execution
duration (optional)
String Duration to suspend execution. Default is to wait indefinitely until resumed format: string
Trigger another configured task in this workflow
name (optional)
String Name of the task to be called
parallel (optional)
array[Object] Run all steps in this task in parallel to one another
step (optional)
task-name
String Name of the task being called. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
Trigger another configured worlflow
name (optional)
String Name of the workflow to be called
Workflow statistics information
description (optional)
String Description about this workflow statistics format: string
total_run (optional)
Integer Total workflow instances run
total_succeeded (optional)
Integer Total workflow instances succeeded
total_failed (optional)
Integer Total workflow instances failed
total_running (optional)
Integer Total workflow instances running currently
total_suspended (optional)
Integer Total workflow instances suspended
Workflow configuration in bulk