Healthbot APIs
API interface for Healthbot application
Version: 1.0.0
BasePath:/api/v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Create groups (createGroups)
Create group in the system
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — group details
Request headers
Produces
This API call produces the 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
associated_group_schema
Create an user. (createUsers)
Create users in the system
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — List of users
Request headers
Return type
array[String]
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
400
Internal Error
Up
delete /group/{groupid}/
Delete groups (deleteGroup)
Delete the groups
Path parameters
groupid (required)
Path Parameter — Id of group
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
400
Internal Error
Up
delete /user/{userid}/
Delete list of users. (deleteUser)
Delete list of users from system, for administrative purpose
Path parameters
userid (required)
Path Parameter — Id of user
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
400
Internal Error
Flush the groups (flushGroups)
Flush the existing groups and create new set of groups
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Group 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
400
Internal Error
associated_group_schema
Flush user base with new set of records. (flushUsers)
Flush the user base with new records
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — User details
Request headers
Return type
Example data
Content-Type: application/json
[ {
"userName" : "userName",
"userId" : "userId"
}, {
"userName" : "userName",
"userId" : "userId"
} ]
Produces
This API call produces the 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 lits of all the groups (getGroupDetails)
Get list of registered groups, for administrative purpose
Path parameters
groupid (required)
Path Parameter — Id of group
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"groupName" : "groupName",
"groupDescription" : "groupDescription",
"groupId" : "groupId",
"roles" : "",
"users" : ""
}
Produces
This API call produces the 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_8
400
Internal Error
Get lits of all the users (getUserDetails)
Get details of registered users, for administrative purpose
Path parameters
userid (required)
Path Parameter — Id of user
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"firstName" : "firstName",
"lastName" : "lastName",
"active" : true,
"groups" : "",
"userName" : "userName",
"userId" : "userId",
"email" : "email"
}
Produces
This API call produces the 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_4
400
Internal Error
Get lits of all the groups (retrieveGroups)
Get list of registered groups, for administrative purpose
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
[ {
"groupName" : "groupName",
"groupDescription" : "groupDescription",
"groupId" : "groupId",
"roles" : "",
"users" : ""
}, {
"groupName" : "groupName",
"groupDescription" : "groupDescription",
"groupId" : "groupId",
"roles" : "",
"users" : ""
} ]
Produces
This API call produces the 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 list of all the roles (retrieveRoles)
Get list of registered roles, for administrative purpose
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
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
role_schema
400
Internal Error
Get lits of all the users (retrieveUsers)
Get list of registered users, for administrative purpose
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
[ {
"firstName" : "firstName",
"lastName" : "lastName",
"active" : true,
"userName" : "userName",
"userId" : "userId",
"email" : "email"
}, {
"firstName" : "firstName",
"lastName" : "lastName",
"active" : true,
"userName" : "userName",
"userId" : "userId",
"email" : "email"
} ]
Produces
This API call produces the 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 /group/{groupid}/
Get lits of all the roles (updateGroup)
Update group
Path parameters
groupid (required)
Path Parameter — Id of group
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — group details
Request headers
Return type
Example data
Content-Type: application/json
{
"groupName" : "groupName",
"groupId" : "groupId"
}
Produces
This API call produces the 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_9
400
Internal Error
Update user profile informations. (updateUserProfile)
Update a user profile in the system
Path parameters
userid (required)
Path Parameter — Id of user
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — user details
Request headers
Produces
This API call produces the 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
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
{
"accessToken" : "accessToken",
"refreshToken" : "refreshToken"
}
Produces
This API call produces the 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_7
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" : "tokenExpires",
"refreshTokenExpires" : "refreshTokenExpires",
"firstLogin" : true,
"accessToken" : "accessToken",
"refreshToken" : "refreshToken"
}
Produces
This API call produces the 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_6
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 /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 /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
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 /device/{device_id}/
Update or create a device. (createIcebergDeviceDeviceById)
Create/Update a device by device-id. The device-id specified in URL and the request body must match. If the device already exists then, old content will be updated with the new content.
Path parameters
device_id (required)
Path Parameter — ID of device-id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
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 /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
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.
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 /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
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 /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
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 /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
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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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
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 /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
200
Successful operation
400
Internal Error
Up
delete /network-groups/
Delete all network-groups. (deleteIcebergNetworkGroupsNetworkGroupsById)
Delete all network-groups. Delete will fail if services are still running for the network groups.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API 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 /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 /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 /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
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 /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 /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /system-settings/report-generation/destination/{name}/
Delete destination by name (deleteIcebergSystemSettingsDestinationById)
Delete a destination by name. Delete will fail if the destination is being referenced by a report.
Path parameters
name (required)
Path Parameter — 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
200
Successful operation
400
Internal Error
Up
delete /system-settings/report-generation/destinations/
Delete destinations by name (deleteIcebergSystemSettingsDestinations)
Delete all destinations. This will fail if any destination is referenced in any report.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the 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 /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
200
Successful operation
400
Internal Error
Up
delete /system-settings/report-generation/reports/
Delete reports by name (deleteIcebergSystemSettingsReports)
Delete all reports. This will fail if any report is referenced in any device-group or network-group.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the 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 /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
200
Successful operation
400
Internal Error
Up
delete /system-settings/schedulers/
Delete schedulers by name (deleteIcebergSystemSettingsSchedulers)
Delete all schedulers. This will fail if any scheduler is referenced in any report.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the 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 /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
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 /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 /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
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
Request headers
Produces
This API call produces the 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 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" : [ "network-groups", "network-groups" ],
"device-groups" : [ "device-groups", "device-groups" ]
}
Produces
This 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
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 /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
{
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}
Produces
This API call produces the 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
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 /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" : [ "reports", "reports" ],
"devices" : [ "devices", "devices" ],
"timezone" : "timezone",
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"description" : "description",
"playbooks" : [ "playbooks", "playbooks" ],
"syslog" : {
"ports" : [ 9607, 9607 ]
},
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"raw-data" : {
"summarize" : {
"summarization-profile" : [ "summarization-profile", "summarization-profile" ],
"time-span" : "time-span"
},
"persist" : "{}"
},
"device-group-name" : "device-group-name",
"native-gpb" : {
"ports" : [ 0, 0 ]
},
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ],
"sensor" : [ "sensor", "sensor" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"logging" : {
"open-config" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"native-gpb" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"snmp" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"syslog" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"iAgent" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
},
"flow" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"byoi" : {
"service" : [ {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
}, {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
} ]
}
},
"flow" : {
"netflow" : {
"ports" : [ 6, 6 ]
},
"deploy-nodes" : [ "deploy-nodes", "deploy-nodes" ]
},
"retention-policy" : "retention-policy",
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}
Produces
This API call produces the 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
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" : [ "reports", "reports" ],
"devices" : [ "devices", "devices" ],
"timezone" : "timezone",
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"description" : "description",
"playbooks" : [ "playbooks", "playbooks" ],
"syslog" : {
"ports" : [ 9607, 9607 ]
},
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"raw-data" : {
"summarize" : {
"summarization-profile" : [ "summarization-profile", "summarization-profile" ],
"time-span" : "time-span"
},
"persist" : "{}"
},
"device-group-name" : "device-group-name",
"native-gpb" : {
"ports" : [ 0, 0 ]
},
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ],
"sensor" : [ "sensor", "sensor" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"logging" : {
"open-config" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"native-gpb" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"snmp" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"syslog" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"iAgent" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
},
"flow" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"byoi" : {
"service" : [ {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
}, {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
} ]
}
},
"flow" : {
"netflow" : {
"ports" : [ 6, 6 ]
},
"deploy-nodes" : [ "deploy-nodes", "deploy-nodes" ]
},
"retention-policy" : "retention-policy",
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}, {
"reports" : [ "reports", "reports" ],
"devices" : [ "devices", "devices" ],
"timezone" : "timezone",
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"description" : "description",
"playbooks" : [ "playbooks", "playbooks" ],
"syslog" : {
"ports" : [ 9607, 9607 ]
},
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"raw-data" : {
"summarize" : {
"summarization-profile" : [ "summarization-profile", "summarization-profile" ],
"time-span" : "time-span"
},
"persist" : "{}"
},
"device-group-name" : "device-group-name",
"native-gpb" : {
"ports" : [ 0, 0 ]
},
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ],
"sensor" : [ "sensor", "sensor" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"logging" : {
"open-config" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"native-gpb" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"snmp" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"syslog" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"iAgent" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
},
"flow" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"byoi" : {
"service" : [ {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
}, {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ],
"name" : "name"
} ]
}
},
"flow" : {
"netflow" : {
"ports" : [ 6, 6 ]
},
"deploy-nodes" : [ "deploy-nodes", "deploy-nodes" ]
},
"retention-policy" : "retention-policy",
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
} ]
}
Produces
This API call produces the 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" : [ {
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}, {
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
} ]
}
Produces
This API call produces the 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
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 /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
{
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"reports" : [ "reports", "reports" ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"network-group-name" : "network-group-name",
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"description" : "description",
"logging" : {
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
}
},
"playbooks" : [ "playbooks", "playbooks" ]
}
Produces
This API call produces the 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
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" : [ {
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"reports" : [ "reports", "reports" ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"network-group-name" : "network-group-name",
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"description" : "description",
"logging" : {
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
}
},
"playbooks" : [ "playbooks", "playbooks" ]
}, {
"scheduler" : [ {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
}, {
"schedule" : "schedule",
"instance-id" : "instance-id",
"rule" : "rule",
"playbook" : "playbook"
} ],
"reports" : [ "reports", "reports" ],
"notification" : {
"normal" : [ "normal", "normal" ],
"major" : [ "major", "major" ],
"minor" : [ "minor", "minor" ],
"enable" : ""
},
"ingest-frequency" : [ "ingest-frequency", "ingest-frequency" ],
"network-group-name" : "network-group-name",
"publish" : {
"field" : [ "field", "field" ],
"destination" : [ "destination", "destination" ]
},
"variable" : [ {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"running-state" : "running",
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"description" : "description",
"logging" : {
"trigger-evaluation" : {
"log-level" : "error"
},
"log-level" : "error",
"non-sensor-rules" : {
"log-level" : "error",
"daemons" : [ "ingest", "ingest" ]
},
"reports-generation" : {
"log-level" : "error"
},
"ML-model-builder" : {
"log-level" : "error"
}
},
"playbooks" : [ "playbooks", "playbooks" ]
} ]
}
Produces
This API call produces the 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
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 /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" : "password",
"username" : "username"
},
"url" : "url"
},
"emails" : {
"filter" : {
"rules" : [ "rules", "rules" ]
},
"ids" : [ "ids", "ids" ]
},
"microsoft-teams" : {
"channel" : "channel"
},
"notification-name" : "notification-name",
"slack" : {
"channel" : "channel",
"url" : "url"
},
"kafka-publish" : {
"sasl" : {
"password" : "password",
"certificate" : "certificate",
"username" : "username"
},
"bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
"topic" : "topic"
},
"description" : "description"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
notification_schema
400
Internal Error
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" : "password",
"username" : "username"
},
"url" : "url"
},
"emails" : {
"filter" : {
"rules" : [ "rules", "rules" ]
},
"ids" : [ "ids", "ids" ]
},
"microsoft-teams" : {
"channel" : "channel"
},
"notification-name" : "notification-name",
"slack" : {
"channel" : "channel",
"url" : "url"
},
"kafka-publish" : {
"sasl" : {
"password" : "password",
"certificate" : "certificate",
"username" : "username"
},
"bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
"topic" : "topic"
},
"description" : "description"
}, {
"http-post" : {
"basic" : {
"password" : "password",
"username" : "username"
},
"url" : "url"
},
"emails" : {
"filter" : {
"rules" : [ "rules", "rules" ]
},
"ids" : [ "ids", "ids" ]
},
"microsoft-teams" : {
"channel" : "channel"
},
"notification-name" : "notification-name",
"slack" : {
"channel" : "channel",
"url" : "url"
},
"kafka-publish" : {
"sasl" : {
"password" : "password",
"certificate" : "certificate",
"username" : "username"
},
"bootstrap-servers" : [ "bootstrap-servers", "bootstrap-servers" ],
"topic" : "topic"
},
"description" : "description"
} ]
}
Produces
This API call produces the following media types according to the 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 /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
Return type
Example data
Content-Type: application/json
{
"playbook-name" : "playbook-name",
"description" : "description",
"rules" : [ "rules", "rules" ],
"synopsis" : "synopsis"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
playbook_schema
400
Internal Error
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" : "playbook-name",
"description" : "description",
"rules" : [ "rules", "rules" ],
"synopsis" : "synopsis"
}, {
"playbook-name" : "playbook-name",
"description" : "description",
"rules" : [ "rules", "rules" ],
"synopsis" : "synopsis"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
playbooks_schema
400
Internal Error
Up
get /retention-policies/
Get all retention-policies' configuration. (retrieveIcebergRetentionPoliciesRetentionPoliciesById)
Get the configuration of all the retention-policies.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
working (optional)
Query Parameter — true queries un-committed configuration
Return type
Example data
Content-Type: application/json
{
"retention-policy" : [ {
"duration" : "duration",
"replication" : 0,
"retention-policy-name" : "retention-policy-name"
}, {
"duration" : "duration",
"replication" : 0,
"retention-policy-name" : "retention-policy-name"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
retention-policies_schema
400
Internal Error
Up
get /retention-policy/
List all retention-policy-names. (retrieveIcebergRetentionPolicyRetentionPolicy)
Get a list of all the retention-policy-names.
Consumes
This API call consumes the following media types via the
Content-Type request header:
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 /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" : "duration",
"replication" : 0,
"retention-policy-name" : "retention-policy-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.
Responses
200
Successful operation
retention-policy_schema
400
Internal Error
Up
get /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" : "name",
"email" : {
"id" : "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.
Responses
200
Successful operation
destination_schema
400
Internal Error
Up
get /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" : "name",
"email" : {
"id" : "id"
}
}, {
"disk" : {
"max-reports" : 0
},
"name" : "name",
"email" : {
"id" : "id"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
destinations_schema
400
Internal Error
Up
get /system/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" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "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.
Responses
200
Successful operation
report_schema
400
Internal Error
Up
get /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" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "name"
}, {
"schedule" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "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.
Responses
200
Successful operation
reports_schema
400
Internal Error
Up
get /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" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"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 /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" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"type" : "continuous"
}, {
"start-time" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"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 /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" : "name",
"email" : {
"id" : "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.
Responses
200
Successful operation
destination_schema
400
Internal Error
Up
get /system-settings/report-generation/destinations/
Retrieve destinations by name (retrieveIcebergSystemSettingsDestinations)
Get the configuration details of all destinations.
Consumes
This API call consumes the following media types via the
Content-Type request header:
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" : "name",
"email" : {
"id" : "id"
}
}, {
"disk" : {
"max-reports" : 0
},
"name" : "name",
"email" : {
"id" : "id"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
destinations_schema
400
Internal Error
Up
get /system-settings/report-generation/report/{name}/
Retrieve report by name (retrieveIcebergSystemSettingsReportById)
Get the configuration details of a report by its name.
Path parameters
name (required)
Path Parameter — 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" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "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.
Responses
200
Successful operation
report_schema
400
Internal Error
Up
get /system-settings/report-generation/reports/
Retrieve reports by name (retrieveIcebergSystemSettingsReports)
Get the configuration details of all reports.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Query parameters
working (optional)
Query Parameter — true queries undeployed configuration
Return type
Example data
Content-Type: application/json
{
"report" : [ {
"schedule" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "name"
}, {
"schedule" : [ "schedule", "schedule" ],
"graph-canvas" : [ {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
}, {
"name" : "name",
"canvas-panel" : [ {
"name" : "name"
}, {
"name" : "name"
} ]
} ],
"destination" : [ "destination", "destination" ],
"format" : "json",
"name" : "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.
Responses
200
Successful operation
reports_schema
400
Internal Error
Up
get /system-settings/scheduler/{name}/
Retrieve scheduler by name (retrieveIcebergSystemSettingsSchedulerById)
Get the configuration details of a scheduler by its name.
Path parameters
name (required)
Path Parameter — 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" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"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 /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" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"type" : "continuous"
}, {
"start-time" : "start-time",
"end-time" : "end-time",
"run-for" : {
"hours" : 36944,
"minutes" : 15087,
"days" : 39073
},
"repeat" : {
"never" : "",
"interval" : {
"hours" : 39501,
"minutes" : 9607,
"days" : 5249
},
"every" : "week"
},
"name" : "name",
"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
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 /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
action (optional)
Query Parameter — Action to be performed
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 /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
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 /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" : [ "sub-topics", "sub-topics" ],
"description" : "description",
"rule" : [ {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
}, {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
} ],
"synopsis" : "synopsis",
"topic-name" : "topic-name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
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" : [ "sub-topics", "sub-topics" ],
"description" : "description",
"rule" : [ {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
}, {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
} ],
"synopsis" : "synopsis",
"topic-name" : "topic-name"
}, {
"sub-topics" : [ "sub-topics", "sub-topics" ],
"description" : "description",
"rule" : [ {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
}, {
"description" : "This rule collects bgp session route flap damping statistics periodically and notifies in case of anomalies",
"field" : [ {
"description" : "This field is for neighbor address",
"field-name" : "neighbor-address",
"sensor" : [ {
"path" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address",
"sensor-name" : "bgp-sensor",
"where" : [ {
"query" : "/network-instances/network-instance/protocols/protocol/bgp/neighbors/neighbor/@neighbor-address =~ /{{neighbors}}/"
} ]
} ],
"type" : "string"
} ],
"keys" : [ "neighbor-address" ],
"rule-name" : "check-bgp-route-flap-damping",
"sensor" : [ {
"description" : "/protocol/bgp open-config sensor to collect telemetry data from network device",
"open-config" : {
"frequency" : "10s",
"sensor-name" : "/network-instances/network-instance/protocols/protocol/bgp/"
},
"sensor-name" : "bgp-sensor",
"synopsis" : "bgp open-config sensor definition"
} ],
"synopsis" : "bgp session state analyzer",
"trigger" : [ {
"description" : "Sets health based on bgp neighbor route flap damping.",
"synopsis" : "bgp neighbor route flap damping kpi",
"term" : [ {
"term-name" : "is-neighbor-route-flap-damping",
"then" : {
"status" : {
"color" : "red",
"message" : "Observed route-flap-damping"
}
},
"when" : {
"does-not-match-with" : [ {
"left-operand" : "$route-flap-damping",
"right-operand" : "false"
} ]
}
} ],
"trigger-name" : "neigbor-route-flap-damping"
} ],
"variable" : [ {
"description" : "Enter neighbor name or address using regular expression",
"name" : "neighbors",
"type" : "string",
"value" : ".*"
} ]
} ],
"synopsis" : "synopsis",
"topic-name" : "topic-name"
} ]
}
Produces
This API call produces the following media types according to the 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
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 /configuration/
Delete the un-committed configuration. (rollbackUnsavedConfiguration)
The API server follows a commit model. Unsaved configuration is called a working configuration. This API call deletes the working configuration.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful operation
default
Unexpected error
Error
Up
put /device/{device_id}/
Overwrite a device. (updateIcebergDeviceDeviceById)
Overwrite a device by device ID. The device ID specified in the URL and the request body must match.
Path parameters
device_id (required)
Path Parameter — ID of device-id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
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 /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
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 /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
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 /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
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 /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
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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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
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 /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 /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
Get users profile information (userRetrieveUserProfile)
Get user profile
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"firstName" : "firstName",
"lastName" : "lastName",
"userName" : "userName",
"userId" : "userId",
"email" : "email"
}
Produces
This API call produces the 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_5
400
Internal Error
Update user profile informations. (userUpdateUserProfile)
Update user profile in the system
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — topics body object
Request headers
Return type
Example data
Content-Type: application/json
[ {
"userName" : "userName",
"userId" : "userId"
}, {
"userName" : "userName",
"userId" : "userId"
} ]
Produces
This API call produces the 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 /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 /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 /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" : "group-name",
"value" : "{}",
"key" : "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
datastore_schema
400
Internal Error
Up
put /data-store/{group_name}/
Update data_store details. (updateDataStore)
Update data-store details in database for the requested group name and key.
Path parameters
group_name (required)
Path Parameter — Group name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
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
Up
get /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 /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 /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 /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 /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 /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 /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
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 /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 /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 /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 /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 /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 /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 /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 /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 /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 /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
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
delete /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 /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 /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
Up
delete /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
200
Successful operation
400
Internal Error
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
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 /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 /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" : "job-result",
"job-status" : "finished"
}, {
"job-id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"job-result" : "job-result",
"job-status" : "finished"
} ]
Produces
This API call produces the following media types according to the 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" : "db_name",
"name" : "name",
"type" : "Prediction table"
}, {
"db_name" : "db_name",
"name" : "name",
"type" : "Prediction table"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"color" : "yellow",
"event_name" : "event_name",
"frequency" : 0,
"timestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the 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 /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 /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 /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 /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" : "service-name",
"security-parameters" : {
"user-authentication" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"name" : "name",
"parameters" : [ {
"value" : "value",
"key" : "key"
}, {
"value" : "value",
"key" : "key"
} ],
"plugin-name" : "plugin-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.
Responses
200
Successful operation
custom-plugin_schema
400
Internal Error
Up
get /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" : "service-name",
"security-parameters" : {
"user-authentication" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"name" : "name",
"parameters" : [ {
"value" : "value",
"key" : "key"
}, {
"value" : "value",
"key" : "key"
} ],
"plugin-name" : "plugin-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.
Responses
200
Successful operation
custom-plugin_schema
400
Internal Error
Up
get /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" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"brokers" : [ "brokers", "brokers" ],
"topics" : [ "topics", "topics" ],
"name" : "name",
"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 /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
[ "", "" ]
Produces
This API call produces the 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 /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" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"netflow" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"native-gpb" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"name" : "name",
"snmp" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"syslog" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"iAgent" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"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 /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
[ "", "" ]
Produces
This API call produces the 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 /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
[ "", "" ]
Produces
This API call produces the 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 /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" : "name",
"sensor" : [ {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
}, {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
} ],
"non-sensor" : [ {
"rule-name" : "rule-name",
"frequency" : "frequency"
}, {
"rule-name" : "rule-name",
"frequency" : "frequency"
} ]
}
Produces
This API call produces the 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
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" : [ "nodes", "nodes" ],
"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
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
{
"ingest-settings" : {
"frequency-profile" : [ {
"name" : "name",
"sensor" : [ {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
}, {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
} ],
"non-sensor" : [ {
"rule-name" : "rule-name",
"frequency" : "frequency"
}, {
"rule-name" : "rule-name",
"frequency" : "frequency"
} ]
}, {
"name" : "name",
"sensor" : [ {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
}, {
"sensor-name" : "sensor-name",
"frequency" : "frequency"
} ],
"non-sensor" : [ {
"rule-name" : "rule-name",
"frequency" : "frequency"
}, {
"rule-name" : "rule-name",
"frequency" : "frequency"
} ]
} ],
"syslog" : {
"port" : 6,
"pattern" : [ {
"filter" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-id"
}, {
"filter" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-id"
} ],
"pattern-set" : [ {
"name" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
}, {
"name" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
} ]
},
"flow" : {
"template" : [ {
"recognition-pattern" : {
"exclude-fields" : [ "exclude-fields", "exclude-fields" ],
"include-fields" : [ "include-fields", "include-fields" ]
},
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"protocol-version" : "v9",
"priority" : 0
}, {
"recognition-pattern" : {
"exclude-fields" : [ "exclude-fields", "exclude-fields" ],
"include-fields" : [ "include-fields", "include-fields" ]
},
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"protocol-version" : "v9",
"priority" : 0
} ]
},
"byoi" : {
"custom-plugin" : [ {
"service-name" : "service-name",
"security-parameters" : {
"user-authentication" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"name" : "name",
"parameters" : [ {
"value" : "value",
"key" : "key"
}, {
"value" : "value",
"key" : "key"
} ],
"plugin-name" : "plugin-name"
}, {
"service-name" : "service-name",
"security-parameters" : {
"user-authentication" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"name" : "name",
"parameters" : [ {
"value" : "value",
"key" : "key"
}, {
"value" : "value",
"key" : "key"
} ],
"plugin-name" : "plugin-name"
} ],
"default-plugin" : {
"tlive-kafka-oc" : [ {
"security" : {
"sasl" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"brokers" : [ "brokers", "brokers" ],
"topics" : [ "topics", "topics" ],
"name" : "name",
"collector-settings" : "{}"
}, {
"security" : {
"sasl" : {
"password" : "password",
"username" : "username"
},
"tls" : {
"local-certificate-profile" : "local-certificate-profile",
"ca-profile" : "ca-profile",
"insecure-skip-verify" : true
}
},
"brokers" : [ "brokers", "brokers" ],
"topics" : [ "topics", "topics" ],
"name" : "name",
"collector-settings" : "{}"
} ]
},
"ingest-mapping" : [ {
"open-config" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"netflow" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"native-gpb" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"name" : "name",
"snmp" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"syslog" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"iAgent" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
}
}, {
"open-config" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"netflow" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"native-gpb" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"name" : "name",
"snmp" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"syslog" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"type" : "default-plugin"
}
},
"iAgent" : {
"for-device-groups" : [ "for-device-groups", "for-device-groups" ],
"use-plugin" : {
"instance" : "instance",
"name" : "name",
"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-settings_schema
400
Internal Error
Up
get /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" : [ "exclude-fields", "exclude-fields" ],
"include-fields" : [ "include-fields", "include-fields" ]
},
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"protocol-version" : "v9",
"priority" : 0
}, {
"recognition-pattern" : {
"exclude-fields" : [ "exclude-fields", "exclude-fields" ],
"include-fields" : [ "include-fields", "include-fields" ]
},
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"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 /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" : [ "exclude-fields", "exclude-fields" ],
"include-fields" : [ "include-fields", "include-fields" ]
},
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"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 /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
[ "", "" ]
Produces
This API call produces the 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 /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" : {
"port" : 0,
"pattern" : [ {
"filter" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-id"
}, {
"filter" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-id"
} ],
"pattern-set" : [ {
"name" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
}, {
"name" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
} ]
}
}
Produces
This API call produces the 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 /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" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-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.
Responses
200
Successful operation
pattern_schema
400
Internal Error
Up
get /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
[ "", "" ]
Produces
This API call produces the 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 /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" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
}
Produces
This API call produces the 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 /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
[ "", "" ]
Produces
This API call produces the 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 /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" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
}, {
"name" : "name",
"pattern-names" : [ "pattern-names", "pattern-names" ],
"description" : "description"
} ]
Produces
This API call produces the 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 /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" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-id"
}, {
"filter" : "filter",
"constant" : [ {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
}, {
"name" : "name",
"description" : "description",
"type" : "integer",
"value" : "value"
} ],
"field" : [ {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
}, {
"name" : "name",
"description" : "description",
"from" : "from",
"type" : "integer"
} ],
"name" : "name",
"description" : "description",
"key-fields" : [ "key-fields", "key-fields" ],
"filter-type" : "grok",
"event-id" : "event-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.
Responses
200
Successful operation
400
Internal Error
Up
get /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" : "name",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
} ],
"name" : "name",
"data-type" : [ {
"name" : "string",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "string",
"aggregation-functions" : [ "latest", "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 /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" : "name",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
} ],
"name" : "name",
"data-type" : [ {
"name" : "string",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "string",
"aggregation-functions" : [ "latest", "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 /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" : "certificate-authority-crt",
"name" : "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.
Responses
200
Successful operation
ca-profile_schema
400
Internal Error
Up
get /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
[ "", "" ]
Produces
This API call produces the 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 /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" : "client-crt",
"name" : "name",
"client-key" : "client-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
local-certificate_schema
400
Internal Error
Up
get /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
[ "", "" ]
Produces
This API call produces the 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 /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" : "ssh-private-key-file",
"ssh-private-key-passphrase" : "ssh-private-key-passphrase",
"name" : "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.
Responses
200
Successful operation
ssh-key-profile_schema
400
Internal Error
Up
get /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
[ "", "" ]
Produces
This API call produces the 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" : {
"security" : {
"ca-profile" : [ {
"certificate-authority-crt" : "certificate-authority-crt",
"name" : "name"
}, {
"certificate-authority-crt" : "certificate-authority-crt",
"name" : "name"
} ],
"ssh-key-profile" : [ {
"ssh-private-key-file" : "ssh-private-key-file",
"ssh-private-key-passphrase" : "ssh-private-key-passphrase",
"name" : "name"
}, {
"ssh-private-key-file" : "ssh-private-key-file",
"ssh-private-key-passphrase" : "ssh-private-key-passphrase",
"name" : "name"
} ],
"local-certificate" : [ {
"client-crt" : "client-crt",
"name" : "name",
"client-key" : "client-key"
}, {
"client-crt" : "client-crt",
"name" : "name",
"client-key" : "client-key"
} ]
},
"data-summarization" : {
"raw" : [ {
"path" : [ {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
} ],
"name" : "name",
"data-type" : [ {
"name" : "string",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "string",
"aggregation-functions" : [ "latest", "latest" ]
} ]
}, {
"path" : [ {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "name",
"aggregation-functions" : [ "latest", "latest" ]
} ],
"name" : "name",
"data-type" : [ {
"name" : "string",
"aggregation-functions" : [ "latest", "latest" ]
}, {
"name" : "string",
"aggregation-functions" : [ "latest", "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 /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 /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 /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 /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
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
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 /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 /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 /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 /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 /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 /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 /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 /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 /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
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
Up
get /device/{device_id}/facts/
Get a device's facts. (retrieveIcebergDeviceDeviceFactsById)
Get the fact details of a device by its device-id.
Path parameters
device_id (required)
Path Parameter — ID of device-id
Consumes
This API call consumes the following media types via the
Content-Type request header:
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
{
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}
Produces
This API call produces the 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
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
{
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}
Produces
This API call produces the 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 /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
{
"open-config" : {
"port" : 39501
},
"timezone" : "timezone",
"description" : "description",
"snmp" : {
"port" : 9607,
"v2" : {
"community" : "community"
}
},
"syslog" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ],
"hostnames" : [ "hostnames", "hostnames" ]
},
"device-id" : "device-id",
"iAgent" : {
"port" : 5249
},
"system-id" : "system-id",
"vendor" : {
"juniper" : {
"operating-system" : "junos"
},
"cisco" : {
"operating-system" : "iosxr"
},
"other-vendor" : {
"operating-system" : "operating-system",
"vendor-name" : "vendor-name"
}
},
"host" : "host",
"variable" : [ {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
}, {
"instance-id" : "instance-id",
"rule" : "rule",
"variable-value" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"playbook" : "playbook"
} ],
"flow" : {
"source-ip-addresses" : [ "source-ip-addresses", "source-ip-addresses" ]
},
"authentication" : {
"password" : {
"password" : "password",
"username" : "username"
},
"ssh" : {
"ssh-key-profile" : "ssh-key-profile",
"username" : "username"
},
"ssl" : {
"ca-profile" : "ca-profile",
"server-common-name" : "server-common-name",
"local-certificate" : "local-certificate"
}
}
}
Produces
This API call produces the 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 /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" : "group-name",
"group-type" : "device-group",
"name" : "name",
"rule" : "rule",
"state" : "active",
"playbook" : "playbook"
}, {
"group-name" : "group-name",
"group-type" : "device-group",
"name" : "name",
"rule" : "rule",
"state" : "active",
"playbook" : "playbook"
} ]
}
Produces
This API call produces the 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 /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_1
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" : "feature-name",
"license-requested" : 0,
"mode" : "invalid",
"feature-id" : 0,
"validity-type" : "invalid",
"end-date" : 0,
"feature-description" : "feature-description",
"license-usage" : 0,
"compliance" : true,
"valid-until" : "valid-until",
"max-remaining-days" : 0
}, {
"license-remaining" : 0,
"license-total" : 0,
"feature-name" : "feature-name",
"license-requested" : 0,
"mode" : "invalid",
"feature-id" : 0,
"validity-type" : "invalid",
"end-date" : 0,
"feature-description" : "feature-description",
"license-usage" : 0,
"compliance" : true,
"valid-until" : "valid-until",
"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" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
}, {
"feature-id" : 0,
"feature-description" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
} ],
"customer-id" : "customer-id",
"license-id" : "license-id",
"start-date" : "2000-01-23T04:56:07.000+00:00",
"order-type" : "unknown",
"version" : 1,
"sku-name" : "sku-name",
"sw-serial-id" : "sw-serial-id"
}, {
"mode" : "invalid",
"end-date" : "2000-01-23T04:56:07.000+00:00",
"validity-type" : "invalid",
"features" : [ {
"feature-id" : 0,
"feature-description" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
}, {
"feature-id" : 0,
"feature-description" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
} ],
"customer-id" : "customer-id",
"license-id" : "license-id",
"start-date" : "2000-01-23T04:56:07.000+00:00",
"order-type" : "unknown",
"version" : 1,
"sku-name" : "sku-name",
"sw-serial-id" : "sw-serial-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.
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" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
}, {
"feature-id" : 0,
"feature-description" : "feature-description",
"capacity-flag" : true,
"feature-name" : "feature-name",
"capacity-value" : 0
} ],
"customer-id" : "customer-id",
"license-id" : "license-id",
"start-date" : "2000-01-23T04:56:07.000+00:00",
"order-type" : "unknown",
"version" : 1,
"sku-name" : "sku-name",
"sw-serial-id" : "sw-serial-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.
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_1
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 /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 /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 /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 /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 /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 /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
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 /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
[ Jump to Methods ]
Table of Contents
Error - affected-groups - apply-macro_schema - applymacro_schema_data - associated_group_schema - associated_role_schema - associated_user_schema - associated_user_schema_inner - ca-profile_schema - command-rpc - commit-job - credential - custom-plugin_schema - custom-plugins_schema - customplugin_schema_parameters - customplugin_schema_securityparameters - customplugin_schema_securityparameters_tls - customplugin_schema_securityparameters_userauthentication - datastore_schema - debug-arguments_schema - debug-job-response_schema - destination_schema - destination_schema_disk - destination_schema_email - destinations_schema - device-group_schema - device-groups_schema - deviceGroupHealthTree - deviceHealthSchema - deviceHealthTree - device_schema - device_schema_flow - device_schema_iAgent - device_schema_openconfig - device_schema_snmp - device_schema_snmp_v2 - device_schema_syslog - device_schema_variable - device_schema_vendor - device_schema_vendor_cisco - device_schema_vendor_juniper - device_schema_vendor_othervendor - devicegroup_schema_authentication - devicegroup_schema_authentication_password - devicegroup_schema_authentication_ssh - devicegroup_schema_authentication_ssl - devicegroup_schema_flow - devicegroup_schema_flow_netflow - 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_nativegpb - devicegroup_schema_logging_nonsensorrules - devicegroup_schema_logging_openconfig - devicegroup_schema_logging_reportsgeneration - devicegroup_schema_logging_snmp - devicegroup_schema_logging_syslog - devicegroup_schema_logging_triggerevaluation - devicegroup_schema_nativegpb - devicegroup_schema_notification - devicegroup_schema_publish - devicegroup_schema_rawdata - devicegroup_schema_rawdata_summarize - devicegroup_schema_scheduler - devicegroup_schema_syslog - devicegroup_schema_variable - devicegroup_schema_variablevalue - devices_schema - event - flow_schema - flow_schema_flow - flow_schema_flow_recognitionpattern - flow_schema_flow_template - frequency-profile_schema - frequencyprofile_schema_nonsensor - frequencyprofile_schema_sensor - group - groupHealthSchema - groupgroupid_roles - groupgroupid_users - groups - healthSchema - ingest-mapping_schema - ingest-mappings_schema - ingest-settings_schema - ingestmapping_schema_iAgent - ingestmapping_schema_iAgent_useplugin - ingestsettings_schema_ingestsettings - ingestsettings_schema_ingestsettings_byoi - ingestsettings_schema_ingestsettings_byoi_defaultplugin - ingestsettings_schema_ingestsettings_flow - ingestsettings_schema_ingestsettings_flow_recognitionpattern - ingestsettings_schema_ingestsettings_flow_template - ingestsettings_schema_ingestsettings_frequencyprofile - ingestsettings_schema_ingestsettings_sensor - ingestsettings_schema_ingestsettings_syslog - ingestsettings_schema_ingestsettings_syslog_constant - ingestsettings_schema_ingestsettings_syslog_field - ingestsettings_schema_ingestsettings_syslog_pattern - ingestsettings_schema_ingestsettings_syslog_patternset - inline_response_200 - inline_response_200_1 - inline_response_200_2 - inline_response_200_3 - inline_response_200_4 - inline_response_200_5 - inline_response_200_6 - inline_response_200_7 - inline_response_200_8 - inline_response_200_9 - instance_schedule_state_schema - instances_schedule_state_schema - 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 - network-group_schema - network-groups_schema - networkHealthTree - networkgroup_schema_logging - networkgroup_schema_publish - notification_schema - 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 - password - pattern-set_schema - pattern_schema - pattern_schema_constant - pattern_schema_field - playbook_schema - playbooks_schema - profile_schema - profile_schema_datasummarization - profile_schema_datasummarization_raw - profile_schema_security - profiles_schema - profiles_schema_profile - 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 - retention-policies_schema - retention-policy_schema - role_schema - role_schema_inner - 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_count - rule_schema_formula_dynamicthreshold - 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_function - rule_schema_iAgent - rule_schema_iAgent_args - rule_schema_nativegpb - rule_schema_openconfig - rule_schema_reference - rule_schema_reference_dataifmissing - rule_schema_ruleproperties - rule_schema_ruleproperties_catalogue - rule_schema_ruleproperties_helperfiles - rule_schema_ruleproperties_supporteddevices - rule_schema_ruleproperties_supporteddevices_juniper - rule_schema_ruleproperties_supporteddevices_juniper_operatingsystem - rule_schema_ruleproperties_supporteddevices_juniper_products - rule_schema_ruleproperties_supporteddevices_juniper_releases - rule_schema_ruleproperties_supporteddevices_othervendor - rule_schema_sensor - rule_schema_sensor_1 - rule_schema_snmp - rule_schema_syslog - rule_schema_term - rule_schema_then - rule_schema_then_argument - rule_schema_then_status - rule_schema_then_userdefinedaction - 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_maxrateofincrease - rule_schema_when_range - rule_schema_when_userdefinedfunction - rule_schema_where - scheduler_schema - scheduler_schema_repeat - scheduler_schema_repeat_interval - scheduler_schema_runfor - schedulers_schema - serviceStatus - ssh-key-profile_schema - syslog_schema - syslog_schema_syslog - system-settings_schema - table_schema - template_schema - time-range-mandatory - tlive-kafka-oc_schema - tlive-kafka-ocs_schema - tlivekafkaoc_schema_security - tlivekafkaoc_schema_security_sasl - token - topic_schema - topics_schema - tsdb_schema - user - user_1 - user_schema - user_schema_groups - when-lhs-rhs-group -
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
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
userName (optional)
password (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)
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)
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)
notification (optional)
playbooks (optional)
publish (optional)
reports (optional)
retention-policy (optional)
String Name of the retention policy to be applied
scheduler (optional)
variable (optional)
syslog (optional)
timezone (optional)
String Timezone in the format +/-hh:mm, Example: -08:00 format: string
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
device-id
String Identifier for the device. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
flow (optional)
host
String Name or IP of the device format: string
iAgent (optional)
open-config (optional)
snmp (optional)
syslog (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
variable (optional)
vendor (optional)
source-ip-addresses (optional)
port
Integer Port on which gRPC connection needs to be established format: int32
port (optional)
Integer Port on which SNMP requests need to be sent. Port 161 is used if not configured. format: int32
v2 (optional)
community (optional)
String Community name. 'public' will be used if not configured 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
cisco (optional)
juniper (optional)
other-vendor (optional)
operating-system
String Operating system of the device
iosxr
operating-system
String Operating system of the device
junos
junosEvolved
Other vendor devices
operating-system (optional)
String Vendor operating system, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
vendor-name
String Vendor-name, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
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
Flow ingest related parameters
deploy-nodes (optional)
netflow (optional)
NetFlow 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)
reports-generation (optional)
snmp (optional)
trigger-evaluation (optional)
ML-model-builder (optional)
flow (optional)
byoi (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 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 SNMP 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)
normal (optional)
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
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
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
color (optional)
yellow
red
event_name (optional)
frequency (optional)
timestamp (optional)
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
groupDescription (optional)
roles (optional)
users (optional)
roleId (optional)
roleName (optional)
id (optional)
name (optional)
groupName (optional)
groupDescription (optional)
roles (optional)
users (optional)
device-health (optional)
network-health (optional)
iAgent (optional)
name
String Name of the mapping format: string
native-gpb (optional)
netflow (optional)
open-config (optional)
snmp (optional)
syslog (optional)
Ingest related configuration
ingest-settings (optional)
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
Ingest settings configuration
flow (optional)
syslog (optional)
byoi (optional)
frequency-profile (optional)
Bring your own ingest
custom-plugin (optional)
default-plugin (optional)
ingest-mapping (optional)
Configure default input plugin
tlive-kafka-oc (optional)
Flow ingest configuration
exclude-fields (optional)
include-fields (optional)
description (optional)
key-fields (optional)
name
priority (optional)
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
sensor-name
String Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
Syslog ingest configuration
pattern (optional)
pattern-set (optional)
port (optional)
Integer Port to listen for syslog messages, default is 514 format: int32
description (optional)
String Constant description format: string
name
String Constant field name format: string
type (optional)
integer
float
string
value
String Value of the constant format: string
description (optional)
String Field description format: string
from (optional)
String Field from the structured syslog which supplies the value format: string
name
String Field name format: string
type (optional)
integer
float
string
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 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)
job-id (optional)
job-result (optional)
job-status (optional)
finished
killed
pending
started
userId (optional)
userName (optional)
firstName (optional)
lastName (optional)
email (optional)
active (optional)
userId (optional)
userName (optional)
userId (optional)
userName (optional)
firstName (optional)
lastName (optional)
email (optional)
active (optional)
groups (optional)
userId (optional)
userName (optional)
firstName (optional)
lastName (optional)
email (optional)
accessToken (optional)
String Access token generated by system
refreshToken (optional)
String Refresh token generated by system
firstLogin (optional)
Boolean Flag to indicate if the user changed default password or not
refreshTokenExpires (optional)
String Refresh token validity duration
tokenExpires (optional)
String Access token validity duration
accessToken (optional)
String Access token generated by system
refreshToken (optional)
String Refresh token generated by system
groupId (optional)
groupName (optional)
groupDescription (optional)
roles (optional)
users (optional)
groupId (optional)
groupName (optional)
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
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
license-total
Integer Total license count for feature
license-remaining
Integer Remaining license count for feature
license-requested
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
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)
notification (optional)
playbooks (optional)
scheduler (optional)
variable (optional)
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)
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)
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
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
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
float
string
value
String Value of the constant format: string
description (optional)
String Field description format: string
from (optional)
String Field from the structured syslog which supplies the value format: string
name
String Field name format: string
type (optional)
integer
float
string
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
security (optional)
data-summarization (optional)
data-type (optional)
name
String Name of raw-data summarization profile format: string
path (optional)
Security config
ca-profile (optional)
local-certificate (optional)
ssh-key-profile (optional)
security (optional)
data-summarization (optional)
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
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)
destination
format
String Generated report format
json
html
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
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)
description (optional)
String Description about the rule format: string
field (optional)
function (optional)
keys (optional)
network-rule (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 s/m/h/d/w/y 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
float
anomaly-detection (optional)
count (optional)
dynamic-threshold (optional)
max (optional)
mean (optional)
microburst (optional)
min (optional)
outlier-detection (optional)
predict (optional)
rate-of-change (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
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
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
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]*(seconds|minutes|hours|days|weeks|years|offset) format: string
pattern-periodicity
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
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
field-name
String Field name on which ML algorithm needs to be applied format: string
learning-period
String Learning period to learn the baseline threshold. Should be of pattern [1-9][0-9]*(seconds|minutes|hours|days|weeks|years|offset) format: string
pattern-periodicity
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
prediction-offset
String Time offset in future to predict. Should be of pattern [1-9][0-9]*(offset|seconds|minutes|hours|days|weeks|years|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
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
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
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
author (optional)
String E-mail address of the rule writer format: string
catalogue (optional)
contributor (optional)
juniper
external
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
juniper (optional)
other-vendor (optional)
operating-system (optional)
os-name
junos
junosEvolved
products (optional)
product-name
String Product name format: string
releases (optional)
platform (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
apply-macro (optional)
operating-system (optional)
String Vendor operating system format: string
vendor-identifier
String Unique key to idendify the other vendor specifc products format: string
vendor-name
String Vendor-name format: string
data-if-missing (optional)
path
String Sensor path format: string
sensor-name
where (optional)
zero-suppression (optional)
array[null] Assign zero as default value for field in case of zero-suppression
description (optional)
String Description about the sensor format: string
flow (optional)
iAgent (optional)
native-gpb (optional)
open-config (optional)
sensor-name
String Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]* format: string
snmp (optional)
syslog (optional)
synopsis (optional)
String Synopsis about the sensor format: string
byoi (optional)
frequency
String Frequency at which data needs to be extracted from given SNMP table. Specify positive integer followed by s/m/h/d/w/y representing seconds/minutes/hours/days/weeks/years. Eg: 2s format: string
table
String OID of an SNMP table format: string
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)
argument
value
String Argument value 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
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[null] 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
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)
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[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
ignore-case (optional)
array[null] Flag to ignore case while matching the string
left-operand
String Left operand. This is the string in which we have to match the expression. format: string
right-operand
String Right operand. This is the match expression. format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
left-operand
String Left operand format: string
right-operand
String right operand format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name which needs to be present format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
per
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[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]* format: string
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/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[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name on which rate should be compared format: string
rate (optional)
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[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
field-name
String Field name on which range should be applied format: string
max
Double Maximum value in the range format: double
min
Double Minumum value in the range format: double
time-range (optional)
String How much back in time should we look for data. Specify positive integer followed by s/m/h/d/w/y/o representing seconds/minutes/hours/days/weeks/years/offset. Eg: 2s format: string
all (optional)
array[null] With this flag, result is set to True only if all the data matches the given condition
any (optional)
array[null] With this flag, result is set to True if any one of the data matches the condition
argument (optional)
function-name
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
end-time (optional)
String End scheduler at this time format: string
name
String Name of the scheduler format: string
repeat
start-time
String Start scheduler at this time format: string
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
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
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.
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
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
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
firstName (optional)
lastName (optional)
email (optional)
password (optional)
active (optional)
groups (optional)
firstName (optional)
lastName (optional)
email (optional)
password (optional)
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