Schemas¶

AssociatedUserSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaAuthenticationPassword¶

Properties¶

Name	Type	Description	Notes
password	str	Password for authentication
username	str	Username for authentication

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevicesJuniperReleases¶

Properties¶

Name	Type	Description	Notes
platform	list[str]		[optional]
release_name	str	Release name
release_support	str	Specifies the min/max support for this release	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhere¶

Properties¶

Name	Type	Description	Notes
query	str	Query to filter ingest data

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingOpenconfig¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula¶

Properties¶

Name	Type	Notes
anomaly_detection	RuleSchemaFormulaAnomalydetection	[optional]
count	RuleSchemaFormulaCount	[optional]
dynamic_threshold	RuleSchemaFormulaDynamicthreshold	[optional]
max	RuleSchemaFormulaMax	[optional]
mean	RuleSchemaFormulaMean	[optional]
microburst	RuleSchemaFormulaMicroburst	[optional]
min	RuleSchemaFormulaMin	[optional]
outlier_detection	RuleSchemaFormulaOutlierdetection	[optional]
predict	RuleSchemaFormulaPredict	[optional]
rate_of_change	RuleSchemaFormulaRateofchange	[optional]
stddev	RuleSchemaFormulaStddev	[optional]
sum	RuleSchemaFormulaSum	[optional]
user_defined_function	RuleSchemaFormulaUserdefinedfunction	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaThenUserdefinedaction¶

Properties¶

Name	Type	Description	Notes
argument	list[RuleSchemaThenArgument]		[optional]
function_name	str	Function name

[Back to Model list] [Back to API list] [Back to README]

ReportsSchema¶

Properties¶

Name	Type	Description	Notes
report	list[ReportSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

NetworkgroupSchemaLogging¶

Properties¶

Name	Type	Description	Notes
log_level	str	Global log level	[optional]
non_sensor_rules	DevicegroupSchemaLoggingNonsensorrules		[optional]
reports_generation	DevicegroupSchemaLoggingReportsgeneration		[optional]
trigger_evaluation	DevicegroupSchemaLoggingTriggerevaluation		[optional]
ml_model_builder	DevicegroupSchemaLoggingMLmodelbuilder		[optional]

[Back to Model list] [Back to API list] [Back to README]

ProfileSchemaSecurity¶

Properties¶

Name	Type	Notes
ca_profile	list[CaProfileSchema]	[optional]
local_certificate	list[LocalCertificateSchema]	[optional]
ssh_key_profile	list[SshKeyProfileSchema]	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaAuthenticationSsl¶

Properties¶

Name	Type	Description	Notes
ca_profile	str	Name of the ca-profile to be used
local_certificate	str	Name of the local-certificate-profile to be used	[optional]
server_common_name	str	Common name used while creating server certificate

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2006¶

Properties¶

Name	Type	Description	Notes
access_token	str	Access token generated by system	[optional]
refresh_token	str	Refresh token generated by system	[optional]
first_login	bool	Flag to indicate if the user changed default password or not	[optional]
refresh_token_expires	str	Refresh token validity duration	[optional]
token_expires	str	Access token validity duration	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaSensor¶

Properties¶

Name	Type	Description	Notes
data_if_missing	RuleSchemaDataifmissing		[optional]
path	str	Sensor path
sensor_name	str	Name of the sensor
where	list[RuleSchemaWhere]	List of where clauses to filter ingest data	[optional]
zero_suppression	list[ERRORUNKNOWN]	Assign zero as default value for field in case of zero-suppression	[optional]

[Back to Model list] [Back to API list] [Back to README]

CustompluginSchemaParameters¶

Properties¶

Name	Type	Description	Notes
key	str	Key of the parameter
value	str	Value of the parameter	[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.LogsApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
retrieve_logs_for_device_group	GET /logs/device-group/{device_group_name}/	Logs for the given device-group.
retrieve_logs_for_device_group_service	GET /logs/device-group/{device_group_name}/service/{service_name}/	Get the logs for the given service running for the given device-group.
retrieve_logs_for_network_group	GET /logs/network-group/{network_group_name}/	Logs for the given network group.
retrieve_logs_for_network_group_service	GET /logs/network-group/{network_group_name}/service/{service_name}/	Get the logs for the given service running for the given network-group.

retrieve_logs_for_device_group¶

retrieve_logs_for_device_group(device_group_name, authorization=authorization, download=download, filename=filename)

Logs for the given device-group.

Get the logs for all the services for the given {device_group_name}

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
device_group_name = 'device_group_name_example' # str | Device group name
authorization = 'authorization_example' # str | authentication header object (optional)
download = true # bool | Download the logs (optional) (default to true)
filename = 'filename_example' # str | Name of the log file (optional)

try:
    # Logs for the given device-group.
    api_instance.retrieve_logs_for_device_group(device_group_name, authorization=authorization, download=download, filename=filename)
except ApiException as e:
    print("Exception when calling LogsApi->retrieve_logs_for_device_group: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Device group name
authorization	str	authentication header object	[optional]
download	bool	Download the logs	[optional] [default to true]
filename	str	Name of the log file	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/gzip, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_logs_for_device_group_service¶

retrieve_logs_for_device_group_service(device_group_name, service_name, authorization=authorization, download=download, filename=filename, number_of_lines=number_of_lines)

Get the logs for the given service running for the given device-group.

Get the logs for the service {service_name} for the given {device_group_name}

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
device_group_name = 'device_group_name_example' # str | Device group name
service_name = 'service_name_example' # str | Device-group service name
authorization = 'authorization_example' # str | authentication header object (optional)
download = true # bool | Download the logs (optional) (default to true)
filename = 'filename_example' # str | Name of the log file (optional)
number_of_lines = 100000 # int | Number of lines to show from the end of the logs (optional) (default to 100000)

try:
    # Get the logs for the given service running for the given device-group.
    api_instance.retrieve_logs_for_device_group_service(device_group_name, service_name, authorization=authorization, download=download, filename=filename, number_of_lines=number_of_lines)
except ApiException as e:
    print("Exception when calling LogsApi->retrieve_logs_for_device_group_service: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Device group name
service_name	str	Device-group service name
authorization	str	authentication header object	[optional]
download	bool	Download the logs	[optional] [default to true]
filename	str	Name of the log file	[optional]
number_of_lines	int	Number of lines to show from the end of the logs	[optional] [default to 100000]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/gzip, application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_logs_for_network_group¶

retrieve_logs_for_network_group(network_group_name, authorization=authorization, download=download, filename=filename)

Logs for the given network group.

Get the logs for the service {service_name} for the given {network_group_name}

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
network_group_name = 'network_group_name_example' # str | Network group name
authorization = 'authorization_example' # str | authentication header object (optional)
download = true # bool | Download the logs (optional) (default to true)
filename = 'filename_example' # str | Name of the log file (optional)

try:
    # Logs for the given network group.
    api_instance.retrieve_logs_for_network_group(network_group_name, authorization=authorization, download=download, filename=filename)
except ApiException as e:
    print("Exception when calling LogsApi->retrieve_logs_for_network_group: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Network group name
authorization	str	authentication header object	[optional]
download	bool	Download the logs	[optional] [default to true]
filename	str	Name of the log file	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/gzip, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_logs_for_network_group_service¶

retrieve_logs_for_network_group_service(network_group_name, service_name, authorization=authorization, download=download, filename=filename, number_of_lines=number_of_lines)

Get the logs for the given service running for the given network-group.

Get the logs for all the services for the given {network_group_name}

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LogsApi()
network_group_name = 'network_group_name_example' # str | Network group name
service_name = 'service_name_example' # str | Network group service name
authorization = 'authorization_example' # str | authentication header object (optional)
download = true # bool | Download the logs (optional) (default to true)
filename = 'filename_example' # str | Name of the log file (optional)
number_of_lines = 100000 # int | Number of lines to show from the end of the logs (optional) (default to 100000)

try:
    # Get the logs for the given service running for the given network-group.
    api_instance.retrieve_logs_for_network_group_service(network_group_name, service_name, authorization=authorization, download=download, filename=filename, number_of_lines=number_of_lines)
except ApiException as e:
    print("Exception when calling LogsApi->retrieve_logs_for_network_group_service: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Network group name
service_name	str	Network group service name
authorization	str	authentication header object	[optional]
download	bool	Download the logs	[optional] [default to true]
filename	str	Name of the log file	[optional]
number_of_lines	int	Number of lines to show from the end of the logs	[optional] [default to 100000]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/gzip, application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaFormulaOutlierdetectionAlgorithmKfold3sigma¶

Properties¶

Name	Type	Description	Notes
learning_period	str	Time period on which to detect outliers
sensitivity	RuleSchemaFormulaOutlierdetectionAlgorithmDbscanSensitivity		[optional]
sigma_coefficient	float	Number of standard deviations past which outliers are marked	[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaSnmpV2¶

Properties¶

Name	Type	Description	Notes
community	str	Community name. 'public' will be used if not configured	[optional]

[Back to Model list] [Back to API list] [Back to README]

TliveKafkaOcsSchema¶

Properties¶

Name	Type	Description	Notes
tlive_kafka_oc	list[TliveKafkaOcSchema]

[Back to Model list] [Back to API list] [Back to README]

ProfileSchema¶

Properties¶

Name	Type	Description	Notes
security	ProfileSchemaSecurity		[optional]
data_summarization	ProfileSchemaDatasummarization		[optional]

[Back to Model list] [Back to API list] [Back to README]

ApplymacroSchemaData¶

Properties¶

Name	Type	Description	Notes
name	str	Keyword part of the keyword-value pair
value	str	Value part of the keyword-value pair	[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaMicrosoftteams¶

Properties¶

Name	Type	Description	Notes
channel	str	Connector channel on which notification is to be posted

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaVariable¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the variable	[optional]
name	str	Variable name used in the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
type	str	Type of value supported. This information will be used by UI to display options available for the values
value	str	Default value for the variable	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaVariable¶

Properties¶

Name	Type	Description	Notes
instance_id	str	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	str	Name of the playbook in which the variable instance needs to be used
rule	str	Name of the rule. This must be of the format <topic-name>/<rule-name>
running_state	str	Current running state of the playbook instance	[optional]
variable_value	list[DevicegroupSchemaVariablevalue]		[optional]

[Back to Model list] [Back to API list] [Back to README]

FrequencyprofileSchemaSensor¶

Properties¶

Name	Type	Description	Notes
frequency	str	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
sensor_name	str	Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaAuthenticationSsh¶

Properties¶

Name	Type	Description	Notes
ssh_key_profile	str	Name of the ssh-key-profile to be used
username	str	Username for authentication

[Back to Model list] [Back to API list] [Back to README]

SchedulersSchema¶

Properties¶

Name	Type	Description	Notes
scheduler	list[SchedulerSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevicesOthervendor¶

Properties¶

Name	Type	Description	Notes
apply_macro	list[ApplyMacroSchema]		[optional]
operating_system	str	Vendor operating system	[optional]
vendor_identifier	str	Unique key to idendify the other vendor specifc products
vendor_name	str	Vendor-name

[Back to Model list] [Back to API list] [Back to README]

ReportSchemaGraphcanvas¶

Properties¶

Name	Type	Description	Notes
canvas_panel	list[ReportSchemaCanvaspanel]	Canvas panel	[optional]
name	str	Name of the canvas.

[Back to Model list] [Back to API list] [Back to README]

LicenseRawKeySchema¶

Properties¶

Name	Type	Description	Notes
raw_key	str	License key string

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaNativegpb¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceGroupHealthTree¶

Properties¶

Name	Type	Notes
children	list[DeviceGroupHealthTree]
color	str	[optional]
data	str	[optional]
name	str
timestamp	datetime	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaSyslog¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2002¶

Properties¶

Name	Type	Description	Notes
user_id	str	ID generated by system	[optional]
user_name	str	Name of the user	[optional]
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]
active	bool	Status of the user	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevicesJuniper¶

Properties¶

Name	Type	Description	Notes
operating_system	list[RuleSchemaRulepropertiesSupporteddevicesJuniperOperatingsystem]		[optional]

[Back to Model list] [Back to API list] [Back to README]

PatternSchema¶

Properties¶

Name	Type	Description	Notes
constant	list[PatternSchemaConstant]	Constant details	[optional]
description	str	Pattern description	[optional]
event_id	str	Event id that identifies a log uniquely. Field names also can be part of event-id. Example my-event+$field1
field	list[PatternSchemaField]	Field details	[optional]
filter	str	Filter to match a log line	[optional]
filter_type	str	Filter type, default is grok	[optional]
key_fields	list[str]		[optional]
name	str	Name of a pattern. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

Group¶

Properties¶

Name	Type	Description	Notes
group_description	str	Details of the group	[optional]
roles	list[GroupgroupidRoles]	list of roles associated	[optional]
users	list[GroupgroupidUsers]	list of users associated	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicesSchema¶

Properties¶

Name	Type	Description	Notes
device	list[DeviceSchema]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaDataifmissing¶

Properties¶

Name	Type	Description	Notes
value	str	Assign given default value for field in case of data missing	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaTerm¶

Properties¶

Name	Type	Description	Notes
term_name	str	Term name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
then	RuleSchemaThen		[optional]
when	RuleSchemaWhen		[optional]

[Back to Model list] [Back to API list] [Back to README]

TlivekafkaocSchemaSecurity¶

Properties¶

Name	Type	Description	Notes
sasl	TlivekafkaocSchemaSecuritySasl		[optional]
tls	CustompluginSchemaSecurityparametersTls		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula1Unique¶

Properties¶

Name	Type	Description	Notes
vector_name	str	Vector name in which unique elements needs to be computed. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RoleSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLogging¶

Properties¶

Name	Type	Description	Notes
i_agent	DevicegroupSchemaLoggingIAgent		[optional]
log_level	str	Global log level	[optional]
native_gpb	DevicegroupSchemaLoggingNativegpb		[optional]
non_sensor_rules	DevicegroupSchemaLoggingNonsensorrules		[optional]
open_config	DevicegroupSchemaLoggingOpenconfig		[optional]
reports_generation	DevicegroupSchemaLoggingReportsgeneration		[optional]
snmp	DevicegroupSchemaLoggingSnmp		[optional]
trigger_evaluation	DevicegroupSchemaLoggingTriggerevaluation		[optional]
ml_model_builder	DevicegroupSchemaLoggingMLmodelbuilder		[optional]
flow	DevicegroupSchemaLoggingFlow		[optional]
byoi	DevicegroupSchemaLoggingByoi		[optional]
syslog	DevicegroupSchemaLoggingSyslog		[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaHttppost¶

Properties¶

Name	Type	Description	Notes
basic	NotificationSchemaHttppostBasic		[optional]
url	str	URL on which http notification needs to be posted

[Back to Model list] [Back to API list] [Back to README]

User1¶

Properties¶

Name	Type	Description	Notes
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]
password	str	Password of the user	[optional]

[Back to Model list] [Back to API list] [Back to README]

LicensekeySchemaFeatures¶

Properties¶

Name	Type	Description
feature_id	int	Unique ID of the licensed feature
feature_name	str	Name of the licensed feature
feature_description	str	Brief description of the licensed feature
capacity_value	int	Total capacity of the licensed feature
capacity_flag	bool	Flag indicating if the feature is capacity or non-capacity type

[Back to Model list] [Back to API list] [Back to README]

SystemSettingsSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsFlow¶

Properties¶

Name	Type	Description	Notes
template	list[IngestsettingsSchemaIngestsettingsFlowTemplate]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenEqualto¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
left_operand	str	Left operand
right_operand	str	right operand
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaNotification¶

Properties¶

Name	Type	Description	Notes
enable	list[ERRORUNKNOWN]	Turn on notifications	[optional]
major	list[str]		[optional]
minor	list[str]		[optional]
normal	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2003¶

Properties¶

Name	Type	Description	Notes
user_id	str	ID generated by system	[optional]
user_name	str	Name of the user	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula1¶

Properties¶

Name	Type	Notes
_and	RuleSchemaFormula1And	[optional]
_or	RuleSchemaFormula1Or	[optional]
unique	RuleSchemaFormula1Unique	[optional]
unless	RuleSchemaFormula1Unless	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaRawdataSummarize¶

Properties¶

Name	Type	Description	Notes
summarization_profile	list[str]		[optional]
time_span	str	Timespan for aggregate functions

[Back to Model list] [Back to API list] [Back to README]

CommandRpc¶

Properties¶

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

[Back to Model list] [Back to API list] [Back to README]

TimeRangeMandatory¶

Properties¶

Name	Type	Description	Notes
time_range	str	How much back in time should we look for data

[Back to Model list] [Back to API list] [Back to README]

WhenLhsRhsGroup¶

Properties¶

Name	Type	Description	Notes
left_operand	str	Left operand	[optional]
right_operand	str	right operand	[optional]
time_range	str	How much back in time should we look for data	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaFlow¶

Properties¶

Name	Type	Description	Notes
deploy_nodes	list[str]		[optional]
netflow	DevicegroupSchemaFlowNetflow		[optional]

[Back to Model list] [Back to API list] [Back to README]

GroupgroupidUsers¶

Properties¶

Name	Type	Description	Notes
id	str		[optional]
name	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaRawdata¶

Properties¶

Name	Type	Description	Notes
persist	object	Enables persist-raw-data	[optional]
summarize	DevicegroupSchemaRawdataSummarize		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFlow¶

Properties¶

Name	Type	Description	Notes
template_name	str

[Back to Model list] [Back to API list] [Back to README]

FrequencyprofileSchemaNonsensor¶

Properties¶

Name	Type	Description	Notes
frequency	str	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
rule_name	str	Name of non-sensor or network rule i.e topic-name/rule-name

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingTriggerevaluation¶

Properties¶

Name	Type	Description	Notes
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

TopicsSchema¶

Properties¶

Name	Type	Description	Notes
topic	list[TopicSchema]

[Back to Model list] [Back to API list] [Back to README]

GroupgroupidRoles¶

Properties¶

Name	Type	Description	Notes
role_id	str		[optional]
role_name	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

FlowSchemaFlowRecognitionpattern¶

Properties¶

Name	Type	Description	Notes
exclude_fields	list[str]		[optional]
include_fields	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

CaProfileSchema¶

Properties¶

Name	Type	Description	Notes
certificate_authority_crt	str	Certificate Authority certificate file name. Should be of pattern .+.crt
name	str	Certificate Authority profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

DeviceHealthSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaVector¶

Properties¶

Name	Type	Description	Notes
formula	RuleSchemaFormula1		[optional]
path	list[str]		[optional]
time_range	str	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	[optional]
vector_name	str	Name of the vector. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

FrequencyProfileSchema¶

Properties¶

Name	Type	Description	Notes
name	str	Frequency profile name
non_sensor	list[FrequencyprofileSchemaNonsensor]		[optional]
sensor	list[FrequencyprofileSchemaSensor]		[optional]

[Back to Model list] [Back to API list] [Back to README]

DestinationSchemaEmail¶

Properties¶

Name	Type	Description	Notes
id	str	Email ID	[optional]

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2007¶

Properties¶

Name	Type	Description	Notes
access_token	str	Access token generated by system	[optional]
refresh_token	str	Refresh token generated by system	[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationsSchema¶

Properties¶

Name	Type	Description	Notes
notification	list[NotificationSchema]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula1Unless¶

Properties¶

Name	Type	Description	Notes
left_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*
right_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenRange¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
field_name	str	Field name on which range should be applied
max	float	Maximum value in the range
min	float	Minumum value in the range
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

InstanceScheduleStateSchema¶

Properties¶

Name	Type	Description	Notes
group_name	str	Name of the group
group_type	str	Type of the group. Can be one of device-group or network-group
name	str	Name of the instance
rule	str	Name of the rule associated with the instance
playbook	str	Name of the playbook associated with the instance
state	str	Scheduled state of the instance. Can be one of active or inactive
update_time	object	Time the current status is updated for this instance in elapsed seconds since epoch	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesHelperfiles¶

Properties¶

Name	Type	Description	Notes
file_type	str
list_of_files	list[str]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaMax¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which max operation needs to be performed
time_range	str	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

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaThenStatus¶

Properties¶

Name	Type	Description	Notes
color	str	Color that needs to be shown in the health tree
message	str	Descriotion that needs to be show in the health tree	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingSyslog¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaVariablevalue¶

Properties¶

Name	Type	Description	Notes
name	str	Variable name used in the playbook/rule. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
value	str	Value for the variable

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingSnmp¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

PlaybooksSchema¶

Properties¶

Name	Type	Description	Notes
playbook	list[PlaybookSchema]

[Back to Model list] [Back to API list] [Back to README]

RawSchemaDatatype¶

Properties¶

Name	Type	Description	Notes
aggregation_functions	list[str]
name	str	Name of the data-type for which summarization should be changed

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaPredict¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSyslogConstant¶

Properties¶

Name	Type	Description	Notes
description	str	Constant description	[optional]
name	str	Constant field name
type	str		[optional]
value	str	Value of the constant

[Back to Model list] [Back to API list] [Back to README]

Credential¶

Properties¶

Name	Type	Description	Notes
user_name	str	username of the user	[optional]
password	str	Password of the user	[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaSyslog¶

Properties¶

Name	Type	Description	Notes
source_ip_addresses	list[str]		[optional]
hostnames	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaNativegpb¶

Properties¶

Name	Type	Description	Notes
ports	list[int]		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSyslog¶

Properties¶

Name	Type	Description	Notes
pattern	list[IngestsettingsSchemaIngestsettingsSyslogPattern]	Pattern details	[optional]
pattern_set	list[IngestsettingsSchemaIngestsettingsSyslogPatternset]	Pattern-set details	[optional]
port	int	Port to listen for syslog messages, default is 514	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaConstant¶

Properties¶

Name	Type	Description	Notes
value	str	Value for the constant

[Back to Model list] [Back to API list] [Back to README]

LicenseKeysSchema¶

Properties¶

Name	Type	Description	Notes
license_key	list[LicenseKeySchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaByoiPlugin¶

Properties¶

Name	Type	Description	Notes
name	str	Name of the input plugin
parameters	list[RuleSchemaByoiPluginParameters]	Plugin specific parameters (config)	[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.ServicesApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
create_services_device_groups_device_group_by_device_group_name	POST /services/device-group/{device_group_name}/	Start a device-group's services.
create_services_network_group_by_network_group_name	POST /services/network-group/{network_group_name}/	Start a network-group's services.
delete_services_device_groups_device_group_by_device_group_name	DELETE /services/device-group/{device_group_name}/	Stop and remove a device-group's services.
delete_services_network_group_by_network_group_name	DELETE /services/network-group/{network_group_name}/	Stop and remove a network-group's services.
retrieve_services_device_groups_device_group_device_group	GET /services/device-group/	Get running `device-group-name`s.
retrieve_services_network_group	GET /services/network-group/	Get running `network-group-name`s

create_services_device_groups_device_group_by_device_group_name¶

create_services_device_groups_device_group_by_device_group_name(device_group_name, authorization=authorization)

Start a device-group’s services.

Start services of a device group. Use this to start stopped services.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
device_group_name = 'device_group_name_example' # str | Name of device group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Start a device-group's services.
    api_instance.create_services_device_groups_device_group_by_device_group_name(device_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ServicesApi->create_services_device_groups_device_group_by_device_group_name: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Name of device group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_services_network_group_by_network_group_name¶

create_services_network_group_by_network_group_name(network_group_name, authorization=authorization)

Start a network-group’s services.

Start services of a network group. Use this to start stopped services.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
network_group_name = 'network_group_name_example' # str | Name of network group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Start a network-group's services.
    api_instance.create_services_network_group_by_network_group_name(network_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ServicesApi->create_services_network_group_by_network_group_name: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Name of network group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_services_device_groups_device_group_by_device_group_name¶

delete_services_device_groups_device_group_by_device_group_name(device_group_name, authorization=authorization)

Stop and remove a device-group’s services.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
device_group_name = 'device_group_name_example' # str | Name of device group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Stop and remove a device-group's services.
    api_instance.delete_services_device_groups_device_group_by_device_group_name(device_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ServicesApi->delete_services_device_groups_device_group_by_device_group_name: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Name of device group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_services_network_group_by_network_group_name¶

delete_services_network_group_by_network_group_name(network_group_name, authorization=authorization)

Stop and remove a network-group’s services.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
network_group_name = 'network_group_name_example' # str | Name of network group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Stop and remove a network-group's services.
    api_instance.delete_services_network_group_by_network_group_name(network_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ServicesApi->delete_services_network_group_by_network_group_name: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Name of network group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_services_device_groups_device_group_device_group¶

list[str] retrieve_services_device_groups_device_group_device_group(authorization=authorization)

Get running device-group-names.

Get the list of device-group-names of device-groups whose services are running.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get running `device-group-name`s.
    api_response = api_instance.retrieve_services_device_groups_device_group_device_group(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->retrieve_services_device_groups_device_group_device_group: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_services_network_group¶

list[str] retrieve_services_network_group(authorization=authorization)

Get running network-group-names

Get the list of network-group-names of network-groups whose services are running.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ServicesApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get running `network-group-name`s
    api_response = api_instance.retrieve_services_network_group(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->retrieve_services_network_group: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaFormulaRateofchange¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

LocalCertificateSchema¶

Properties¶

Name	Type	Description
client_crt	str	Client certificate file name. Should be of pattern .+.crt
client_key	str	Client Key file name. Should be of pattern .+.key
name	str	Local Certificate profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSyslogPattern¶

Properties¶

Name	Type	Description	Notes
constant	list[IngestsettingsSchemaIngestsettingsSyslogConstant]	Constant details	[optional]
description	str	Pattern description	[optional]
event_id	str	Event id that identifies a log uniquely. Field names also can be part of event-id. Example my-event+$field1
field	list[IngestsettingsSchemaIngestsettingsSyslogField]	Field details	[optional]
filter	str	Filter to match a log line	[optional]
filter_type	str	Filter type, default is grok	[optional]
key_fields	list[str]		[optional]
name	str	Name of a pattern. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaOutlierdetectionAlgorithmDbscan¶

Properties¶

Name	Type	Description	Notes
learning_period	str	Time period on which to detect outliers
sensitivity	RuleSchemaFormulaOutlierdetectionAlgorithmDbscanSensitivity		[optional]

[Back to Model list] [Back to API list] [Back to README]

PlaybookSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Description about this playbook	[optional]
playbook_name	str	Name of the playbook. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
rules	list[str]		[optional]
synopsis	str	Short description about this playbook	[optional]

[Back to Model list] [Back to API list] [Back to README]

DebugArgumentsSchema¶

Properties¶

Name	Type	Description	Notes
arguments	object	Optional key/value pair arguments to table

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaOpenconfig¶

Properties¶

Name	Type	Description	Notes
port	int	Port on which gRPC connection needs to be established

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaField¶

Properties¶

Name	Type	Description	Notes
constant	RuleSchemaConstant		[optional]
description	str	Description about this field	[optional]
field_name	str	Name of the field. Should be of pattern [a-z][a-zA-Z0-9_-]*
formula	RuleSchemaFormula		[optional]
reference	RuleSchemaReference		[optional]
sensor	list[RuleSchemaSensor]		[optional]
type	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

LicenseFeatureSchema¶

Properties¶

Name	Type	Description
feature_id	int	Unique ID of the licensed feature
feature_name	str	Name of the licensed feature
feature_description	str	Brief description of the licensed feature
license_total	int	Total license count for feature
license_remaining	int	Remaining license count for feature
license_requested	int	Local requested license count for feature
license_usage	int	License feature usage count
max_remaining_days	int	Maximum remaining time of the feature's license in days
validity_type	str	License validity type
mode	str	License mode of operation
compliance	bool	Compliance status indicating if the feature usage is in compliance or not
end_date	int	Feature end date timestamp
valid_until	str	Validity information of license feature

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2008¶

Properties¶

Name	Type	Description	Notes
group_id	str	ID generated by system	[optional]
group_name	str	Name of the group	[optional]
group_description	str	Details of the group	[optional]
roles	AssociatedRoleSchema		[optional]
users	AssociatedUserSchema		[optional]

[Back to Model list] [Back to API list] [Back to README]

LicenseRawKeysSchema¶

Properties¶

Name	Type	Description	Notes
license_raw_key	list[LicenseRawKeySchema]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchema¶

Properties¶

Name	Type	Description	Notes
authentication	DevicegroupSchemaAuthentication		[optional]
description	str	Description about the device	[optional]
device_id	str	Identifier for the device. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
flow	DeviceSchemaFlow		[optional]
host	str	Name or IP of the device
i_agent	DeviceSchemaIAgent		[optional]
open_config	DeviceSchemaOpenconfig		[optional]
snmp	DeviceSchemaSnmp		[optional]
syslog	DeviceSchemaSyslog		[optional]
timezone	str	Timezone in the format +/-hh:mm, Example: -08:00	[optional]
system_id	str	ID which is sent in the JTI UDP messages	[optional]
variable	list[DeviceSchemaVariable]	Playbook variable configuration	[optional]
vendor	DeviceSchemaVendor		[optional]

[Back to Model list] [Back to API list] [Back to README]

CustompluginSchemaSecurityparametersUserauthentication¶

Properties¶

Name	Type	Description	Notes
password	str	Password
username	str	Username

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenIncreasingatleastbyvalue¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
field_name	str	Field name. Should match the pattern $[a-z][a-zA-Z0-9_-]*
time_range	str	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	[optional]
value	str	Value of increase between current and last reported values	[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.AuthenticationApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
refresh_token	POST /token/	Re-issue tokens from existing token
user_login	POST /login/	User login
user_logout	POST /logout/	User logout

refresh_token¶

InlineResponse2007 refresh_token(token)

Re-issue tokens from existing token

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
token = swagger_client.Token() # Token | Token object

try:
    # Re-issue tokens from existing token
    api_response = api_instance.refresh_token(token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->refresh_token: %s\n" % e)

Name	Type	Description	Notes
token	Token	Token object

**InlineResponse2007**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_login¶

InlineResponse2006 user_login(credential)

User login

User login and recive tokens

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
credential = swagger_client.Credential() # Credential | topics body object

try:
    # User login
    api_response = api_instance.user_login(credential)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->user_login: %s\n" % e)

Name	Type	Description	Notes
credential	Credential	topics body object

**InlineResponse2006**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_logout¶

user_logout(refresh_token)

User logout

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
refresh_token = swagger_client.RefreshToken() # RefreshToken | request body object

try:
    # User logout
    api_instance.user_logout(refresh_token)
except ApiException as e:
    print("Exception when calling AuthenticationApi->user_logout: %s\n" % e)

Name	Type	Description	Notes
refresh_token	RefreshToken	request body object

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaFunction¶

Properties¶

Name	Type	Description	Notes
argument	list[RuleSchemaArgument]		[optional]
description	str	Description of the function	[optional]
function_name	str	Name of the function. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
method	str	Function to be called
path	str	File in which function is defined. This is relative path to the data directory

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaSnmp¶

Properties¶

Name	Type	Description	Notes
port	int	Port on which SNMP requests need to be sent. Port 161 is used if not configured.	[optional]
v2	DeviceSchemaSnmpV2		[optional]

[Back to Model list] [Back to API list] [Back to README]

NetworkGroupSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the network group	[optional]
ingest_frequency	list[str]		[optional]
network_group_name	str	Name of the network group. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
publish	NetworkgroupSchemaPublish		[optional]
logging	NetworkgroupSchemaLogging		[optional]
reports	list[str]		[optional]
notification	DevicegroupSchemaNotification		[optional]
playbooks	list[str]		[optional]
scheduler	list[DevicegroupSchemaScheduler]	List of schedulers associated with the playbook instances	[optional]
variable	list[DevicegroupSchemaVariable]	Playbook variable configuration	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestSettingsSchema¶

Properties¶

Name	Type	Description	Notes
ingest_settings	IngestsettingsSchemaIngestsettings		[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.DocumentationApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
retrieve_defined_api	GET /	Get all All API's.

retrieve_defined_api¶

retrieve_defined_api()

Get all All API’s.

GET static api documentation

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentationApi()

try:
    # Get all All API's.
    api_instance.retrieve_defined_api()
except ApiException as e:
    print("Exception when calling DocumentationApi->retrieve_defined_api: %s\n" % e)

This endpoint does not need any parameter.

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SchedulerSchemaRepeat¶

Properties¶

Name	Type	Description	Notes
every	str	Repeat every	[optional]
interval	SchedulerSchemaRepeatInterval		[optional]
never	list[ERRORUNKNOWN]	Never repeat scheduling	[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaVendorJuniper¶

Properties¶

Name	Type	Description	Notes
operating_system	str	Operating system of the device

[Back to Model list] [Back to API list] [Back to README]

PatternSchemaConstant¶

Properties¶

Name	Type	Description	Notes
description	str	Constant description	[optional]
name	str	Constant field name
type	str	Data type of constant field	[optional]
value	str	Value of the constant

[Back to Model list] [Back to API list] [Back to README]

UserSchemaGroups¶

Properties¶

Name	Type	Description	Notes
group_id	str		[optional]
group_name	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

InlineResponse200¶

Properties¶

Name	Type	Notes
job_id	str	[optional]
job_result	str	[optional]
job_status	str	[optional]

[Back to Model list] [Back to API list] [Back to README]

TopicSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Description about this topic	[optional]
rule	list[RuleSchema]		[optional]
sub_topics	list[str]		[optional]
synopsis	str	Short description about this topic	[optional]
topic_name	str	Name of the topic. Should be of pattern [a-z][a-z-](.{1}[a-z0-9-]+)

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSyslogField¶

Properties¶

Name	Type	Description	Notes
description	str	Field description	[optional]
_from	str	Field from the structured syslog which supplies the value	[optional]
name	str	Field name
type	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceGroupSchema¶

Properties¶

Name	Type	Description	Notes
authentication	DevicegroupSchemaAuthentication		[optional]
description	str	Description about the device group	[optional]
device_group_name	str	Name of the group. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
devices	list[str]		[optional]
logging	DevicegroupSchemaLogging		[optional]
native_gpb	DevicegroupSchemaNativegpb		[optional]
flow	DevicegroupSchemaFlow		[optional]
ingest_frequency	list[str]		[optional]
raw_data	DevicegroupSchemaRawdata		[optional]
notification	DevicegroupSchemaNotification		[optional]
playbooks	list[str]		[optional]
publish	DevicegroupSchemaPublish		[optional]
reports	list[str]		[optional]
retention_policy	str	Name of the retention policy to be applied	[optional]
scheduler	list[DevicegroupSchemaScheduler]	List of schedulers associated with the playbook instances	[optional]
variable	list[DevicegroupSchemaVariable]	Playbook variable configuration	[optional]
syslog	DevicegroupSchemaSyslog		[optional]
timezone	str	Timezone in the format +/-hh:mm, Example: -08:00	[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.DefaultApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
backup_helper_files	GET /files/helper-files/backup/	Download the tar file containing all helper files.
create_files_certificates_by_file_name	POST /files/certificates/{file_name}/	Upload a certificate file.
create_files_helper_files_by_file_name	POST /files/helper-files/{file_name}/	Upload a helper-file.
create_healthbot_ingest_settings_byoi_custom_plugin_by_id	POST /ingest-settings/byoi/custom-plugin/{name}/	Create custom-plugin by ID
create_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id	POST /ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/	Create tlive-kafka-oc by ID
create_healthbot_ingest_settings_byoi_ingest_mapping_by_id	POST /ingest-settings/byoi/ingest-mapping/{name}/	Create ingest-mapping by ID
create_healthbot_ingest_settings_frequency_profile_by_id	POST /ingest-settings/frequency-profile/{name}/	Create frequency-profile by ID
create_healthbot_system_time_series_database_time_series_database_by_id	POST /system/tsdb/	Create time-series-database by ID
create_iceberg_ingest_settings	POST /ingest-settings/	Create ingest-settings by ID
create_iceberg_ingest_settings_flow	POST /ingest-settings/flow/	Create flow by ID
create_iceberg_ingest_settings_flow_template_by_id	POST /ingest-settings/flow/template/{name}/	Create template by ID
create_iceberg_ingest_settings_syslog	POST /ingest-settings/syslog/	Create syslog by ID
create_iceberg_ingest_settings_syslog_pattern_by_id	POST /ingest-settings/syslog/pattern/{name}/	Create pattern by ID
create_iceberg_ingest_settings_syslog_pattern_set_by_id	POST /ingest-settings/syslog/pattern-set/{name}/	Create pattern-set by ID
create_iceberg_profile_data_summarization_raw_by_id	POST /profile/data-summarization/raw/{name}/	Create raw-data-summarization by ID
create_iceberg_profile_security_ca_profile_by_id	POST /profile/security/ca-profile/{name}/	Create ca-profile by ID
create_iceberg_profile_security_local_certificate_by_id	POST /profile/security/local-certificate/{name}/	Create local-certificate by ID
create_iceberg_profile_security_ssh_key_profile_by_id	POST /profile/security/ssh-key-profile/{name}/	Create ssh-key-profile by ID
create_iceberg_profiles	POST /profiles/	Create profile by ID
delete_files_certificates_by_file_name	DELETE /files/certificates/{file_name}/	Delete a certificate-file.
delete_files_helper_files_by_file_name	DELETE /files/helper-files/{file_name}/	Delete a helper-file.
delete_healthbot_ingest_settings_byoi_custom_plugin_by_id	DELETE /ingest-settings/byoi/custom-plugin/{name}/	Delete custom-plugin by ID
delete_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id	DELETE /ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/	Delete tlive-kafka-oc by ID
delete_healthbot_ingest_settings_byoi_ingest_mapping_by_id	DELETE /ingest-settings/byoi/ingest-mapping/{name}/	Delete ingest-mapping by ID
delete_healthbot_ingest_settings_frequency_profile_by_id	DELETE /ingest-settings/frequency-profile/{name}/	Delete frequency-profile by ID
delete_healthbot_system_time_series_database_time_series_database_by_id	DELETE /system/tsdb/	Delete time-series-database
delete_iceberg_ingest_settings	DELETE /ingest-settings/	Delete ingest-settings by ID
delete_iceberg_ingest_settings_flow	DELETE /ingest-settings/flow/	Delete flow by ID
delete_iceberg_ingest_settings_flow_template_by_id	DELETE /ingest-settings/flow/template/{name}/	Delete template by ID
delete_iceberg_ingest_settings_syslog	DELETE /ingest-settings/syslog/	Delete syslog by ID
delete_iceberg_ingest_settings_syslog_pattern_by_id	DELETE /ingest-settings/syslog/pattern/{name}/	Delete pattern by ID
delete_iceberg_ingest_settings_syslog_pattern_set_by_id	DELETE /ingest-settings/syslog/pattern-set/{name}/	Delete pattern-set by ID
delete_iceberg_profile_data_summarization_raw_by_id	DELETE /profile/data-summarization/raw/{name}/	Delete raw-data-summarization by ID
delete_iceberg_profile_security_ca_profile_by_id	DELETE /profile/security/ca-profile/{name}/	Delete ca-profile by ID
delete_iceberg_profile_security_local_certificate_by_id	DELETE /profile/security/local-certificate/{name}/	Delete local-certificate by ID
delete_iceberg_profile_security_ssh_key_profile_by_id	DELETE /profile/security/ssh-key-profile/{name}/	Delete ssh-key-profile by ID
delete_iceberg_profiles	DELETE /profiles/	Delete profile by ID
inspect_command_rpc_table_on_device	POST /inspect/command-rpc/table/	Inspect the given iAgent table.
restore_helper_files	POST /files/helper-files/backup/	Upload a helper-file.
retrieve_configuration_jobs	GET /configuration/jobs/
retrieve_data_database_table	GET /data/database/table/	Get information about tables for a device of a device-group.
retrieve_data_database_table_column_by_table_name	GET /data/database/table/column/	Get information about columns in a table.
retrieve_data_database_tags_by_table_name	GET /data/database/table/tags/	Get information about tags keys and values in a table.
retrieve_debug_jobs	GET /debug/jobs/
retrieve_event	GET /event/	Get all events for a device.
retrieve_event_by_event_name	GET /event/{event_name}/	Get instances of a device event.
retrieve_event_by_event_name_device_group	GET /event/device-group/{event_name}/	Get instances of a device-group event.
retrieve_event_by_event_name_network_group	GET /event/network-group/{event_name}/	Get instances of a network-group event.
retrieve_event_device_group	GET /event/device-group/	Get all events for a device-group.
retrieve_event_network_group	GET /event/network-group/	Get all events for a network-group.
retrieve_events	GET /events/	Get all events.
retrieve_files_certificates_by_file_name	GET /files/certificates/{file_name}/	Download a certificate-file.
retrieve_files_helper_files	GET /files/helper-files/	Get all helper-file names.
retrieve_files_helper_files_by_file_name	GET /files/helper-files/{file_name}/	Download a helper-file.
retrieve_health_all	GET /health/	Return a dict with health of devices in device groups and network groups
retrieve_health_tree_by_device_group	GET /health-tree/device-group/{device_group_name}/	Get device-group health-tree.
retrieve_health_tree_by_id	GET /health-tree/{device_id}/	Return a device's health-tree.
retrieve_health_tree_by_network_group	GET /health-tree/network-group/{network_group_name}/	Get network-group health-tree.
retrieve_healthbot_ingest_settings_byoi_custom_plugin_by_id	GET /ingest-settings/byoi/custom-plugin/{name}/	Retrieve custom-plugin by ID
retrieve_healthbot_ingest_settings_byoi_custom_plugins	GET /ingest-settings/byoi/custom-plugins/	Retrieve custom-plugin by ID
retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id	GET /ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/	Retrieve tlive-kafka-oc by ID
retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafkas	GET /ingest-settings/byoi/default-plugin/tlive-kafka-ocs/	Retrieve tlive-kafka-oc
retrieve_healthbot_ingest_settings_byoi_ingest_mapping_by_id	GET /ingest-settings/byoi/ingest-mapping/{name}/	Retrieve ingest-mapping by ID
retrieve_healthbot_ingest_settings_byoi_ingest_mappings	GET /ingest-settings/byoi/ingest-mappings/	Retrieve ingest-mapping
retrieve_healthbot_ingest_settings_frequency_profile	GET /ingest-settings/frequency-profiles/	Retrieve frequency-profile
retrieve_healthbot_ingest_settings_frequency_profile_by_id	GET /ingest-settings/frequency-profile/{name}/	Retrieve frequency-profile by ID
retrieve_healthbot_system_time_series_database_time_series_database	GET /system/tsdb/	Retrieve time-series-database
retrieve_iceberg_ingest_settings	GET /ingest-settings/	Retrieve ingest-settings
retrieve_iceberg_ingest_settings_flow	GET /ingest-settings/flow/	Retrieve flow
retrieve_iceberg_ingest_settings_flow_template_by_id	GET /ingest-settings/flow/template/{name}/	Retrieve template by ID
retrieve_iceberg_ingest_settings_flow_template_ids	GET /ingest-settings/flow/template/	Retrieve template
retrieve_iceberg_ingest_settings_syslog	GET /ingest-settings/syslog/	Retrieve syslog
retrieve_iceberg_ingest_settings_syslog_pattern_by_id	GET /ingest-settings/syslog/pattern/{name}/	Retrieve pattern by ID
retrieve_iceberg_ingest_settings_syslog_pattern_ids	GET /ingest-settings/syslog/pattern/	Retrieve pattern
retrieve_iceberg_ingest_settings_syslog_pattern_set_by_id	GET /ingest-settings/syslog/pattern-set/{name}/	Retrieve pattern-set by ID
retrieve_iceberg_ingest_settings_syslog_pattern_set_ids	GET /ingest-settings/syslog/pattern-set/	Retrieve pattern-set
retrieve_iceberg_ingest_settings_syslog_pattern_sets	GET /ingest-settings/syslog/pattern-sets/	Retrieve pattern-set by ID
retrieve_iceberg_ingest_settings_syslog_patterns	GET /ingest-settings/syslog/patterns/	Retrieve pattern by ID
retrieve_iceberg_profile_data_summarization_raw_by_id	GET /profile/data-summarization/raw/{name}/	Retrieve raw-data-summarization by ID
retrieve_iceberg_profile_data_summarizations_raw	GET /profile/data-summarizations/raw/	Retrieve raw-data-summarization
retrieve_iceberg_profile_security_ca_profile_by_id	GET /profile/security/ca-profile/{name}/	Retrieve ca-profile by ID
retrieve_iceberg_profile_security_ca_profiles	GET /profile/security/ca-profiles/	Retrieve ca-profile
retrieve_iceberg_profile_security_local_certificate_by_id	GET /profile/security/local-certificate/{name}/	Retrieve local-certificate by ID
retrieve_iceberg_profile_security_local_certificates	GET /profile/security/local-certificates/	Retrieve local-certificate
retrieve_iceberg_profile_security_ssh_key_profile_by_id	GET /profile/security/ssh-key-profile/{name}/	Retrieve ssh-key-profile by ID
retrieve_iceberg_profile_security_ssh_key_profiles	GET /profile/security/ssh-key-profiles/	Retrieve ssh-key-profile
retrieve_iceberg_profiles	GET /profiles/	Retrieve profile
retrieve_sensors	GET /sensors/	List all OpenConfig sensors.
update_healthbot_ingest_settings_byoi_custom_plugin_by_id	PUT /ingest-settings/byoi/custom-plugin/{name}/	Update custom-plugin by ID
update_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id	PUT /ingest-settings/byoi/default-plugin/tlive-kafka-oc/{name}/	Update tlive-kafka-oc by ID
update_healthbot_ingest_settings_byoi_ingest_mapping_by_id	PUT /ingest-settings/byoi/ingest-mapping/{name}/	Update ingest-mapping by ID
update_healthbot_ingest_settings_frequency_profile_by_id	PUT /ingest-settings/frequency-profile/{name}/	Update frequency-profile by ID
update_healthbot_system_time_series_database_time_series_database_by_id	PUT /system/tsdb/	Update time-series-database by ID
update_iceberg_ingest_settings	PUT /ingest-settings/	Update ingest-settings by ID
update_iceberg_ingest_settings_flow	PUT /ingest-settings/flow/	Update flow by ID
update_iceberg_ingest_settings_flow_template_by_id	PUT /ingest-settings/flow/template/{name}/	Update template by ID
update_iceberg_ingest_settings_syslog	PUT /ingest-settings/syslog/	Update syslog by ID
update_iceberg_ingest_settings_syslog_pattern_by_id	PUT /ingest-settings/syslog/pattern/{name}/	Update pattern by ID
update_iceberg_ingest_settings_syslog_pattern_set_by_id	PUT /ingest-settings/syslog/pattern-set/{name}/	Update pattern-set by ID
update_iceberg_profile_data_summarization_raw_by_id	PUT /profile/data-summarization/raw/{name}/	Update raw-data-summarization by ID
update_iceberg_profile_security_ca_profile_by_id	PUT /profile/security/ca-profile/{name}/	Update ca-profile by ID
update_iceberg_profile_security_local_certificate_by_id	PUT /profile/security/local-certificate/{name}/	Update local-certificate by ID
update_iceberg_profile_security_ssh_key_profile_by_id	PUT /profile/security/ssh-key-profile/{name}/	Update ssh-key-profile by ID
update_iceberg_profiles	PUT /profiles/	Update profile by ID

backup_helper_files¶

file backup_helper_files(authorization=authorization)

Download the tar file containing all helper files.

Download helper files tar file, which will include the config and input directory.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Download the tar file containing all helper files.
    api_response = api_instance.backup_helper_files(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->backup_helper_files: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

**file**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_files_certificates_by_file_name¶

create_files_certificates_by_file_name(up_file, file_name, authorization=authorization, password=password, certificate_type=certificate_type)

Upload a certificate file.

Upload the specified certificate-file.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
up_file = '/path/to/file.txt' # file | File content
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)
password = 'password_example' # str | password (optional)
certificate_type = 'certificate_type_example' # str | Certificate type (optional)

try:
    # Upload a certificate file.
    api_instance.create_files_certificates_by_file_name(up_file, file_name, authorization=authorization, password=password, certificate_type=certificate_type)
except ApiException as e:
    print("Exception when calling DefaultApi->create_files_certificates_by_file_name: %s\n" % e)

Name	Type	Description	Notes
up_file	file	File content
file_name	str	File name
authorization	str	authentication header object	[optional]
password	str	password	[optional]
certificate_type	str	Certificate type	[optional]

void (empty response body)

No authorization required

Content-Type: multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_files_helper_files_by_file_name¶

create_files_helper_files_by_file_name(up_file, file_name, authorization=authorization)

Upload a helper-file.

Upload the specified helper-file.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
up_file = '/path/to/file.txt' # file | File content
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Upload a helper-file.
    api_instance.create_files_helper_files_by_file_name(up_file, file_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_files_helper_files_by_file_name: %s\n" % e)

Name	Type	Description	Notes
up_file	file	File content
file_name	str	File name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_healthbot_ingest_settings_byoi_custom_plugin_by_id¶

create_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, custom_plugin, authorization=authorization)

Create custom-plugin by ID

Create operation of resource: custom-plugin

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of custom-plugin
custom_plugin = swagger_client.CustomPluginSchema() # CustomPluginSchema | custom_pluginbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create custom-plugin by ID
    api_instance.create_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, custom_plugin, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_healthbot_ingest_settings_byoi_custom_plugin_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of custom-plugin
custom_plugin	CustomPluginSchema	custom_pluginbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id¶

create_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, tlive_kafka, authorization=authorization)

Create tlive-kafka-oc by ID

Add/Merge a tlive-kafka-oc configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of tlive-kafka-oc
tlive_kafka = swagger_client.TliveKafkaOcSchema() # TliveKafkaOcSchema | tlive_kafkabody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create tlive-kafka-oc by ID
    api_instance.create_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, tlive_kafka, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of tlive-kafka-oc
tlive_kafka	TliveKafkaOcSchema	tlive_kafkabody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_healthbot_ingest_settings_byoi_ingest_mapping_by_id¶

create_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, ingest_mapping, authorization=authorization)

Create ingest-mapping by ID

Create ingest-mapping by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ingest-mapping
ingest_mapping = swagger_client.IngestMappingSchema() # IngestMappingSchema | ingest_mappingbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create ingest-mapping by ID
    api_instance.create_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, ingest_mapping, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_healthbot_ingest_settings_byoi_ingest_mapping_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ingest-mapping
ingest_mapping	IngestMappingSchema	ingest_mappingbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_healthbot_ingest_settings_frequency_profile_by_id¶

create_healthbot_ingest_settings_frequency_profile_by_id(name, frequency_profile, authorization=authorization)

Create frequency-profile by ID

Create operation of resource: frequency-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | ID of name
frequency_profile = swagger_client.FrequencyProfileSchema() # FrequencyProfileSchema | frequency_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create frequency-profile by ID
    api_instance.create_healthbot_ingest_settings_frequency_profile_by_id(name, frequency_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_healthbot_ingest_settings_frequency_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	ID of name
frequency_profile	FrequencyProfileSchema	frequency_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_healthbot_system_time_series_database_time_series_database_by_id¶

create_healthbot_system_time_series_database_time_series_database_by_id(time_series_database, force_tsdb=force_tsdb)

Create time-series-database by ID

Create operation of resource: time-series-database

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
time_series_database = swagger_client.TsdbSchema() # TsdbSchema | time_series_databasebody object
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Create time-series-database by ID
    api_instance.create_healthbot_system_time_series_database_time_series_database_by_id(time_series_database, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling DefaultApi->create_healthbot_system_time_series_database_time_series_database_by_id: %s\n" % e)

Name	Type	Description	Notes
time_series_database	TsdbSchema	time_series_databasebody object
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings¶

create_iceberg_ingest_settings(ingest_settings, authorization=authorization)

Create ingest-settings by ID

Create operation of resource: ingest-settings

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
ingest_settings = swagger_client.IngestSettingsSchema() # IngestSettingsSchema | ingest_settingsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create ingest-settings by ID
    api_instance.create_iceberg_ingest_settings(ingest_settings, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings: %s\n" % e)

Name	Type	Description	Notes
ingest_settings	IngestSettingsSchema	ingest_settingsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings_flow¶

create_iceberg_ingest_settings_flow(flow, authorization=authorization)

Create flow by ID

Create operation of resource: flow

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
flow = swagger_client.FlowSchema() # FlowSchema | flowbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create flow by ID
    api_instance.create_iceberg_ingest_settings_flow(flow, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings_flow: %s\n" % e)

Name	Type	Description	Notes
flow	FlowSchema	flowbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings_flow_template_by_id¶

create_iceberg_ingest_settings_flow_template_by_id(name, template, authorization=authorization)

Create template by ID

Create operation of resource: template

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of template
template = swagger_client.TemplateSchema() # TemplateSchema | templatebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create template by ID
    api_instance.create_iceberg_ingest_settings_flow_template_by_id(name, template, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings_flow_template_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of template
template	TemplateSchema	templatebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings_syslog¶

create_iceberg_ingest_settings_syslog(syslog, authorization=authorization)

Create syslog by ID

Create operation of resource: syslog

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
syslog = swagger_client.SyslogSchema() # SyslogSchema | syslogbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create syslog by ID
    api_instance.create_iceberg_ingest_settings_syslog(syslog, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings_syslog: %s\n" % e)

Name	Type	Description	Notes
syslog	SyslogSchema	syslogbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings_syslog_pattern_by_id¶

create_iceberg_ingest_settings_syslog_pattern_by_id(name, pattern, authorization=authorization)

Create pattern by ID

Create operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern
pattern = swagger_client.PatternSchema() # PatternSchema | patternbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create pattern by ID
    api_instance.create_iceberg_ingest_settings_syslog_pattern_by_id(name, pattern, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings_syslog_pattern_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern
pattern	PatternSchema	patternbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_ingest_settings_syslog_pattern_set_by_id¶

create_iceberg_ingest_settings_syslog_pattern_set_by_id(name, pattern_set, authorization=authorization)

Create pattern-set by ID

Create operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern-set
pattern_set = swagger_client.PatternSetSchema() # PatternSetSchema | pattern_setbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create pattern-set by ID
    api_instance.create_iceberg_ingest_settings_syslog_pattern_set_by_id(name, pattern_set, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_ingest_settings_syslog_pattern_set_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern-set
pattern_set	PatternSetSchema	pattern_setbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_profile_data_summarization_raw_by_id¶

create_iceberg_profile_data_summarization_raw_by_id(name, raw_data_summarization, authorization=authorization)

Create raw-data-summarization by ID

Create operation of resource: raw-data-summarization

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of raw-data-summarization
raw_data_summarization = swagger_client.RawSchema() # RawSchema | raw_data_summarizationbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create raw-data-summarization by ID
    api_instance.create_iceberg_profile_data_summarization_raw_by_id(name, raw_data_summarization, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_profile_data_summarization_raw_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of raw-data-summarization
raw_data_summarization	RawSchema	raw_data_summarizationbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_profile_security_ca_profile_by_id¶

create_iceberg_profile_security_ca_profile_by_id(name, ca_profile, authorization=authorization)

Create ca-profile by ID

Create operation of resource: ca-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ca-profile
ca_profile = swagger_client.CaProfileSchema() # CaProfileSchema | ca_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create ca-profile by ID
    api_instance.create_iceberg_profile_security_ca_profile_by_id(name, ca_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_profile_security_ca_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ca-profile
ca_profile	CaProfileSchema	ca_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_profile_security_local_certificate_by_id¶

create_iceberg_profile_security_local_certificate_by_id(name, local_certificate, authorization=authorization)

Create local-certificate by ID

Create operation of resource: local-certificate

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of local-certificate
local_certificate = swagger_client.LocalCertificateSchema() # LocalCertificateSchema | local_certificatebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create local-certificate by ID
    api_instance.create_iceberg_profile_security_local_certificate_by_id(name, local_certificate, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_profile_security_local_certificate_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of local-certificate
local_certificate	LocalCertificateSchema	local_certificatebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_profile_security_ssh_key_profile_by_id¶

create_iceberg_profile_security_ssh_key_profile_by_id(name, ssh_key_profile, authorization=authorization)

Create ssh-key-profile by ID

Create operation of resource: ssh-key-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ssh-key-profile
ssh_key_profile = swagger_client.SshKeyProfileSchema() # SshKeyProfileSchema | ssh_key_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create ssh-key-profile by ID
    api_instance.create_iceberg_profile_security_ssh_key_profile_by_id(name, ssh_key_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_profile_security_ssh_key_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ssh-key-profile
ssh_key_profile	SshKeyProfileSchema	ssh_key_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_profiles¶

create_iceberg_profiles(profile, authorization=authorization)

Create profile by ID

Create entire profile configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
profile = swagger_client.ProfilesSchema() # ProfilesSchema | profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create profile by ID
    api_instance.create_iceberg_profiles(profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->create_iceberg_profiles: %s\n" % e)

Name	Type	Description	Notes
profile	ProfilesSchema	profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_files_certificates_by_file_name¶

delete_files_certificates_by_file_name(file_name, authorization=authorization, input_path=input_path, certificate_type=certificate_type)

Delete a certificate-file.

Delete the specified certificate-file. Delete will not fail if the certificate-file is being used by some service.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)
input_path = 'input_path_example' # str | Input path (optional)
certificate_type = 'certificate_type_example' # str | Certificate type (optional)

try:
    # Delete a certificate-file.
    api_instance.delete_files_certificates_by_file_name(file_name, authorization=authorization, input_path=input_path, certificate_type=certificate_type)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_files_certificates_by_file_name: %s\n" % e)

Name	Type	Description	Notes
file_name	str	File name
authorization	str	authentication header object	[optional]
input_path	str	Input path	[optional]
certificate_type	str	Certificate type	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_files_helper_files_by_file_name¶

delete_files_helper_files_by_file_name(file_name, authorization=authorization, input_path=input_path)

Delete a helper-file.

Delete the specified helper-file. Delete will not fail if the helper-file is being used by some service.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)
input_path = 'input_path_example' # str | Input path (optional)

try:
    # Delete a helper-file.
    api_instance.delete_files_helper_files_by_file_name(file_name, authorization=authorization, input_path=input_path)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_files_helper_files_by_file_name: %s\n" % e)

Name	Type	Description	Notes
file_name	str	File name
authorization	str	authentication header object	[optional]
input_path	str	Input path	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_ingest_settings_byoi_custom_plugin_by_id¶

delete_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, authorization=authorization)

Delete custom-plugin by ID

Delete operation of resource: custom-plugin

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of custom-plugin
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete custom-plugin by ID
    api_instance.delete_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_healthbot_ingest_settings_byoi_custom_plugin_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of custom-plugin
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id¶

delete_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, authorization=authorization)

Delete tlive-kafka-oc by ID

Delete operation of resource: tlive-kafka-oc

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of tlive-kafka-oc
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete tlive-kafka-oc by ID
    api_instance.delete_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of tlive-kafka-oc
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_ingest_settings_byoi_ingest_mapping_by_id¶

delete_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, authorization=authorization)

Delete ingest-mapping by ID

Delete ingest-mapping by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ingest-mapping
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete ingest-mapping by ID
    api_instance.delete_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_healthbot_ingest_settings_byoi_ingest_mapping_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ingest-mapping
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_ingest_settings_frequency_profile_by_id¶

delete_healthbot_ingest_settings_frequency_profile_by_id(name, authorization=authorization)

Delete frequency-profile by ID

Delete operation of resource: frequency-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | ID of name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete frequency-profile by ID
    api_instance.delete_healthbot_ingest_settings_frequency_profile_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_healthbot_ingest_settings_frequency_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	ID of name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_system_time_series_database_time_series_database_by_id¶

delete_healthbot_system_time_series_database_time_series_database_by_id()

Delete time-series-database

Delete operation of resource: time-series-database

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try:
    # Delete time-series-database
    api_instance.delete_healthbot_system_time_series_database_time_series_database_by_id()
except ApiException as e:
    print("Exception when calling DefaultApi->delete_healthbot_system_time_series_database_time_series_database_by_id: %s\n" % e)

This endpoint does not need any parameter.

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings¶

delete_iceberg_ingest_settings(authorization=authorization)

Delete ingest-settings by ID

Delete operation of resource: ingest-settings

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete ingest-settings by ID
    api_instance.delete_iceberg_ingest_settings(authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings_flow¶

delete_iceberg_ingest_settings_flow(authorization=authorization)

Delete flow by ID

Delete operation of resource: flow

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete flow by ID
    api_instance.delete_iceberg_ingest_settings_flow(authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings_flow: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings_flow_template_by_id¶

delete_iceberg_ingest_settings_flow_template_by_id(name, authorization=authorization)

Delete template by ID

Delete operation of resource: template

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of template
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete template by ID
    api_instance.delete_iceberg_ingest_settings_flow_template_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings_flow_template_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of template
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings_syslog¶

delete_iceberg_ingest_settings_syslog(authorization=authorization)

Delete syslog by ID

Delete operation of resource: syslog

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete syslog by ID
    api_instance.delete_iceberg_ingest_settings_syslog(authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings_syslog: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings_syslog_pattern_by_id¶

delete_iceberg_ingest_settings_syslog_pattern_by_id(name, authorization=authorization)

Delete pattern by ID

Delete operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete pattern by ID
    api_instance.delete_iceberg_ingest_settings_syslog_pattern_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings_syslog_pattern_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_ingest_settings_syslog_pattern_set_by_id¶

delete_iceberg_ingest_settings_syslog_pattern_set_by_id(name, authorization=authorization)

Delete pattern-set by ID

Delete operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern-set
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete pattern-set by ID
    api_instance.delete_iceberg_ingest_settings_syslog_pattern_set_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_ingest_settings_syslog_pattern_set_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern-set
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_profile_data_summarization_raw_by_id¶

delete_iceberg_profile_data_summarization_raw_by_id(name, authorization=authorization)

Delete raw-data-summarization by ID

Delete operation of resource: raw data-summarization

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of raw-data-summarization
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete raw-data-summarization by ID
    api_instance.delete_iceberg_profile_data_summarization_raw_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_profile_data_summarization_raw_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of raw-data-summarization
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_profile_security_ca_profile_by_id¶

delete_iceberg_profile_security_ca_profile_by_id(name, authorization=authorization)

Delete ca-profile by ID

Delete operation of resource: ca-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ca-profile
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete ca-profile by ID
    api_instance.delete_iceberg_profile_security_ca_profile_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_profile_security_ca_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ca-profile
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_profile_security_local_certificate_by_id¶

delete_iceberg_profile_security_local_certificate_by_id(name, authorization=authorization)

Delete local-certificate by ID

Delete operation of resource: local-certificate

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of local-certificate
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete local-certificate by ID
    api_instance.delete_iceberg_profile_security_local_certificate_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_profile_security_local_certificate_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of local-certificate
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_profile_security_ssh_key_profile_by_id¶

delete_iceberg_profile_security_ssh_key_profile_by_id(name, authorization=authorization)

Delete ssh-key-profile by ID

Delete operation of resource: ssh-key-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ssh-key-profile
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete ssh-key-profile by ID
    api_instance.delete_iceberg_profile_security_ssh_key_profile_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_profile_security_ssh_key_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ssh-key-profile
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_profiles¶

delete_iceberg_profiles(authorization=authorization)

Delete profile by ID

Delete entire profile configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete profile by ID
    api_instance.delete_iceberg_profiles(authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_iceberg_profiles: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inspect_command_rpc_table_on_device¶

inspect_command_rpc_table_on_device(command_rpc_detail, authorization=authorization)

Inspect the given iAgent table.

Inspect the given iAgent table on a device and return the results.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
command_rpc_detail = swagger_client.CommandRpc() # CommandRpc | command-rpc object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Inspect the given iAgent table.
    api_instance.inspect_command_rpc_table_on_device(command_rpc_detail, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->inspect_command_rpc_table_on_device: %s\n" % e)

Name	Type	Description	Notes
command_rpc_detail	CommandRpc	command-rpc object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore_helper_files¶

restore_helper_files(restore_file, authorization=authorization)

Upload a helper-file.

Upload tar file of helper-files

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
restore_file = '/path/to/file.txt' # file | File content
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Upload a helper-file.
    api_instance.restore_helper_files(restore_file, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->restore_helper_files: %s\n" % e)

Name	Type	Description	Notes
restore_file	file	File content
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_configuration_jobs¶

list[InlineResponse200] retrieve_configuration_jobs(authorization=authorization, job_id=job_id, job_status=job_status)

Return list of all the Commit Job ID’s

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
job_id = 'job_id_example' # str | Id of Job (optional)
job_status = 'job_status_example' # str | Type of job (optional)

try:
    api_response = api_instance.retrieve_configuration_jobs(authorization=authorization, job_id=job_id, job_status=job_status)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_configuration_jobs: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
job_id	str	Id of Job	[optional]
job_status	str	Type of job	[optional]

**list[InlineResponse200]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_data_database_table¶

list[TableSchema] retrieve_data_database_table(authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name)

Get information about tables for a device of a device-group.

Get information about different types of tables stored for a device of a device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
device_id = 'device_id_example' # str | Name of device (optional)
device_group_name = 'device_group_name_example' # str | Name of device-group (optional)
network_group_name = 'network_group_name_example' # str | Name of network-group (optional)

try:
    # Get information about tables for a device of a device-group.
    api_response = api_instance.retrieve_data_database_table(authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_data_database_table: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
device_id	str	Name of device	[optional]
device_group_name	str	Name of device-group	[optional]
network_group_name	str	Name of network-group	[optional]

**list[TableSchema]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_data_database_table_column_by_table_name¶

list[str] retrieve_data_database_table_column_by_table_name(table_name, authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name)

Get information about columns in a table.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
table_name = 'table_name_example' # str | Name of table
authorization = 'authorization_example' # str | authentication header object (optional)
device_id = 'device_id_example' # str | Name of device (optional)
device_group_name = 'device_group_name_example' # str | Name of device-group (optional)
network_group_name = 'network_group_name_example' # str | Name of network-group (optional)

try:
    # Get information about columns in a table.
    api_response = api_instance.retrieve_data_database_table_column_by_table_name(table_name, authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_data_database_table_column_by_table_name: %s\n" % e)

Name	Type	Description	Notes
table_name	str	Name of table
authorization	str	authentication header object	[optional]
device_id	str	Name of device	[optional]
device_group_name	str	Name of device-group	[optional]
network_group_name	str	Name of network-group	[optional]

list[str]

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_data_database_tags_by_table_name¶

list[str] retrieve_data_database_tags_by_table_name(table_name, authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name, tag=tag, where_clause=where_clause)

Get information about tags keys and values in a table.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
table_name = 'table_name_example' # str | Name of table
authorization = 'authorization_example' # str | authentication header object (optional)
device_id = 'device_id_example' # str | Name of device (optional)
device_group_name = 'device_group_name_example' # str | Name of device-group (optional)
network_group_name = 'network_group_name_example' # str | Name of network-group (optional)
tag = 'tag_example' # str | Tag key for which values are requested. (optional)
where_clause = 'where_clause_example' # str | 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` (optional)

try:
    # Get information about tags keys and values in a table.
    api_response = api_instance.retrieve_data_database_tags_by_table_name(table_name, authorization=authorization, device_id=device_id, device_group_name=device_group_name, network_group_name=network_group_name, tag=tag, where_clause=where_clause)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_data_database_tags_by_table_name: %s\n" % e)

Name	Type	Description	Notes
table_name	str	Name of table
authorization	str	authentication header object	[optional]
device_id	str	Name of device	[optional]
device_group_name	str	Name of device-group	[optional]
network_group_name	str	Name of network-group	[optional]
tag	str	Tag key for which values are requested.	[optional]
where_clause	str	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`	[optional]

list[str]

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_debug_jobs¶

object retrieve_debug_jobs(authorization=authorization, job_id=job_id)

Return the status of the last “/debug/” job

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
job_id = 'job_id_example' # str | Id of Job (optional)

try:
    api_response = api_instance.retrieve_debug_jobs(authorization=authorization, job_id=job_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_debug_jobs: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
job_id	str	Id of Job	[optional]

object

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event¶

list[Event] retrieve_event(from_timestamp, device_id, authorization=authorization, to_timestamp=to_timestamp, device_group_name=device_group_name, granularity=granularity, color=color)

Get all events for a device.

Get the list of events for a device. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
device_id = 'device_id_example' # str | device-id of the device for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
device_group_name = 'device_group_name_example' # str | Device group's device-group-name of which the device is part (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get all events for a device.
    api_response = api_instance.retrieve_event(from_timestamp, device_id, authorization=authorization, to_timestamp=to_timestamp, device_group_name=device_group_name, granularity=granularity, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event: %s\n" % e)

Name	Type	Description	Notes
from_timestamp	datetime	Starting timestamp
device_id	str	device-id of the device for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
device_group_name	str	Device group's device-group-name of which the device is part	[optional]
granularity	str	Granularity of query	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event_by_event_name¶

list[Event] retrieve_event_by_event_name(event_name, from_timestamp, device_id, authorization=authorization, to_timestamp=to_timestamp, device_group_name=device_group_name, granularity=granularity, color=color)

Get instances of a device event.

Get instances of a specified device event. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
event_name = 'event_name_example' # str | Name of event
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
device_id = 'device_id_example' # str | device-id of the device for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
device_group_name = 'device_group_name_example' # str | device-group-name of which the device is part (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get instances of a device event.
    api_response = api_instance.retrieve_event_by_event_name(event_name, from_timestamp, device_id, authorization=authorization, to_timestamp=to_timestamp, device_group_name=device_group_name, granularity=granularity, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event_by_event_name: %s\n" % e)

Name	Type	Description	Notes
event_name	str	Name of event
from_timestamp	datetime	Starting timestamp
device_id	str	device-id of the device for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
device_group_name	str	device-group-name of which the device is part	[optional]
granularity	str	Granularity of query	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event_by_event_name_device_group¶

list[Event] retrieve_event_by_event_name_device_group(event_name, from_timestamp, device_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, device_id=device_id, color=color)

Get instances of a device-group event.

Get instances of a specified device-group event. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
event_name = 'event_name_example' # str | Name of event
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
device_group_name = 'device_group_name_example' # str | device_group_name of the device-group for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
device_id = ['device_id_example'] # list[str] | list of devices under a device-group to be fetched (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get instances of a device-group event.
    api_response = api_instance.retrieve_event_by_event_name_device_group(event_name, from_timestamp, device_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, device_id=device_id, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event_by_event_name_device_group: %s\n" % e)

Name	Type	Description	Notes
event_name	str	Name of event
from_timestamp	datetime	Starting timestamp
device_group_name	str	device_group_name of the device-group for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
granularity	str	Granularity of query	[optional]
device_id	list[str]	list of devices under a device-group to be fetched	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event_by_event_name_network_group¶

list[Event] retrieve_event_by_event_name_network_group(event_name, from_timestamp, network_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, color=color)

Get instances of a network-group event.

Get instances of a specified network-group event. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
event_name = 'event_name_example' # str | Name of event
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
network_group_name = 'network_group_name_example' # str | network_group_name of the network-group for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get instances of a network-group event.
    api_response = api_instance.retrieve_event_by_event_name_network_group(event_name, from_timestamp, network_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event_by_event_name_network_group: %s\n" % e)

Name	Type	Description	Notes
event_name	str	Name of event
from_timestamp	datetime	Starting timestamp
network_group_name	str	network_group_name of the network-group for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
granularity	str	Granularity of query	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event_device_group¶

list[Event] retrieve_event_device_group(from_timestamp, device_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, device_id=device_id, color=color)

Get all events for a device-group.

Get the list of events for a device-group. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
device_group_name = 'device_group_name_example' # str | device_group_name of the device-group for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
device_id = ['device_id_example'] # list[str] | list of devices under a device-group to be fetched (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get all events for a device-group.
    api_response = api_instance.retrieve_event_device_group(from_timestamp, device_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, device_id=device_id, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event_device_group: %s\n" % e)

Name	Type	Description	Notes
from_timestamp	datetime	Starting timestamp
device_group_name	str	device_group_name of the device-group for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
granularity	str	Granularity of query	[optional]
device_id	list[str]	list of devices under a device-group to be fetched	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_event_network_group¶

list[Event] retrieve_event_network_group(from_timestamp, network_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, color=color)

Get all events for a network-group.

Get the list of events for a network-group. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
network_group_name = 'network_group_name_example' # str | network_group_name of the network-group for which events are requested
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
granularity = 'granularity_example' # str | Granularity of query (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get all events for a network-group.
    api_response = api_instance.retrieve_event_network_group(from_timestamp, network_group_name, authorization=authorization, to_timestamp=to_timestamp, granularity=granularity, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_event_network_group: %s\n" % e)

Name	Type	Description	Notes
from_timestamp	datetime	Starting timestamp
network_group_name	str	network_group_name of the network-group for which events are requested
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
granularity	str	Granularity of query	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_events¶

list[Event] retrieve_events(from_timestamp, authorization=authorization, to_timestamp=to_timestamp, color=color)

Get all events.

Get the list of all events. Filtering is possible with the use of various query parameters.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
from_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Starting timestamp
authorization = 'authorization_example' # str | authentication header object (optional)
to_timestamp = '2013-10-20T19:20:30+01:00' # datetime | Ending timestamp (optional)
color = 'color_example' # str | Color of events. (optional)

try:
    # Get all events.
    api_response = api_instance.retrieve_events(from_timestamp, authorization=authorization, to_timestamp=to_timestamp, color=color)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_events: %s\n" % e)

Name	Type	Description	Notes
from_timestamp	datetime	Starting timestamp
authorization	str	authentication header object	[optional]
to_timestamp	datetime	Ending timestamp	[optional]
color	str	Color of events.	[optional]

**list[Event]**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_files_certificates_by_file_name¶

file retrieve_files_certificates_by_file_name(file_name, authorization=authorization, input_path=input_path, certificate_type=certificate_type)

Download a certificate-file.

Download the specified certificate-file.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)
input_path = 'input_path_example' # str | Input path (optional)
certificate_type = 'certificate_type_example' # str | Certificate type (optional)

try:
    # Download a certificate-file.
    api_response = api_instance.retrieve_files_certificates_by_file_name(file_name, authorization=authorization, input_path=input_path, certificate_type=certificate_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_files_certificates_by_file_name: %s\n" % e)

Name	Type	Description	Notes
file_name	str	File name
authorization	str	authentication header object	[optional]
input_path	str	Input path	[optional]
certificate_type	str	Certificate type	[optional]

**file**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_files_helper_files¶

list[str] retrieve_files_helper_files(authorization=authorization, input_path=input_path)

Get all helper-file names.

Get a list of all the helper-file file-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
input_path = 'input_path_example' # str | Input path (optional)

try:
    # Get all helper-file names.
    api_response = api_instance.retrieve_files_helper_files(authorization=authorization, input_path=input_path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_files_helper_files: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
input_path	str	Input path	[optional]

list[str]

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_files_helper_files_by_file_name¶

file retrieve_files_helper_files_by_file_name(file_name, authorization=authorization, input_path=input_path)

Download a helper-file.

Download the specified helper-file.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
file_name = 'file_name_example' # str | File name
authorization = 'authorization_example' # str | authentication header object (optional)
input_path = 'input_path_example' # str | Input path (optional)

try:
    # Download a helper-file.
    api_response = api_instance.retrieve_files_helper_files_by_file_name(file_name, authorization=authorization, input_path=input_path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_files_helper_files_by_file_name: %s\n" % e)

Name	Type	Description	Notes
file_name	str	File name
authorization	str	authentication header object	[optional]
input_path	str	Input path	[optional]

**file**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_health_all¶

HealthSchema retrieve_health_all(authorization=authorization)

Return a dict with health of devices in device groups and network groups

Returns health of network-groups and devices in device-groups

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Return a dict with health of devices in device groups and network groups
    api_response = api_instance.retrieve_health_all(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_health_all: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

**HealthSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_health_tree_by_device_group¶

DeviceGroupHealthTree retrieve_health_tree_by_device_group(device_group_name, authorization=authorization, timestamp=timestamp, tolerance=tolerance, device=device)

Get device-group health-tree.

Get health-tree of a specified device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
device_group_name = 'device_group_name_example' # str | `device-group-name` of device-group
authorization = 'authorization_example' # str | authentication header object (optional)
timestamp = '2013-10-20T19:20:30+01:00' # datetime | Timestamp at which health tree is requested. If not specified, current server timestamp is used. (optional)
tolerance = 789 # int | 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`. (optional)
device = ['device_example'] # list[str] | list of devices under a device-group to be fetched (optional)

try:
    # Get device-group health-tree.
    api_response = api_instance.retrieve_health_tree_by_device_group(device_group_name, authorization=authorization, timestamp=timestamp, tolerance=tolerance, device=device)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_health_tree_by_device_group: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	`device-group-name` of device-group
authorization	str	authentication header object	[optional]
timestamp	datetime	Timestamp at which health tree is requested. If not specified, current server timestamp is used.	[optional]
tolerance	int	Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2tolerance` and `timestamp`. Default value is `2frequency` where `frequency` is extracted from `trigger`.	[optional]
device	list[str]	list of devices under a device-group to be fetched	[optional]

**DeviceGroupHealthTree**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_health_tree_by_id¶

DeviceHealthTree retrieve_health_tree_by_id(device_id, authorization=authorization, timestamp=timestamp, tolerance=tolerance)

Return a device’s health-tree.

Return health-tree of a specified device identified by device-id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
device_id = 'device_id_example' # str | `device-id` of device
authorization = 'authorization_example' # str | authentication header object (optional)
timestamp = '2013-10-20T19:20:30+01:00' # datetime | Timestamp at which health tree is requested. If not specified, current server timestamp is used. (optional)
tolerance = 789 # int | 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`. (optional)

try:
    # Return a device's health-tree.
    api_response = api_instance.retrieve_health_tree_by_id(device_id, authorization=authorization, timestamp=timestamp, tolerance=tolerance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_health_tree_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	`device-id` of device
authorization	str	authentication header object	[optional]
timestamp	datetime	Timestamp at which health tree is requested. If not specified, current server timestamp is used.	[optional]
tolerance	int	Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2tolerance` and `timestamp`. Default value is `2frequency` where `frequency` is extracted from `trigger`.	[optional]

**DeviceHealthTree**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_health_tree_by_network_group¶

NetworkHealthTree retrieve_health_tree_by_network_group(network_group_name, authorization=authorization, timestamp=timestamp, tolerance=tolerance)

Get network-group health-tree.

Get health-tree of a specified network-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
network_group_name = 'network_group_name_example' # str | `network-group-name` of network-group
authorization = 'authorization_example' # str | authentication header object (optional)
timestamp = '2013-10-20T19:20:30+01:00' # datetime | Timestamp at which health tree is requested. If not specified, current server timestamp is used. (optional)
tolerance = 789 # int | 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`. (optional)

try:
    # Get network-group health-tree.
    api_response = api_instance.retrieve_health_tree_by_network_group(network_group_name, authorization=authorization, timestamp=timestamp, tolerance=tolerance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_health_tree_by_network_group: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	`network-group-name` of network-group
authorization	str	authentication header object	[optional]
timestamp	datetime	Timestamp at which health tree is requested. If not specified, current server timestamp is used.	[optional]
tolerance	int	Timestamp tolerance in seconds. With this option, health-tree will contain latest data between `timestamp-2tolerance` and `timestamp`. Default value is `2frequency` where `frequency` is extracted from `trigger`.	[optional]

**NetworkHealthTree**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_custom_plugin_by_id¶

CustomPluginSchema retrieve_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, authorization=authorization, working=working)

Retrieve custom-plugin by ID

Retrieve operation of resource: custom-plugin

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of custom-plugin
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve custom-plugin by ID
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_custom_plugin_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of custom-plugin
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**CustomPluginSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_custom_plugins¶

CustomPluginSchema retrieve_healthbot_ingest_settings_byoi_custom_plugins(authorization=authorization, working=working)

Retrieve custom-plugin by ID

Retrieve all the custom-plugins configured.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve custom-plugin by ID
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_custom_plugins(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_custom_plugins: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**CustomPluginSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id¶

TliveKafkaOcSchema retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, authorization=authorization, working=working)

Retrieve tlive-kafka-oc by ID

Retrieve operation of resource: tlive-kafka-oc

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of tlive-kafka-oc
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve tlive-kafka-oc by ID
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of tlive-kafka-oc
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**TliveKafkaOcSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafkas¶

list[str] retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafkas(authorization=authorization, working=working)

Retrieve tlive-kafka-oc

Retrieve all the tlive-kafka-ocs configured.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve tlive-kafka-oc
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafkas(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_default_plugin_tlive_kafkas: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_ingest_mapping_by_id¶

IngestMappingSchema retrieve_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, authorization=authorization, working=working)

Retrieve ingest-mapping by ID

Retrieve ingest-mapping by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ingest-mapping
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ingest-mapping by ID
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_ingest_mapping_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ingest-mapping
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**IngestMappingSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_byoi_ingest_mappings¶

list[str] retrieve_healthbot_ingest_settings_byoi_ingest_mappings(authorization=authorization, working=working)

Retrieve ingest-mapping

Retrieve all the ingest mappings configured.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ingest-mapping
    api_response = api_instance.retrieve_healthbot_ingest_settings_byoi_ingest_mappings(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_byoi_ingest_mappings: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_frequency_profile¶

list[str] retrieve_healthbot_ingest_settings_frequency_profile(authorization=authorization, working=working)

Retrieve frequency-profile

Retrieve operation of resource: frequency-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve frequency-profile
    api_response = api_instance.retrieve_healthbot_ingest_settings_frequency_profile(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_frequency_profile: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_ingest_settings_frequency_profile_by_id¶

FrequencyProfileSchema retrieve_healthbot_ingest_settings_frequency_profile_by_id(name, authorization=authorization, working=working)

Retrieve frequency-profile by ID

Retrieve operation of resource: frequency-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | ID of name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve frequency-profile by ID
    api_response = api_instance.retrieve_healthbot_ingest_settings_frequency_profile_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_ingest_settings_frequency_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	ID of name
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**FrequencyProfileSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_healthbot_system_time_series_database_time_series_database¶

TsdbSchema retrieve_healthbot_system_time_series_database_time_series_database(working=working)

Retrieve time-series-database

Retrieve operation of resource: time-series-database

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve time-series-database
    api_response = api_instance.retrieve_healthbot_system_time_series_database_time_series_database(working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_healthbot_system_time_series_database_time_series_database: %s\n" % e)

Name	Type	Description	Notes
working	bool	true queries undeployed configuration	[optional]

**TsdbSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings¶

IngestSettingsSchema retrieve_iceberg_ingest_settings(authorization=authorization, working=working)

Retrieve ingest-settings

Retrieve operation of resource: ingest-settings

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ingest-settings
    api_response = api_instance.retrieve_iceberg_ingest_settings(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**IngestSettingsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_flow¶

FlowSchema retrieve_iceberg_ingest_settings_flow(authorization=authorization, working=working)

Retrieve flow

Retrieve operation of resource: flow

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve flow
    api_response = api_instance.retrieve_iceberg_ingest_settings_flow(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_flow: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**FlowSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_flow_template_by_id¶

TemplateSchema retrieve_iceberg_ingest_settings_flow_template_by_id(name, authorization=authorization, working=working)

Retrieve template by ID

Retrieve operation of resource: template

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of template
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve template by ID
    api_response = api_instance.retrieve_iceberg_ingest_settings_flow_template_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_flow_template_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of template
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**TemplateSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_flow_template_ids¶

list[str] retrieve_iceberg_ingest_settings_flow_template_ids(authorization=authorization, working=working)

Retrieve template

Retrieve operation of resource: template

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve template
    api_response = api_instance.retrieve_iceberg_ingest_settings_flow_template_ids(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_flow_template_ids: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog¶

SyslogSchema retrieve_iceberg_ingest_settings_syslog(authorization=authorization, working=working)

Retrieve syslog

Retrieve operation of resource: syslog

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve syslog
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SyslogSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_pattern_by_id¶

PatternSchema retrieve_iceberg_ingest_settings_syslog_pattern_by_id(name, authorization=authorization, working=working)

Retrieve pattern by ID

Retrieve operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern by ID
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_pattern_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_pattern_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**PatternSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_pattern_ids¶

list[str] retrieve_iceberg_ingest_settings_syslog_pattern_ids(authorization=authorization, working=working)

Retrieve pattern

Retrieve operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_pattern_ids(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_pattern_ids: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_pattern_set_by_id¶

PatternSetSchema retrieve_iceberg_ingest_settings_syslog_pattern_set_by_id(name, authorization=authorization, working=working)

Retrieve pattern-set by ID

Retrieve operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of patter-set
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern-set by ID
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_pattern_set_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_pattern_set_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of patter-set
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**PatternSetSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_pattern_set_ids¶

list[str] retrieve_iceberg_ingest_settings_syslog_pattern_set_ids(authorization=authorization, working=working)

Retrieve pattern-set

Retrieve operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern-set
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_pattern_set_ids(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_pattern_set_ids: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_pattern_sets¶

list[PatternSetSchema] retrieve_iceberg_ingest_settings_syslog_pattern_sets(authorization=authorization, working=working)

Retrieve pattern-set by ID

Retrieve operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern-set by ID
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_pattern_sets(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_pattern_sets: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**list[PatternSetSchema]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_ingest_settings_syslog_patterns¶

list[PatternSchema] retrieve_iceberg_ingest_settings_syslog_patterns(authorization=authorization, working=working)

Retrieve pattern by ID

Retrieve operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve pattern by ID
    api_response = api_instance.retrieve_iceberg_ingest_settings_syslog_patterns(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_ingest_settings_syslog_patterns: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**list[PatternSchema]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_data_summarization_raw_by_id¶

RawSchema retrieve_iceberg_profile_data_summarization_raw_by_id(name, authorization=authorization, working=working)

Retrieve raw-data-summarization by ID

Retrieve operation of resource: raw-data-summarization

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of raw-data-summarization
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve raw-data-summarization by ID
    api_response = api_instance.retrieve_iceberg_profile_data_summarization_raw_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_data_summarization_raw_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of raw-data-summarization
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**RawSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_data_summarizations_raw¶

RawSchema retrieve_iceberg_profile_data_summarizations_raw(authorization=authorization, working=working)

Retrieve raw-data-summarization

Retrieve operation of resource: raw-data-summarization

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve raw-data-summarization
    api_response = api_instance.retrieve_iceberg_profile_data_summarizations_raw(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_data_summarizations_raw: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**RawSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_ca_profile_by_id¶

CaProfileSchema retrieve_iceberg_profile_security_ca_profile_by_id(name, authorization=authorization, working=working)

Retrieve ca-profile by ID

Retrieve operation of resource: ca-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ca-profile
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ca-profile by ID
    api_response = api_instance.retrieve_iceberg_profile_security_ca_profile_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_ca_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ca-profile
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**CaProfileSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_ca_profiles¶

list[str] retrieve_iceberg_profile_security_ca_profiles(authorization=authorization, working=working)

Retrieve ca-profile

Retrieve entire ca-profiles configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ca-profile
    api_response = api_instance.retrieve_iceberg_profile_security_ca_profiles(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_ca_profiles: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_local_certificate_by_id¶

LocalCertificateSchema retrieve_iceberg_profile_security_local_certificate_by_id(name, authorization=authorization, working=working)

Retrieve local-certificate by ID

Retrieve operation of resource: local-certificate

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of local-certificate
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve local-certificate by ID
    api_response = api_instance.retrieve_iceberg_profile_security_local_certificate_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_local_certificate_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of local-certificate
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**LocalCertificateSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_local_certificates¶

list[str] retrieve_iceberg_profile_security_local_certificates(authorization=authorization, working=working)

Retrieve local-certificate

Retrieve entire local-certificates configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve local-certificate
    api_response = api_instance.retrieve_iceberg_profile_security_local_certificates(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_local_certificates: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_ssh_key_profile_by_id¶

SshKeyProfileSchema retrieve_iceberg_profile_security_ssh_key_profile_by_id(name, authorization=authorization, working=working)

Retrieve ssh-key-profile by ID

Retrieve operation of resource: ssh-key-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ssh-key-profile
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ssh-key-profile by ID
    api_response = api_instance.retrieve_iceberg_profile_security_ssh_key_profile_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_ssh_key_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ssh-key-profile
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SshKeyProfileSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profile_security_ssh_key_profiles¶

list[str] retrieve_iceberg_profile_security_ssh_key_profiles(authorization=authorization, working=working)

Retrieve ssh-key-profile

Retrieve entire ssh-key-profiles configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve ssh-key-profile
    api_response = api_instance.retrieve_iceberg_profile_security_ssh_key_profiles(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profile_security_ssh_key_profiles: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_profiles¶

ProfilesSchema retrieve_iceberg_profiles(authorization=authorization, working=working)

Retrieve profile

Retrieve entire profile configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve profile
    api_response = api_instance.retrieve_iceberg_profiles(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_iceberg_profiles: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**ProfilesSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_sensors¶

list[str] retrieve_sensors(sensor_type, authorization=authorization, sensor_name=sensor_name, depth=depth, append=append, snmp_table=snmp_table)

List all OpenConfig sensors.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
sensor_type = 'sensor_type_example' # str | Sensor type
authorization = 'authorization_example' # str | authentication header object (optional)
sensor_name = 'sensor_name_example' # str | Sensor name prefix. (optional)
depth = 56 # int | Relative depth to the `sensor_name`. (optional)
append = true # bool | Returns full path of the sensor. (optional)
snmp_table = 'snmp_table_example' # str | Returns list of all the columns for the particular snmp_table (optional)

try:
    # List all OpenConfig sensors.
    api_response = api_instance.retrieve_sensors(sensor_type, authorization=authorization, sensor_name=sensor_name, depth=depth, append=append, snmp_table=snmp_table)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->retrieve_sensors: %s\n" % e)

Name	Type	Description	Notes
sensor_type	str	Sensor type
authorization	str	authentication header object	[optional]
sensor_name	str	Sensor name prefix.	[optional]
depth	int	Relative depth to the `sensor_name`.	[optional]
append	bool	Returns full path of the sensor.	[optional]
snmp_table	str	Returns list of all the columns for the particular snmp_table	[optional]

list[str]

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_healthbot_ingest_settings_byoi_custom_plugin_by_id¶

update_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, custom_plugin, authorization=authorization)

Update custom-plugin by ID

Update operation of resource: custom-plugin

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of custom-plugin
custom_plugin = swagger_client.CustomPluginSchema() # CustomPluginSchema | custom_pluginbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update custom-plugin by ID
    api_instance.update_healthbot_ingest_settings_byoi_custom_plugin_by_id(name, custom_plugin, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_healthbot_ingest_settings_byoi_custom_plugin_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of custom-plugin
custom_plugin	CustomPluginSchema	custom_pluginbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id¶

update_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, tlive_kafka, authorization=authorization)

Update tlive-kafka-oc by ID

Update operation of resource: tlive-kafka-oc

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of tlive-kafka-oc
tlive_kafka = swagger_client.TliveKafkaOcSchema() # TliveKafkaOcSchema | tlive_kafka body object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update tlive-kafka-oc by ID
    api_instance.update_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id(name, tlive_kafka, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_healthbot_ingest_settings_byoi_default_plugin_tlive_kafka_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of tlive-kafka-oc
tlive_kafka	TliveKafkaOcSchema	tlive_kafka body object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_healthbot_ingest_settings_byoi_ingest_mapping_by_id¶

update_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, ingest_mapping, authorization=authorization)

Update ingest-mapping by ID

Update ingest-mapping by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ingest-mapping
ingest_mapping = swagger_client.IngestMappingSchema() # IngestMappingSchema | ingest_mappingbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update ingest-mapping by ID
    api_instance.update_healthbot_ingest_settings_byoi_ingest_mapping_by_id(name, ingest_mapping, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_healthbot_ingest_settings_byoi_ingest_mapping_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ingest-mapping
ingest_mapping	IngestMappingSchema	ingest_mappingbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_healthbot_ingest_settings_frequency_profile_by_id¶

update_healthbot_ingest_settings_frequency_profile_by_id(name, frequency_profile, authorization=authorization)

Update frequency-profile by ID

Update operation of resource: frequency-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | ID of name
frequency_profile = swagger_client.FrequencyProfileSchema() # FrequencyProfileSchema | frequency_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update frequency-profile by ID
    api_instance.update_healthbot_ingest_settings_frequency_profile_by_id(name, frequency_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_healthbot_ingest_settings_frequency_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	ID of name
frequency_profile	FrequencyProfileSchema	frequency_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_healthbot_system_time_series_database_time_series_database_by_id¶

update_healthbot_system_time_series_database_time_series_database_by_id(time_series_database, force_tsdb=force_tsdb)

Update time-series-database by ID

Update operation of resource: time-series-database

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
time_series_database = swagger_client.TsdbSchema() # TsdbSchema | time_series_databasebody object
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Update time-series-database by ID
    api_instance.update_healthbot_system_time_series_database_time_series_database_by_id(time_series_database, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling DefaultApi->update_healthbot_system_time_series_database_time_series_database_by_id: %s\n" % e)

Name	Type	Description	Notes
time_series_database	TsdbSchema	time_series_databasebody object
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings¶

update_iceberg_ingest_settings(ingest_settings, authorization=authorization)

Update ingest-settings by ID

Update operation of resource: ingest-settings

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
ingest_settings = swagger_client.IngestSettingsSchema() # IngestSettingsSchema | ingest_settingsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update ingest-settings by ID
    api_instance.update_iceberg_ingest_settings(ingest_settings, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings: %s\n" % e)

Name	Type	Description	Notes
ingest_settings	IngestSettingsSchema	ingest_settingsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings_flow¶

update_iceberg_ingest_settings_flow(flow, authorization=authorization)

Update flow by ID

Update operation of resource: flow

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
flow = swagger_client.FlowSchema() # FlowSchema | flowbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update flow by ID
    api_instance.update_iceberg_ingest_settings_flow(flow, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings_flow: %s\n" % e)

Name	Type	Description	Notes
flow	FlowSchema	flowbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings_flow_template_by_id¶

update_iceberg_ingest_settings_flow_template_by_id(name, template, authorization=authorization)

Update template by ID

Update operation of resource: template

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of template
template = swagger_client.TemplateSchema() # TemplateSchema | templatebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update template by ID
    api_instance.update_iceberg_ingest_settings_flow_template_by_id(name, template, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings_flow_template_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of template
template	TemplateSchema	templatebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings_syslog¶

update_iceberg_ingest_settings_syslog(syslog, authorization=authorization)

Update syslog by ID

Update operation of resource: syslog

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
syslog = swagger_client.SyslogSchema() # SyslogSchema | syslogbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update syslog by ID
    api_instance.update_iceberg_ingest_settings_syslog(syslog, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings_syslog: %s\n" % e)

Name	Type	Description	Notes
syslog	SyslogSchema	syslogbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings_syslog_pattern_by_id¶

update_iceberg_ingest_settings_syslog_pattern_by_id(name, pattern, authorization=authorization)

Update pattern by ID

Update operation of resource: pattern

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern
pattern = swagger_client.PatternSchema() # PatternSchema | patternbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update pattern by ID
    api_instance.update_iceberg_ingest_settings_syslog_pattern_by_id(name, pattern, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings_syslog_pattern_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern
pattern	PatternSchema	patternbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_ingest_settings_syslog_pattern_set_by_id¶

update_iceberg_ingest_settings_syslog_pattern_set_by_id(name, pattern_set, authorization=authorization)

Update pattern-set by ID

Update operation of resource: pattern-set

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of pattern-set
pattern_set = swagger_client.PatternSetSchema() # PatternSetSchema | pattern_setbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update pattern-set by ID
    api_instance.update_iceberg_ingest_settings_syslog_pattern_set_by_id(name, pattern_set, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_ingest_settings_syslog_pattern_set_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of pattern-set
pattern_set	PatternSetSchema	pattern_setbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_profile_data_summarization_raw_by_id¶

update_iceberg_profile_data_summarization_raw_by_id(name, raw_data_summarization, authorization=authorization)

Update raw-data-summarization by ID

Update operation of resource: raw-data-summarization

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of raw-data-summarization
raw_data_summarization = swagger_client.RawSchema() # RawSchema | raw_data_summarizationbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update raw-data-summarization by ID
    api_instance.update_iceberg_profile_data_summarization_raw_by_id(name, raw_data_summarization, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_profile_data_summarization_raw_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of raw-data-summarization
raw_data_summarization	RawSchema	raw_data_summarizationbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_profile_security_ca_profile_by_id¶

update_iceberg_profile_security_ca_profile_by_id(name, ca_profile, authorization=authorization)

Update ca-profile by ID

Update operation of resource: ca-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ca-profile
ca_profile = swagger_client.CaProfileSchema() # CaProfileSchema | ca_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update ca-profile by ID
    api_instance.update_iceberg_profile_security_ca_profile_by_id(name, ca_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_profile_security_ca_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ca-profile
ca_profile	CaProfileSchema	ca_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_profile_security_local_certificate_by_id¶

update_iceberg_profile_security_local_certificate_by_id(name, local_certificate, authorization=authorization)

Update local-certificate by ID

Update operation of resource: local-certificate

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of local-certificate
local_certificate = swagger_client.LocalCertificateSchema() # LocalCertificateSchema | local_certificatebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update local-certificate by ID
    api_instance.update_iceberg_profile_security_local_certificate_by_id(name, local_certificate, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_profile_security_local_certificate_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of local-certificate
local_certificate	LocalCertificateSchema	local_certificatebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_profile_security_ssh_key_profile_by_id¶

update_iceberg_profile_security_ssh_key_profile_by_id(name, ssh_key_profile, authorization=authorization)

Update ssh-key-profile by ID

Update operation of resource: ssh-key-profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
name = 'name_example' # str | Name of ssh-key-profile
ssh_key_profile = swagger_client.SshKeyProfileSchema() # SshKeyProfileSchema | ssh_key_profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update ssh-key-profile by ID
    api_instance.update_iceberg_profile_security_ssh_key_profile_by_id(name, ssh_key_profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_profile_security_ssh_key_profile_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of ssh-key-profile
ssh_key_profile	SshKeyProfileSchema	ssh_key_profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_profiles¶

update_iceberg_profiles(profile, authorization=authorization)

Update profile by ID

Update entire profile configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
profile = swagger_client.ProfilesSchema() # ProfilesSchema | profilebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update profile by ID
    api_instance.update_iceberg_profiles(profile, authorization=authorization)
except ApiException as e:
    print("Exception when calling DefaultApi->update_iceberg_profiles: %s\n" % e)

Name	Type	Description	Notes
profile	ProfilesSchema	profilebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InlineResponse2009¶

Properties¶

Name	Type	Description	Notes
group_id	str	ID generated by system	[optional]
group_name	str	Name of the group	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingNativegpb¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingByoi¶

Properties¶

Name	Type	Description	Notes
service	list[DevicegroupSchemaLoggingByoiService]		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsByoiDefaultplugin¶

Properties¶

Name	Type	Description	Notes
tlive_kafka_oc	list[TliveKafkaOcSchema]	TLive Kafka ingest	[optional]

[Back to Model list] [Back to API list] [Back to README]

RoleSchemaInner¶

Properties¶

Name	Type	Description	Notes
role_id	str	ID generated by system	[optional]
role_name	str	Name of the role	[optional]

[Back to Model list] [Back to API list] [Back to README]

AssociatedUserSchemaInner¶

Properties¶

Name	Type	Description	Notes
user_id	str		[optional]
user_name	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsFlowRecognitionpattern¶

Properties¶

Name	Type	Description	Notes
exclude_fields	list[str]		[optional]
include_fields	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenMaxrateofincrease¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
field_name	str	Field name on which rate should be compared
rate	str	Rate	[optional]
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

DestinationSchemaDisk¶

Properties¶

Name	Type	Description	Notes
max_reports	int	Maximux repots to store on disk	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaIAgent¶

Properties¶

Name	Type	Description	Notes
args	list[RuleSchemaIAgentArgs]		[optional]
file	str	File where table and views are defined
frequency	str	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
table	str	Table which needs to be used to extract the data
target	str	To run command on FPC, specifiy FPC target (optional)	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestMappingsSchema¶

Properties¶

Name	Type	Description	Notes
ingest_mapping	list[IngestMappingSchema]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaScheduler¶

Properties¶

Name	Type	Description
instance_id	str	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	str	Name of the playbook in which the variable instance needs to be used
rule	str	Name of the rule. This should be of the format <topic-name>/<rule-name>
schedule	str	Name of the schedule that play/pauses the playbook instance automatically

[Back to Model list] [Back to API list] [Back to README]

Password¶

Properties¶

Name	Type	Description	Notes
newpassword	str	New password	[optional]

[Back to Model list] [Back to API list] [Back to README]

RetentionPoliciesSchema¶

Properties¶

Name	Type	Description	Notes
retention_policy	list[RetentionPolicySchema]

[Back to Model list] [Back to API list] [Back to README]

ReportSchemaCanvaspanel¶

Properties¶

Name	Type	Description	Notes
name	str	Name of the panel.

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingMLmodelbuilder¶

Properties¶

Name	Type	Description	Notes
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

Error¶

Properties¶

Name	Type	Description	Notes
detail	str
status	int

[Back to Model list] [Back to API list] [Back to README]

RuleSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the rule	[optional]
field	list[RuleSchemaField]		[optional]
function	list[RuleSchemaFunction]		[optional]
keys	list[str]		[optional]
network_rule	list[ERRORUNKNOWN]	Flag to denote a network rule	[optional]
rule_frequency	str	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	[optional]
rule_name	str	Name of the rule. Should be of pattern [a-z][a-z0-9_-]*
sensor	list[RuleSchemaSensor1]		[optional]
synopsis	str	Synopsis about the rule	[optional]
field_aggregation_time_range	str	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	[optional]
trigger	list[RuleSchemaTrigger]		[optional]
variable	list[RuleSchemaVariable]	Playbook variable configuration	[optional]
vector	list[RuleSchemaVector]		[optional]
rule_properties	RuleSchemaRuleproperties		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula1Or¶

Properties¶

Name	Type	Description	Notes
left_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*
right_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

TsdbSchema¶

Properties¶

Name	Type	Description	Notes
dedicate	bool	Dedicate given nodes only for tsdb instances. No other services will be spawned on tsdb nodes when set to true	[optional]
nodes	list[str]		[optional]
replication_factor	int	High availability. Number of copies of data to be stored	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaStddev¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which standard deviation operation needs to be performed
time_range	str	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

[Back to Model list] [Back to API list] [Back to README]

UserSchema¶

Properties¶

Name	Type	Description	Notes
user_name	str	Name of the user	[optional]
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]
password	str	Password of the user	[optional]
active	bool	Status of the user	[optional]
groups	list[UserSchemaGroups]	list of groups associated	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingIAgent¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsFlowTemplate¶

Properties¶

Name	Type	Notes
description	str	[optional]
key_fields	list[str]	[optional]
name	str
priority	int	[optional]
protocol_version	str	[optional]
recognition_pattern	IngestsettingsSchemaIngestsettingsFlowRecognitionpattern	[optional]

[Back to Model list] [Back to API list] [Back to README]

NetworkHealthTree¶

Properties¶

Name	Type	Notes
children	list[NetworkHealthTree]
color	str	[optional]
data	str	[optional]
name	str
timestamp	datetime	[optional]

[Back to Model list] [Back to API list] [Back to README]

Token¶

Properties¶

Name	Type	Description	Notes
refresh_token	str	Refresh token	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingFlow¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaNativegpb¶

Properties¶

Name	Type	Description	Notes
frequency	str	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	[optional]
port	int	Port on which the native sensors will be received
sensor_name	str	Sensor to subscribe

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaMean¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which mean operation needs to be performed
time_range	str	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

[Back to Model list] [Back to API list] [Back to README]

ReportSchema¶

Properties¶

Name	Type	Description	Notes
destination	list[str]
format	str	Generated report format
graph_canvas	list[ReportSchemaGraphcanvas]	Canvas name	[optional]
name	str	Name of the report
schedule	list[str]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.DebugApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
healthbot_debug_generate_configuration	POST /debug/configuration/	Request Healthbot MGD service to generate the debug related configuration for healthbot debugger to consume.
retrieve_debug_for_scenario	POST /debug/scenario/{scenario_name}/	Run debugging for the given scenario name

healthbot_debug_generate_configuration¶

healthbot_debug_generate_configuration(authorization=authorization)

Request Healthbot MGD service to generate the debug related configuration for healthbot debugger to consume.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DebugApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Request Healthbot MGD service to generate the debug related configuration for healthbot debugger to consume.
    api_instance.healthbot_debug_generate_configuration(authorization=authorization)
except ApiException as e:
    print("Exception when calling DebugApi->healthbot_debug_generate_configuration: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_debug_for_scenario¶

object retrieve_debug_for_scenario(scenario_name, authorization=authorization, debug_arguments=debug_arguments)

Run debugging for the given scenario name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DebugApi()
scenario_name = 'scenario_name_example' # str | Scenario name
authorization = 'authorization_example' # str | authentication header object (optional)
debug_arguments = swagger_client.DebugArgumentsSchema() # DebugArgumentsSchema | Debug arguments object (optional)

try:
    # Run debugging for the given scenario name
    api_response = api_instance.retrieve_debug_for_scenario(scenario_name, authorization=authorization, debug_arguments=debug_arguments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->retrieve_debug_for_scenario: %s\n" % e)

Name	Type	Description	Notes
scenario_name	str	Scenario name
authorization	str	authentication header object	[optional]
debug_arguments	DebugArgumentsSchema	Debug arguments object	[optional]

object

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeviceSchemaVendorCisco¶

Properties¶

Name	Type	Description	Notes
operating_system	str	Operating system of the device

[Back to Model list] [Back to API list] [Back to README]

CustompluginSchemaSecurityparameters¶

Properties¶

Name	Type	Description	Notes
tls	CustompluginSchemaSecurityparametersTls		[optional]
user_authentication	CustompluginSchemaSecurityparametersUserauthentication		[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceHealthTree¶

Properties¶

Name	Type	Notes
children	list[DeviceHealthTree]
color	str	[optional]
data	str	[optional]
name	str
timestamp	datetime	[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaIAgent¶

Properties¶

Name	Type	Description	Notes
port	int	Netconf port	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaSnmp¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

RetentionPolicySchema¶

Properties¶

Name	Type	Description	Notes
duration	str	Schedule duration in days or hours, Should be of pattern [1-9][0-9]*[dh]	[optional]
replication	int	Number of independent copies if stored in the cluster	[optional]
retention_policy_name	str	Name of the retention-policy. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

NetworkGroupsSchema¶

Properties¶

Name	Type	Description	Notes
network_group	list[NetworkGroupSchema]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingByoiService¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level
name	str	Name of the service

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaByoiPluginParameters¶

Properties¶

Name	Type	Description	Notes
key	str	Key of the parameter
value	str	Value of the parameter

[Back to Model list] [Back to API list] [Back to README]

CustomPluginsSchema¶

Properties¶

Name	Type	Description	Notes
custom_plugin	list[CustomPluginSchema]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhen¶

Properties¶

Name	Type	Description	Notes
does_not_match_with	list[RuleSchemaWhenDoesnotmatchwith]		[optional]
equal_to	list[RuleSchemaWhenEqualto]		[optional]
exists	list[RuleSchemaWhenExists]		[optional]
greater_than	list[RuleSchemaWhenEqualto]		[optional]
greater_than_or_equal_to	list[RuleSchemaWhenEqualto]		[optional]
increasing_at_least_by_rate	list[RuleSchemaWhenIncreasingatleastbyrate]	Rate of increase between successive values is at least given rate	[optional]
increasing_at_least_by_value	list[RuleSchemaWhenIncreasingatleastbyvalue]	Increase between successive values is at least given value	[optional]
increasing_at_most_by_rate	list[RuleSchemaWhenIncreasingatleastbyrate]	Rate of increase between successive values is at most given rate	[optional]
increasing_at_most_by_value	list[RuleSchemaWhenIncreasingatleastbyvalue]	Increase between successive values is at most given value	[optional]
less_than	list[RuleSchemaWhenEqualto]		[optional]
less_than_or_equal_to	list[RuleSchemaWhenEqualto]		[optional]
matches_with	list[RuleSchemaWhenDoesnotmatchwith]		[optional]
max_rate_of_increase	list[RuleSchemaWhenMaxrateofincrease]		[optional]
min_rate_of_increase	list[RuleSchemaWhenMaxrateofincrease]		[optional]
not_equal_to	list[RuleSchemaWhenEqualto]		[optional]
range	list[RuleSchemaWhenRange]		[optional]
user_defined_function	list[RuleSchemaWhenUserdefinedfunction]		[optional]

[Back to Model list] [Back to API list] [Back to README]

SyslogSchema¶

Properties¶

Name	Type	Description	Notes
syslog	SyslogSchemaSyslog		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaSum¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which sum operation needs to be performed
time_range	str	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

[Back to Model list] [Back to API list] [Back to README]

AssociatedRoleSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaFlowNetflow¶

Properties¶

Name	Type	Description	Notes
ports	list[int]		[optional]

[Back to Model list] [Back to API list] [Back to README]

LicenseFeaturesSchema¶

Properties¶

Name	Type	Description	Notes
license_feature	list[LicenseFeatureSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaArgument¶

Properties¶

Name	Type	Description	Notes
argument_name	str	Name of the argument. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
mandatory	list[ERRORUNKNOWN]	Flag to indicate a mandatory attribute	[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaEmails¶

Properties¶

Name	Type	Description	Notes
ids	list[str]
filter	NotificationSchemaEmailsFilter		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRuleproperties¶

Properties¶

Name	Type	Description	Notes
author	str	E-mail address of the rule writer	[optional]
catalogue	RuleSchemaRulepropertiesCatalogue		[optional]
contributor	str		[optional]
_date	str		[optional]
helper_files	list[RuleSchemaRulepropertiesHelperfiles]		[optional]
supported_devices	RuleSchemaRulepropertiesSupporteddevices		[optional]
supported_healthbot_version	str	Healthbot version in which is rule is supported	[optional]
version	int	Rule version, an integer value needs to be incremented for any major change	[optional]
apply_macro	list[ApplyMacroSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

ApplyMacroSchema¶

Properties¶

Name	Type	Description	Notes
data	list[ApplymacroSchemaData]		[optional]
name	str	Name of the macro to be expanded

[Back to Model list] [Back to API list] [Back to README]

swagger_client.InstanceScheduleStateApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
retrieve_instances_schedule_state	GET /instances-schedule-state/{group_type}/{group_name}/	Get scheduled state of playbook instances with schedule.
update_instances_schedule_state	PUT /instances-schedule-state/{group_type}/{group_name}/	Update scheduled state of playbook instances with schedule.

retrieve_instances_schedule_state¶

InstancesScheduleStateSchema retrieve_instances_schedule_state(group_name, group_type, authorization=authorization)

Get scheduled state of playbook instances with schedule.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InstanceScheduleStateApi()
group_name = 'group_name_example' # str | Group name
group_type = 'group_type_example' # str | Group type
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get scheduled state of playbook instances with schedule.
    api_response = api_instance.retrieve_instances_schedule_state(group_name, group_type, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceScheduleStateApi->retrieve_instances_schedule_state: %s\n" % e)

Name	Type	Description	Notes
group_name	str	Group name
group_type	str	Group type
authorization	str	authentication header object	[optional]

**InstancesScheduleStateSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_instances_schedule_state¶

update_instances_schedule_state(group_name, group_type, instances_schedule_state, authorization=authorization)

Update scheduled state of playbook instances with schedule.

Update the scheduled state of instances with active scheduler attached to it and present under the group with name passed in the path parameter.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InstanceScheduleStateApi()
group_name = 'group_name_example' # str | Group name
group_type = 'group_type_example' # str | Group type
instances_schedule_state = swagger_client.InstancesScheduleStateSchema() # InstancesScheduleStateSchema | List of instances and their scheduled state
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update scheduled state of playbook instances with schedule.
    api_instance.update_instances_schedule_state(group_name, group_type, instances_schedule_state, authorization=authorization)
except ApiException as e:
    print("Exception when calling InstanceScheduleStateApi->update_instances_schedule_state: %s\n" % e)

Name	Type	Description	Notes
group_name	str	Group name
group_type	str	Group type
instances_schedule_state	InstancesScheduleStateSchema	List of instances and their scheduled state
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DevicegroupSchemaLoggingNonsensorrules¶

Properties¶

Name	Type	Description	Notes
daemons	list[str]		[optional]
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

FlowSchemaFlow¶

Properties¶

Name	Type	Description	Notes
template	list[FlowSchemaFlowTemplate]		[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaLoggingReportsgeneration¶

Properties¶

Name	Type	Description	Notes
log_level	str	Set the logging level

[Back to Model list] [Back to API list] [Back to README]

CustompluginSchemaSecurityparametersTls¶

Properties¶

Name	Type	Description	Notes
ca_profile	str	CA profile name	[optional]
insecure_skip_verify	bool	Use TLS but skip verification of certificate chain and host	[optional]
local_certificate_profile	str	Local certificate profile name	[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaFlow¶

Properties¶

Name	Type	Description	Notes
source_ip_addresses	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RawDataSummarizationsSchema¶

Properties¶

Name	Type	Description	Notes
raw_data_summarization	list[RawSchema]

[Back to Model list] [Back to API list] [Back to README]

ProfilesSchemaProfile¶

Properties¶

Name	Type	Description	Notes
security	ProfileSchemaSecurity		[optional]
data_summarization	ProfileSchemaDatasummarization		[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaVariable¶

Properties¶

Name	Type	Description	Notes
instance_id	str	Name of the variable instance. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
playbook	str	Name of the playbook in which the variable instance needs to be used
rule	str	Name of the rule. This must be of the format <topic-name>/<rule-name>
variable_value	list[DevicegroupSchemaVariablevalue]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaOutlierdetectionAlgorithm¶

Properties¶

Name	Type	Description	Notes
dbscan	RuleSchemaFormulaOutlierdetectionAlgorithmDbscan		[optional]
k_fold_3sigma	RuleSchemaFormulaOutlierdetectionAlgorithmKfold3sigma		[optional]

[Back to Model list] [Back to API list] [Back to README]

SyslogSchemaSyslog¶

Properties¶

Name	Type	Description	Notes
port	int	Port to listen for syslog messages, default is 514	[optional]
pattern	list[PatternSchema]		[optional]
pattern_set	list[PatternSetSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

FlowSchema¶

Properties¶

Name	Type	Description	Notes
flow	FlowSchemaFlow		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesCatalogue¶

Properties¶

Name	Type	Description	Notes
tier	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

HealthSchema¶

Properties¶

Name	Type	Description	Notes
device_health	DeviceHealthSchema		[optional]
network_health	GroupHealthSchema		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenUserdefinedfunction¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
argument	list[RuleSchemaThenArgument]		[optional]
function_name	str	Function name
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

ProfilesSchema¶

Properties¶

Name	Type	Description	Notes
profile	ProfilesSchemaProfile

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaSensor1¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the sensor	[optional]
flow	RuleSchemaFlow		[optional]
i_agent	RuleSchemaIAgent		[optional]
native_gpb	RuleSchemaNativegpb		[optional]
open_config	RuleSchemaOpenconfig		[optional]
sensor_name	str	Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
snmp	RuleSchemaSnmp		[optional]
syslog	RuleSchemaSyslog		[optional]
synopsis	str	Synopsis about the sensor	[optional]
byoi	RuleSchemaByoi		[optional]

[Back to Model list] [Back to API list] [Back to README]

ServiceStatus¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

swagger_client.ConfigurationApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
check_device_group_unsaved_configuration	POST /configuration/check/device-group/{device_group_name}/	Check if the un-committed configuration of the given device group is correct
check_network_group_unsaved_configuration	POST /configuration/check/network-group/{network_group_name}/	Check if the unsaved configuration of the given network group is correct.
commit_unsaved_configuration	POST /configuration/	Commit unsaved configuration.
create_iceberg_device_device_by_id	POST /device/{device_id}/	Update or create a device.
create_iceberg_device_group_device_group_by_id	POST /device-group/{device_group_name}/	Update or create a device-group.
create_iceberg_device_groups_device_groups_by_id	POST /device-groups/	Update or create multiple device-groups.
create_iceberg_devices_devices_by_id	POST /devices/	Update or create multiple devices.
create_iceberg_network_group_network_group_by_id	POST /network-group/{network_group_name}/	Update or create a network-group.
create_iceberg_network_groups_network_groups_by_id	POST /network-groups/	Update or create multiple network-groups.
create_iceberg_notification_notification_by_id	POST /notification/{notification_name}/	Update or create a notification
create_iceberg_notifications_notifications_by_id	POST /notifications/	Update or create multiple notifications.
create_iceberg_playbook_playbook_by_id	POST /playbook/{playbook_name}/	Update or create a playbook.
create_iceberg_playbooks_playbooks_by_id	POST /playbooks/	Update or create multiple playbooks.
create_iceberg_retention_policies_retention_policies_by_id	POST /retention-policies/	Update or create multiple retention-policies.
create_iceberg_retention_policy_retention_policy_by_id	POST /retention-policy/{retention_policy_name}/	Update or create a retention-policy.
create_iceberg_system_destination_by_id	POST /system/report-generation/destination/{name}/	Create destination by name
create_iceberg_system_destinations	POST /system/report-generation/destinations/	Create destinations by name
create_iceberg_system_report_by_id	POST /system/report-generation/report/{name}/	Create report by name
create_iceberg_system_reports	POST /system/report-generation/reports/	Create reports by name
create_iceberg_system_scheduler_by_id	POST /system/scheduler/{name}/	Create scheduler by name
create_iceberg_system_schedulers	POST /system/schedulers/	Create schedulers by name
create_iceberg_system_settings_destination_by_id	POST /system-settings/report-generation/destination/{name}/	Create destination by name
create_iceberg_system_settings_destinations	POST /system-settings/report-generation/destinations/	Create destinations by name
create_iceberg_system_settings_report_by_id	POST /system-settings/report-generation/report/{name}/	Create report by name
create_iceberg_system_settings_reports	POST /system-settings/report-generation/reports/	Create reports by name
create_iceberg_system_settings_scheduler_by_id	POST /system-settings/scheduler/{name}/	Create scheduler by name
create_iceberg_system_settings_schedulers	POST /system-settings/schedulers/	Create schedulers by name
create_iceberg_system_settings_system_settings_by_id	POST /system-settings/	Create system-settings
create_iceberg_system_system_by_id	POST /system/	Create system
create_iceberg_topic_rule_rule_by_id	POST /topic/{topic_name}/rule/{rule_name}/	Update or create a rule.
create_iceberg_topic_topic_by_id	POST /topic/{topic_name}/	Update or create a topic.
create_iceberg_topics_topics_by_id	POST /topics/	Update or create multiple topics.
delete_healthbot_ingest_settings_byoi_ingest_mappings	DELETE /ingest-settings/byoi/ingest-mappings/	Delete all ingest-mappings.
delete_iceberg_device_device_by_id	DELETE /device/{device_id}/	Delete device.
delete_iceberg_device_group_device_group_by_id	DELETE /device-group/{device_group_name}/	Delete device-group.
delete_iceberg_device_groups_device_groups_by_id	DELETE /device-groups/	Delete all device-groups.
delete_iceberg_devices_devices_by_id	DELETE /devices/	Delete all devices.
delete_iceberg_network_group_network_group_by_id	DELETE /network-group/{network_group_name}/	Delete network-group.
delete_iceberg_network_groups_network_groups_by_id	DELETE /network-groups/	Delete all network-groups.
delete_iceberg_notification_notification_by_id	DELETE /notification/{notification_name}/	Delete a notification.
delete_iceberg_notifications_notifications_by_id	DELETE /notifications/	Delete all notifications.
delete_iceberg_playbook_playbook_by_id	DELETE /playbook/{playbook_name}/	Delete a playbook.
delete_iceberg_playbooks_playbooks_by_id	DELETE /playbooks/	Delete all playbooks.
delete_iceberg_retention_policies_retention_policies_by_id	DELETE /retention-policies/	Delete all retention-policies.
delete_iceberg_retention_policy_retention_policy_by_id	DELETE /retention-policy/{retention_policy_name}/	Delete a retention-policy.
delete_iceberg_system_destination_by_id	DELETE /system/report-generation/destination/{name}/	Delete destination by name
delete_iceberg_system_destinations	DELETE /system/report-generation/destinations/	Delete destinations by name
delete_iceberg_system_report_by_id	DELETE /system/report-generation/report/{name}/	Delete report by name
delete_iceberg_system_reports	DELETE /system/report-generation/reports/	Delete reports by name
delete_iceberg_system_scheduler_by_id	DELETE /system/scheduler/{name}/	Delete scheduler by name
delete_iceberg_system_schedulers	DELETE /system/schedulers/	Delete schedulers by name
delete_iceberg_system_settings_destination_by_id	DELETE /system-settings/report-generation/destination/{name}/	Delete destination by name
delete_iceberg_system_settings_destinations	DELETE /system-settings/report-generation/destinations/	Delete destinations by name
delete_iceberg_system_settings_report_by_id	DELETE /system-settings/report-generation/report/{name}/	Delete report by name
delete_iceberg_system_settings_reports	DELETE /system-settings/report-generation/reports/	Delete reports by name
delete_iceberg_system_settings_scheduler_by_id	DELETE /system-settings/scheduler/{name}/	Delete scheduler by name
delete_iceberg_system_settings_schedulers	DELETE /system-settings/schedulers/	Delete schedulers by name
delete_iceberg_system_settings_system_settings_by_id	DELETE /system-settings/	Delete system-settings
delete_iceberg_system_system_by_id	DELETE /system/	Delete system
delete_iceberg_topic_rule_rule_by_id	DELETE /topic/{topic_name}/rule/{rule_name}/	Delete a rule.
delete_iceberg_topic_topic_by_id	DELETE /topic/{topic_name}/	Delete a topic.
delete_iceberg_topics_topics_by_id	DELETE /topics/	Delete all topics.
first_login	POST /first-login/	Change password after first login
retrieve_affected_groups	GET /configuration/	Get all groups affected by un-committed configuration changes.
retrieve_device_group_status	GET /device-group/{device_group_name}/status/	Get device-group's status.
retrieve_iceberg_device_device	GET /device/	List all device-ids.
retrieve_iceberg_device_device_by_id	GET /device/{device_id}/	Get a device's configuration.
retrieve_iceberg_device_group_device_group	GET /device-group/	List all device-group names.
retrieve_iceberg_device_group_device_group_by_id	GET /device-group/{device_group_name}/	Get device-group's configuration.
retrieve_iceberg_device_groups_device_groups	GET /device-groups/	Get all device-groups' configuration.
retrieve_iceberg_devices_devices	GET /devices/	Get all devices' configuration.
retrieve_iceberg_network_group_network_group	GET /network-group/	List all network-group names.
retrieve_iceberg_network_group_network_group_by_id	GET /network-group/{network_group_name}/	Get network-group's configuration.
retrieve_iceberg_network_groups_network_groups	GET /network-groups/	Get all network-groups' configuration.
retrieve_iceberg_notification_notification	GET /notification/	List all notification-names.
retrieve_iceberg_notification_notification_by_id	GET /notification/{notification_name}/	Get a notification's configuration.
retrieve_iceberg_notifications_notifications_by_id	GET /notifications/	Get all notifications' configuration.
retrieve_iceberg_playbook_playbook	GET /playbook/	List all playbook-names.
retrieve_iceberg_playbook_playbook_by_id	GET /playbook/{playbook_name}/	Get a playbook's configuration.
retrieve_iceberg_playbooks_playbooks_by_id	GET /playbooks/	Get all playbooks' configuration.
retrieve_iceberg_retention_policies_retention_policies_by_id	GET /retention-policies/	Get all retention-policies' configuration.
retrieve_iceberg_retention_policy_retention_policy	GET /retention-policy/	List all retention-policy-names.
retrieve_iceberg_retention_policy_retention_policy_by_id	GET /retention-policy/{retention_policy_name}/	Get a retention-policy's configuration.
retrieve_iceberg_system_destination_by_id	GET /system/report-generation/destination/{name}/	Retrieve destination by name
retrieve_iceberg_system_destinations	GET /system/report-generation/destinations/	Retrieve destinations by name
retrieve_iceberg_system_report_by_id	GET /system/report-generation/report/{name}/	Retrieve report by name
retrieve_iceberg_system_reports	GET /system/report-generation/reports/	Retrieve reports by name
retrieve_iceberg_system_scheduler_by_id	GET /system/scheduler/{name}/	Retrieve scheduler by name
retrieve_iceberg_system_schedulers	GET /system/schedulers/	Retrieve schedulers by name
retrieve_iceberg_system_settings_destination_by_id	GET /system-settings/report-generation/destination/{name}/	Retrieve destination by name
retrieve_iceberg_system_settings_destinations	GET /system-settings/report-generation/destinations/	Retrieve destinations by name
retrieve_iceberg_system_settings_report_by_id	GET /system-settings/report-generation/report/{name}/	Retrieve report by name
retrieve_iceberg_system_settings_reports	GET /system-settings/report-generation/reports/	Retrieve reports by name
retrieve_iceberg_system_settings_scheduler_by_id	GET /system-settings/scheduler/{name}/	Retrieve scheduler by name
retrieve_iceberg_system_settings_schedulers	GET /system-settings/schedulers/	Retrieve schedulers by name
retrieve_iceberg_system_settings_system_settings	GET /system-settings/	Retrieve system-settings
retrieve_iceberg_system_system	GET /system/	Retrieve system data
retrieve_iceberg_topic_rule_rule	GET /topic/{topic_name}/rule/	List all rule-names in a topic.
retrieve_iceberg_topic_rule_rule_by_id	GET /topic/{topic_name}/rule/{rule_name}/	Get a rule's configuration.
retrieve_iceberg_topic_topic	GET /topic/	List all topic-names.
retrieve_iceberg_topic_topic_by_id	GET /topic/{topic_name}/	Get a topic's configuration.
retrieve_iceberg_topics_topics	GET /topics/	Get all topics' configuration.
retrieve_network_group_status	GET /network-group/{network_group_name}/status/	Get network-group's status.
retrieve_orchestrator	GET /orchestrator/	Get Orchestrator type
rollback_unsaved_configuration	DELETE /configuration/	Delete the un-committed configuration.
update_iceberg_device_device_by_id	PUT /device/{device_id}/	Overwrite a device.
update_iceberg_device_group_device_group_by_id	PUT /device-group/{device_group_name}/	Overwrite a device-group.
update_iceberg_device_groups_device_groups_by_id	PUT /device-groups/	Overwrite device-groups.
update_iceberg_devices_devices_by_id	PUT /devices/	Overwrite devices.
update_iceberg_network_group_network_group_by_id	PUT /network-group/{network_group_name}/	Overwrite a network-group.
update_iceberg_network_groups_network_groups_by_id	PUT /network-groups/	Overwrite network-groups.
update_iceberg_notification_notification_by_id	PUT /notification/{notification_name}/	Overwrite a notification.
update_iceberg_notifications_notifications_by_id	PUT /notifications/	Overwrite notifications.
update_iceberg_playbook_playbook_by_id	PUT /playbook/{playbook_name}/	Overwrite a playbook.
update_iceberg_playbooks_playbooks_by_id	PUT /playbooks/	Overwrite all playbooks.
update_iceberg_retention_policies_retention_policies_id	PUT /retention-policies/	Overwrite all retention-policies.
update_iceberg_retention_policy_retention_policy_by_id	PUT /retention-policy/{retention_policy_name}/	Overwrite a retention-policy.
update_iceberg_system_destination_by_id	PUT /system/report-generation/destination/{name}/	Update destination by name
update_iceberg_system_destinations	PUT /system/report-generation/destinations/	Update destinations by name
update_iceberg_system_report_by_id	PUT /system/report-generation/report/{name}/	Update report by name
update_iceberg_system_reports	PUT /system/report-generation/reports/	Update reports by name
update_iceberg_system_scheduler_by_id	PUT /system/scheduler/{name}/	Update scheduler by name
update_iceberg_system_schedulers	PUT /system/schedulers/	Update schedulers by name
update_iceberg_system_settings_destination_by_id	PUT /system-settings/report-generation/destination/{name}/	Update destination by name
update_iceberg_system_settings_destinations	PUT /system-settings/report-generation/destinations/	Update destinations by name
update_iceberg_system_settings_report_by_id	PUT /system-settings/report-generation/report/{name}/	Update report by name
update_iceberg_system_settings_reports	PUT /system-settings/report-generation/reports/	Update reports by name
update_iceberg_system_settings_scheduler_by_id	PUT /system-settings/scheduler/{name}/	Update scheduler by name
update_iceberg_system_settings_schedulers	PUT /system-settings/schedulers/	Update schedulers by name
update_iceberg_system_settings_system_settings_by_id	PUT /system-settings/	Update system-settings by ID
update_iceberg_system_system_by_id	PUT /system/	Update system by ID
update_iceberg_topic_rule_rule_by_id	PUT /topic/{topic_name}/rule/{rule_name}/	Overwrite a rule.
update_iceberg_topic_topic_by_id	PUT /topic/{topic_name}/	Overwrite a topic.
update_iceberg_topics_topics_by_id	PUT /topics/	Overwrite topics.
user_retrieve_user_profile	GET /user-profile/	Get users profile information
user_update_user_profile	POST /user-profile/	Update user profile informations.

check_device_group_unsaved_configuration¶

check_device_group_unsaved_configuration(device_group_name, authorization=authorization)

Check if the un-committed configuration of the given device group is correct

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | Name of device group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Check if the un-committed configuration of the given device group is correct
    api_instance.check_device_group_unsaved_configuration(device_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->check_device_group_unsaved_configuration: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Name of device group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

check_network_group_unsaved_configuration¶

check_network_group_unsaved_configuration(network_group_name, authorization=authorization)

Check if the unsaved configuration of the given network group is correct.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | Name of network group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Check if the unsaved configuration of the given network group is correct.
    api_instance.check_network_group_unsaved_configuration(network_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->check_network_group_unsaved_configuration: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Name of network group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

commit_unsaved_configuration¶

commit_unsaved_configuration(authorization=authorization, sync=sync)

Commit unsaved configuration.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
sync = true # bool | Boolean variable is set to false allow the commit to go asynchronously, default value is true which means commit will go synchronously (optional) (default to true)

try:
    # Commit unsaved configuration.
    api_instance.commit_unsaved_configuration(authorization=authorization, sync=sync)
except ApiException as e:
    print("Exception when calling ConfigurationApi->commit_unsaved_configuration: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
sync	bool	Boolean variable is set to false allow the commit to go asynchronously, default value is true which means commit will go synchronously	[optional] [default to true]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_device_device_by_id¶

create_iceberg_device_device_by_id(device_id, device, authorization=authorization)

Update or create a device.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_id = 'device_id_example' # str | ID of device-id
device = swagger_client.DeviceSchema() # DeviceSchema | devicebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a device.
    api_instance.create_iceberg_device_device_by_id(device_id, device, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_device_device_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	ID of device-id
device	DeviceSchema	devicebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_device_group_device_group_by_id¶

create_iceberg_device_group_device_group_by_id(device_group_name, device_group, authorization=authorization)

Update or create a device-group.

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

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | ID of device-group-name
device_group = swagger_client.DeviceGroupSchema() # DeviceGroupSchema | device_groupbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a device-group.
    api_instance.create_iceberg_device_group_device_group_by_id(device_group_name, device_group, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_device_group_device_group_by_id: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	ID of device-group-name
device_group	DeviceGroupSchema	device_groupbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_device_groups_device_groups_by_id¶

create_iceberg_device_groups_device_groups_by_id(device_groups, authorization=authorization)

Update or create multiple device-groups.

Create/Update multiple device-groups. The new content for the existing device-groups updates the existing content and new device-groups are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_groups = swagger_client.DeviceGroupsSchema() # DeviceGroupsSchema | device-groupsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple device-groups.
    api_instance.create_iceberg_device_groups_device_groups_by_id(device_groups, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_device_groups_device_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
device_groups	DeviceGroupsSchema	device-groupsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_devices_devices_by_id¶

create_iceberg_devices_devices_by_id(devices, authorization=authorization)

Update or create multiple devices.

Create/Update multiple devices. The new content for the existing devices updates the existing content and the new devices are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
devices = swagger_client.DevicesSchema() # DevicesSchema | devicesbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple devices.
    api_instance.create_iceberg_devices_devices_by_id(devices, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_devices_devices_by_id: %s\n" % e)

Name	Type	Description	Notes
devices	DevicesSchema	devicesbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_network_group_network_group_by_id¶

create_iceberg_network_group_network_group_by_id(network_group_name, network_group, authorization=authorization)

Update or create a network-group.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | ID of network-group-name
network_group = swagger_client.NetworkGroupSchema() # NetworkGroupSchema | network_groupbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a network-group.
    api_instance.create_iceberg_network_group_network_group_by_id(network_group_name, network_group, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_network_group_network_group_by_id: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	ID of network-group-name
network_group	NetworkGroupSchema	network_groupbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_network_groups_network_groups_by_id¶

create_iceberg_network_groups_network_groups_by_id(network_groups, authorization=authorization)

Update or create multiple network-groups.

Create/Update multiple network-groups. The new content for the existing network-groups updates the existing content and the new network-groups are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_groups = swagger_client.NetworkGroupsSchema() # NetworkGroupsSchema | network-groupsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple network-groups.
    api_instance.create_iceberg_network_groups_network_groups_by_id(network_groups, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_network_groups_network_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
network_groups	NetworkGroupsSchema	network-groupsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_notification_notification_by_id¶

create_iceberg_notification_notification_by_id(notification_name, notification, authorization=authorization)

Update or create a notification

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notification_name = 'notification_name_example' # str | ID of notification-name
notification = swagger_client.NotificationSchema() # NotificationSchema | notificationbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a notification
    api_instance.create_iceberg_notification_notification_by_id(notification_name, notification, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_notification_notification_by_id: %s\n" % e)

Name	Type	Description	Notes
notification_name	str	ID of notification-name
notification	NotificationSchema	notificationbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_notifications_notifications_by_id¶

create_iceberg_notifications_notifications_by_id(notifications, authorization=authorization)

Update or create multiple notifications.

Create/Update multiple notifications. The new content for the existing notifications updates the existing content and the new notifications are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notifications = swagger_client.NotificationsSchema() # NotificationsSchema | notificationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple notifications.
    api_instance.create_iceberg_notifications_notifications_by_id(notifications, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_notifications_notifications_by_id: %s\n" % e)

Name	Type	Description	Notes
notifications	NotificationsSchema	notificationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_playbook_playbook_by_id¶

create_iceberg_playbook_playbook_by_id(playbook_name, playbook, authorization=authorization)

Update or create a playbook.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbook_name = 'playbook_name_example' # str | ID of playbook-name
playbook = swagger_client.PlaybookSchema() # PlaybookSchema | playbookbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a playbook.
    api_instance.create_iceberg_playbook_playbook_by_id(playbook_name, playbook, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_playbook_playbook_by_id: %s\n" % e)

Name	Type	Description	Notes
playbook_name	str	ID of playbook-name
playbook	PlaybookSchema	playbookbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_playbooks_playbooks_by_id¶

create_iceberg_playbooks_playbooks_by_id(playbooks, authorization=authorization)

Update or create multiple playbooks.

Create/Update multiple playbooks. The new content for the existing playbooks updates the existing content and the new playbooks are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbooks = swagger_client.PlaybooksSchema() # PlaybooksSchema | playbooksbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple playbooks.
    api_instance.create_iceberg_playbooks_playbooks_by_id(playbooks, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_playbooks_playbooks_by_id: %s\n" % e)

Name	Type	Description	Notes
playbooks	PlaybooksSchema	playbooksbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_retention_policies_retention_policies_by_id¶

create_iceberg_retention_policies_retention_policies_by_id(retention_policies, authorization=authorization)

Update or create multiple retention-policies.

Create/Update multiple retention-policies. The new content for the existing retention-policies update the existing content and the new retention-policies are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policies = swagger_client.RetentionPoliciesSchema() # RetentionPoliciesSchema | retention-policiesbody object object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple retention-policies.
    api_instance.create_iceberg_retention_policies_retention_policies_by_id(retention_policies, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_retention_policies_retention_policies_by_id: %s\n" % e)

Name	Type	Description	Notes
retention_policies	RetentionPoliciesSchema	retention-policiesbody object object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_retention_policy_retention_policy_by_id¶

create_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, retention_policy, authorization=authorization)

Update or create a retention-policy.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policy_name = 'retention_policy_name_example' # str | ID of retention-policy-name
retention_policy = swagger_client.RetentionPolicySchema() # RetentionPolicySchema | retention_policybody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a retention-policy.
    api_instance.create_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, retention_policy, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_retention_policy_retention_policy_by_id: %s\n" % e)

Name	Type	Description	Notes
retention_policy_name	str	ID of retention-policy-name
retention_policy	RetentionPolicySchema	retention_policybody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_destination_by_id¶

create_iceberg_system_destination_by_id(name, destination, authorization=authorization)

Create destination by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
destination = swagger_client.DestinationSchema() # DestinationSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create destination by name
    api_instance.create_iceberg_system_destination_by_id(name, destination, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
destination	DestinationSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_destinations¶

create_iceberg_system_destinations(destinations, authorization=authorization)

Create destinations by name

Create/Update multiple destinations. The new content for the existing destinations updates the existing content and the new destinations are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
destinations = swagger_client.DestinationsSchema() # DestinationsSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create destinations by name
    api_instance.create_iceberg_system_destinations(destinations, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_destinations: %s\n" % e)

Name	Type	Description	Notes
destinations	DestinationsSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_report_by_id¶

create_iceberg_system_report_by_id(name, report, authorization=authorization)

Create report by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
report = swagger_client.ReportSchema() # ReportSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create report by name
    api_instance.create_iceberg_system_report_by_id(name, report, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
report	ReportSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_reports¶

create_iceberg_system_reports(reports, authorization=authorization)

Create reports by name

Create/Update multiple reports. The new content for the existing reports updates the existing content and the new reports are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
reports = swagger_client.ReportsSchema() # ReportsSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create reports by name
    api_instance.create_iceberg_system_reports(reports, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_reports: %s\n" % e)

Name	Type	Description	Notes
reports	ReportsSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_scheduler_by_id¶

create_iceberg_system_scheduler_by_id(name, scheduler, authorization=authorization)

Create scheduler by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
scheduler = swagger_client.SchedulerSchema() # SchedulerSchema | schedulerbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create scheduler by name
    api_instance.create_iceberg_system_scheduler_by_id(name, scheduler, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
scheduler	SchedulerSchema	schedulerbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_schedulers¶

create_iceberg_system_schedulers(schedulers, authorization=authorization)

Create schedulers by name

Create/Update multiple schdeulers. The new content for the existing schedulers updates the existing content and the new schedulers are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
schedulers = swagger_client.SchedulersSchema() # SchedulersSchema | schedulersbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create schedulers by name
    api_instance.create_iceberg_system_schedulers(schedulers, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_schedulers: %s\n" % e)

Name	Type	Description	Notes
schedulers	SchedulersSchema	schedulersbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_destination_by_id¶

create_iceberg_system_settings_destination_by_id(name, destination, authorization=authorization)

Create destination by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
destination = swagger_client.DestinationSchema() # DestinationSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create destination by name
    api_instance.create_iceberg_system_settings_destination_by_id(name, destination, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
destination	DestinationSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_destinations¶

create_iceberg_system_settings_destinations(destinations, authorization=authorization)

Create destinations by name

Create/Update multiple destinations. The new content for the existing destinations updates the existing content and the new destinations are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
destinations = swagger_client.DestinationsSchema() # DestinationsSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create destinations by name
    api_instance.create_iceberg_system_settings_destinations(destinations, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_destinations: %s\n" % e)

Name	Type	Description	Notes
destinations	DestinationsSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_report_by_id¶

create_iceberg_system_settings_report_by_id(name, report, authorization=authorization)

Create report by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
report = swagger_client.ReportSchema() # ReportSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create report by name
    api_instance.create_iceberg_system_settings_report_by_id(name, report, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
report	ReportSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_reports¶

create_iceberg_system_settings_reports(reports, authorization=authorization)

Create reports by name

Create/Update multiple reports. The new content for the existing reports updates the existing content and the new reports are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
reports = swagger_client.ReportsSchema() # ReportsSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create reports by name
    api_instance.create_iceberg_system_settings_reports(reports, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_reports: %s\n" % e)

Name	Type	Description	Notes
reports	ReportsSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_scheduler_by_id¶

create_iceberg_system_settings_scheduler_by_id(name, scheduler, authorization=authorization)

Create scheduler by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
scheduler = swagger_client.SchedulerSchema() # SchedulerSchema | schedulerbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create scheduler by name
    api_instance.create_iceberg_system_settings_scheduler_by_id(name, scheduler, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
scheduler	SchedulerSchema	schedulerbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_schedulers¶

create_iceberg_system_settings_schedulers(schedulers, authorization=authorization)

Create schedulers by name

Create/Update multiple schdeulers. The new content for the existing schedulers updates the existing content and the new schedulers are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
schedulers = swagger_client.SchedulersSchema() # SchedulersSchema | schedulersbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create schedulers by name
    api_instance.create_iceberg_system_settings_schedulers(schedulers, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_schedulers: %s\n" % e)

Name	Type	Description	Notes
schedulers	SchedulersSchema	schedulersbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_settings_system_settings_by_id¶

create_iceberg_system_settings_system_settings_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)

Create system-settings

Create/Update system-settings to populate persis-raw-data, schedulers, destinations and reports.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
system_settings = swagger_client.SystemSettingsSchema() # SystemSettingsSchema | system_settings body object
authorization = 'authorization_example' # str | authentication header object (optional)
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Create system-settings
    api_instance.create_iceberg_system_settings_system_settings_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_settings_system_settings_by_id: %s\n" % e)

Name	Type	Description	Notes
system_settings	SystemSettingsSchema	system_settings body object
authorization	str	authentication header object	[optional]
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_system_system_by_id¶

create_iceberg_system_system_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)

Create system

Create/Update system to populate persist-raw-data, schedulers, destinations and reports.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
system_settings = swagger_client.SystemSettingsSchema() # SystemSettingsSchema | system_settings body object
authorization = 'authorization_example' # str | authentication header object (optional)
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Create system
    api_instance.create_iceberg_system_system_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_system_system_by_id: %s\n" % e)

Name	Type	Description	Notes
system_settings	SystemSettingsSchema	system_settings body object
authorization	str	authentication header object	[optional]
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_topic_rule_rule_by_id¶

create_iceberg_topic_rule_rule_by_id(topic_name, rule_name, rule, authorization=authorization)

Update or create a rule.

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

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
rule_name = 'rule_name_example' # str | ID of rule-name
rule = swagger_client.RuleSchema() # RuleSchema | rulebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a rule.
    api_instance.create_iceberg_topic_rule_rule_by_id(topic_name, rule_name, rule, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_topic_rule_rule_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
rule_name	str	ID of rule-name
rule	RuleSchema	rulebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_topic_topic_by_id¶

create_iceberg_topic_topic_by_id(topic_name, topic, authorization=authorization)

Update or create a topic.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
topic = swagger_client.TopicSchema() # TopicSchema | topicbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create a topic.
    api_instance.create_iceberg_topic_topic_by_id(topic_name, topic, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_topic_topic_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
topic	TopicSchema	topicbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_iceberg_topics_topics_by_id¶

create_iceberg_topics_topics_by_id(topics, authorization=authorization)

Update or create multiple topics.

Create/Update multiple topics. The new content for the existing topics updates the existing content and the new topics are created.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topics = swagger_client.TopicsSchema() # TopicsSchema | topicsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update or create multiple topics.
    api_instance.create_iceberg_topics_topics_by_id(topics, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->create_iceberg_topics_topics_by_id: %s\n" % e)

Name	Type	Description	Notes
topics	TopicsSchema	topicsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_healthbot_ingest_settings_byoi_ingest_mappings¶

delete_healthbot_ingest_settings_byoi_ingest_mappings(authorization=authorization)

Delete all ingest-mappings.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all ingest-mappings.
    api_instance.delete_healthbot_ingest_settings_byoi_ingest_mappings(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_healthbot_ingest_settings_byoi_ingest_mappings: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_device_device_by_id¶

delete_iceberg_device_device_by_id(device_id, authorization=authorization)

Delete device.

Delete a device by device-id. Delete will fail if the device is being referenced by a device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_id = 'device_id_example' # str | ID of device-id
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete device.
    api_instance.delete_iceberg_device_device_by_id(device_id, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_device_device_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	ID of device-id
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_device_group_device_group_by_id¶

delete_iceberg_device_group_device_group_by_id(device_group_name, authorization=authorization)

Delete device-group.

Delete a device-group by device-group-name. Delete will fail if the device-group’s services are running.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | ID of device-group-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete device-group.
    api_instance.delete_iceberg_device_group_device_group_by_id(device_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_device_group_device_group_by_id: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	ID of device-group-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_device_groups_device_groups_by_id¶

delete_iceberg_device_groups_device_groups_by_id(authorization=authorization)

Delete all device-groups.

Delete all device-groups. Delete fails if services are still running for the device groups.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all device-groups.
    api_instance.delete_iceberg_device_groups_device_groups_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_device_groups_device_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_devices_devices_by_id¶

delete_iceberg_devices_devices_by_id(authorization=authorization)

Delete all devices.

Delete all devices. This will fail if any device is referenced in any device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all devices.
    api_instance.delete_iceberg_devices_devices_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_devices_devices_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_network_group_network_group_by_id¶

delete_iceberg_network_group_network_group_by_id(network_group_name, authorization=authorization)

Delete network-group.

Delete a network-group by network-group-name. Delete will fail if the network-group’s services are running.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | ID of network-group-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete network-group.
    api_instance.delete_iceberg_network_group_network_group_by_id(network_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_network_group_network_group_by_id: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	ID of network-group-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_network_groups_network_groups_by_id¶

delete_iceberg_network_groups_network_groups_by_id(authorization=authorization)

Delete all network-groups.

Delete all network-groups. Delete will fail if services are still running for the network groups.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all network-groups.
    api_instance.delete_iceberg_network_groups_network_groups_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_network_groups_network_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_notification_notification_by_id¶

delete_iceberg_notification_notification_by_id(notification_name, authorization=authorization)

Delete a notification.

Delete a notification by notification-name. Delete will fail if the notification is referenced by a device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notification_name = 'notification_name_example' # str | ID of notification-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a notification.
    api_instance.delete_iceberg_notification_notification_by_id(notification_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_notification_notification_by_id: %s\n" % e)

Name	Type	Description	Notes
notification_name	str	ID of notification-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_notifications_notifications_by_id¶

delete_iceberg_notifications_notifications_by_id(authorization=authorization)

Delete all notifications.

Delete all notifications. This will fail if any notification is referenced in any device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all notifications.
    api_instance.delete_iceberg_notifications_notifications_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_notifications_notifications_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_playbook_playbook_by_id¶

delete_iceberg_playbook_playbook_by_id(playbook_name, authorization=authorization)

Delete a playbook.

Delete a playbook by playbook-name. Delete will fail if the playbook is referenced by a device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbook_name = 'playbook_name_example' # str | ID of playbook-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a playbook.
    api_instance.delete_iceberg_playbook_playbook_by_id(playbook_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_playbook_playbook_by_id: %s\n" % e)

Name	Type	Description	Notes
playbook_name	str	ID of playbook-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_playbooks_playbooks_by_id¶

delete_iceberg_playbooks_playbooks_by_id(authorization=authorization)

Delete all playbooks.

Delete all playbooks. This will fail if any playbook is referenced in any device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all playbooks.
    api_instance.delete_iceberg_playbooks_playbooks_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_playbooks_playbooks_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_retention_policies_retention_policies_by_id¶

delete_iceberg_retention_policies_retention_policies_by_id(authorization=authorization)

Delete all retention-policies.

Delete all the retention policies. This will fail if any retention-policy is referenced in any device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all retention-policies.
    api_instance.delete_iceberg_retention_policies_retention_policies_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_retention_policies_retention_policies_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_retention_policy_retention_policy_by_id¶

delete_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, authorization=authorization)

Delete a retention-policy.

Delete a retention-policy by retention-policy-name. Delete will fail if the retention-policy is referenced by a device-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policy_name = 'retention_policy_name_example' # str | ID of retention-policy-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a retention-policy.
    api_instance.delete_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_retention_policy_retention_policy_by_id: %s\n" % e)

Name	Type	Description	Notes
retention_policy_name	str	ID of retention-policy-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_destination_by_id¶

delete_iceberg_system_destination_by_id(name, authorization=authorization)

Delete destination by name

Delete a destination by name. Delete will fail if the destination is being referenced by a report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete destination by name
    api_instance.delete_iceberg_system_destination_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_destinations¶

delete_iceberg_system_destinations(authorization=authorization)

Delete destinations by name

Delete all destinations. This will fail if any destination is referenced in any report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete destinations by name
    api_instance.delete_iceberg_system_destinations(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_destinations: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_report_by_id¶

delete_iceberg_system_report_by_id(name, authorization=authorization)

Delete report by name

Delete a report by name. Delete will fail if the report is being referenced by a device-group or network-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete report by name
    api_instance.delete_iceberg_system_report_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_reports¶

delete_iceberg_system_reports(authorization=authorization)

Delete reports by name

Delete all reports. This will fail if any report is referenced in any device-group or network-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete reports by name
    api_instance.delete_iceberg_system_reports(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_reports: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_scheduler_by_id¶

delete_iceberg_system_scheduler_by_id(name, authorization=authorization)

Delete scheduler by name

Delete a scheduler by name. Delete will fail if the scheduler is being referenced by a report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete scheduler by name
    api_instance.delete_iceberg_system_scheduler_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_schedulers¶

delete_iceberg_system_schedulers(authorization=authorization)

Delete schedulers by name

Delete all schedulers. This will fail if any scheduler is referenced in any report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete schedulers by name
    api_instance.delete_iceberg_system_schedulers(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_schedulers: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_destination_by_id¶

delete_iceberg_system_settings_destination_by_id(name, authorization=authorization)

Delete destination by name

Delete a destination by name. Delete will fail if the destination is being referenced by a report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete destination by name
    api_instance.delete_iceberg_system_settings_destination_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_destinations¶

delete_iceberg_system_settings_destinations(authorization=authorization)

Delete destinations by name

Delete all destinations. This will fail if any destination is referenced in any report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete destinations by name
    api_instance.delete_iceberg_system_settings_destinations(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_destinations: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_report_by_id¶

delete_iceberg_system_settings_report_by_id(name, authorization=authorization)

Delete report by name

Delete a report by name. Delete will fail if the report is being referenced by a device-group or network-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete report by name
    api_instance.delete_iceberg_system_settings_report_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_reports¶

delete_iceberg_system_settings_reports(authorization=authorization)

Delete reports by name

Delete all reports. This will fail if any report is referenced in any device-group or network-group.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete reports by name
    api_instance.delete_iceberg_system_settings_reports(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_reports: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_scheduler_by_id¶

delete_iceberg_system_settings_scheduler_by_id(name, authorization=authorization)

Delete scheduler by name

Delete a scheduler by name. Delete will fail if the scheduler is being referenced by a report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete scheduler by name
    api_instance.delete_iceberg_system_settings_scheduler_by_id(name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_schedulers¶

delete_iceberg_system_settings_schedulers(authorization=authorization)

Delete schedulers by name

Delete all schedulers. This will fail if any scheduler is referenced in any report.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete schedulers by name
    api_instance.delete_iceberg_system_settings_schedulers(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_schedulers: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_settings_system_settings_by_id¶

delete_iceberg_system_settings_system_settings_by_id(authorization=authorization)

Delete system-settings

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete system-settings
    api_instance.delete_iceberg_system_settings_system_settings_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_settings_system_settings_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_system_system_by_id¶

delete_iceberg_system_system_by_id(authorization=authorization)

Delete system

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete system
    api_instance.delete_iceberg_system_system_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_system_system_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_topic_rule_rule_by_id¶

delete_iceberg_topic_rule_rule_by_id(topic_name, rule_name, authorization=authorization)

Delete a rule.

Delete a rule by rule-name. Delete will fail if the rule is referenced by any other playbook.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
rule_name = 'rule_name_example' # str | ID of rule-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a rule.
    api_instance.delete_iceberg_topic_rule_rule_by_id(topic_name, rule_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_topic_rule_rule_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
rule_name	str	ID of rule-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_topic_topic_by_id¶

delete_iceberg_topic_topic_by_id(topic_name, authorization=authorization)

Delete a topic.

Delete a topic by topic-name. Delete will fail if the topic is referenced by any other playbook.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a topic.
    api_instance.delete_iceberg_topic_topic_by_id(topic_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_topic_topic_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_topics_topics_by_id¶

delete_iceberg_topics_topics_by_id(authorization=authorization)

Delete all topics.

Delete all topics. This will fail if any topic is referenced in any playbook.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all topics.
    api_instance.delete_iceberg_topics_topics_by_id(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->delete_iceberg_topics_topics_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

first_login¶

first_login(authorization, password)

Change password after first login

Change password in first login

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object
password = swagger_client.Password() # Password | set new password

try:
    # Change password after first login
    api_instance.first_login(authorization, password)
except ApiException as e:
    print("Exception when calling ConfigurationApi->first_login: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
password	Password	set new password

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_affected_groups¶

AffectedGroups retrieve_affected_groups(authorization=authorization)

Get all groups affected by un-committed configuration changes.

Get all groups that are affected by the un-committed configuration changes.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get all groups affected by un-committed configuration changes.
    api_response = api_instance.retrieve_affected_groups(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_affected_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

**AffectedGroups**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_device_group_status¶

ServiceStatus retrieve_device_group_status(device_group_name, authorization=authorization)

Get device-group’s status.

Get information about the status of a device-group’s services.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | Name of device-group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get device-group's status.
    api_response = api_instance.retrieve_device_group_status(device_group_name, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_device_group_status: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Name of device-group
authorization	str	authentication header object	[optional]

**ServiceStatus**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_device_device¶

list[str] retrieve_iceberg_device_device(authorization=authorization, working=working)

List all device-ids.

Get a list of all the device IDs.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all device-ids.
    api_response = api_instance.retrieve_iceberg_device_device(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_device_device: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_device_device_by_id¶

DeviceSchema retrieve_iceberg_device_device_by_id(device_id, authorization=authorization, working=working)

Get a device’s configuration.

Get the configuration details of a device by its device-id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_id = 'device_id_example' # str | ID of device-id
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a device's configuration.
    api_response = api_instance.retrieve_iceberg_device_device_by_id(device_id, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_device_device_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	ID of device-id
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**DeviceSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_device_group_device_group¶

list[str] retrieve_iceberg_device_group_device_group(authorization=authorization, working=working)

List all device-group names.

Get a list of all the device-group names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all device-group names.
    api_response = api_instance.retrieve_iceberg_device_group_device_group(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_device_group_device_group: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_device_group_device_group_by_id¶

DeviceGroupSchema retrieve_iceberg_device_group_device_group_by_id(device_group_name, authorization=authorization, working=working)

Get device-group’s configuration.

Get configuration details of a device group by the device group name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | ID of device-group-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get device-group's configuration.
    api_response = api_instance.retrieve_iceberg_device_group_device_group_by_id(device_group_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_device_group_device_group_by_id: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	ID of device-group-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**DeviceGroupSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_device_groups_device_groups¶

DeviceGroupsSchema retrieve_iceberg_device_groups_device_groups(authorization=authorization, working=working)

Get all device-groups’ configuration.

Get configuration details of all the device-groups.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all device-groups' configuration.
    api_response = api_instance.retrieve_iceberg_device_groups_device_groups(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_device_groups_device_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**DeviceGroupsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_devices_devices¶

DevicesSchema retrieve_iceberg_devices_devices(authorization=authorization, working=working)

Get all devices’ configuration.

Get the configuration details of all devices.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all devices' configuration.
    api_response = api_instance.retrieve_iceberg_devices_devices(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_devices_devices: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**DevicesSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_network_group_network_group¶

list[str] retrieve_iceberg_network_group_network_group(authorization=authorization, working=working)

List all network-group names.

Get a list of all the network-group-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all network-group names.
    api_response = api_instance.retrieve_iceberg_network_group_network_group(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_network_group_network_group: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_network_group_network_group_by_id¶

NetworkGroupSchema retrieve_iceberg_network_group_network_group_by_id(network_group_name, authorization=authorization, working=working)

Get network-group’s configuration.

Get the configuration details of a network group by its network group name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | ID of network-group-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get network-group's configuration.
    api_response = api_instance.retrieve_iceberg_network_group_network_group_by_id(network_group_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_network_group_network_group_by_id: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	ID of network-group-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**NetworkGroupSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_network_groups_network_groups¶

NetworkGroupsSchema retrieve_iceberg_network_groups_network_groups(authorization=authorization, working=working)

Get all network-groups’ configuration.

Get configuration of all network-groups.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all network-groups' configuration.
    api_response = api_instance.retrieve_iceberg_network_groups_network_groups(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_network_groups_network_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**NetworkGroupsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_notification_notification¶

list[str] retrieve_iceberg_notification_notification(authorization=authorization, working=working)

List all notification-names.

Get a list of all the notification-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all notification-names.
    api_response = api_instance.retrieve_iceberg_notification_notification(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_notification_notification: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_notification_notification_by_id¶

NotificationSchema retrieve_iceberg_notification_notification_by_id(notification_name, authorization=authorization, working=working)

Get a notification’s configuration.

Get the configuration details of a notification by notification-name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notification_name = 'notification_name_example' # str | ID of notification-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a notification's configuration.
    api_response = api_instance.retrieve_iceberg_notification_notification_by_id(notification_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_notification_notification_by_id: %s\n" % e)

Name	Type	Description	Notes
notification_name	str	ID of notification-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**NotificationSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_notifications_notifications_by_id¶

NotificationsSchema retrieve_iceberg_notifications_notifications_by_id(authorization=authorization, working=working)

Get all notifications’ configuration.

Get the configuration details of all notifications.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all notifications' configuration.
    api_response = api_instance.retrieve_iceberg_notifications_notifications_by_id(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_notifications_notifications_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**NotificationsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_playbook_playbook¶

list[str] retrieve_iceberg_playbook_playbook(authorization=authorization, working=working)

List all playbook-names.

Get a list of all the playbook-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all playbook-names.
    api_response = api_instance.retrieve_iceberg_playbook_playbook(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_playbook_playbook: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_playbook_playbook_by_id¶

PlaybookSchema retrieve_iceberg_playbook_playbook_by_id(playbook_name, authorization=authorization, working=working)

Get a playbook’s configuration.

Get the configuration details of a playbook by playbook-name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbook_name = 'playbook_name_example' # str | ID of playbook-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a playbook's configuration.
    api_response = api_instance.retrieve_iceberg_playbook_playbook_by_id(playbook_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_playbook_playbook_by_id: %s\n" % e)

Name	Type	Description	Notes
playbook_name	str	ID of playbook-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**PlaybookSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_playbooks_playbooks_by_id¶

PlaybooksSchema retrieve_iceberg_playbooks_playbooks_by_id(authorization=authorization, working=working)

Get all playbooks’ configuration.

Get the configuration of all playbooks.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all playbooks' configuration.
    api_response = api_instance.retrieve_iceberg_playbooks_playbooks_by_id(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_playbooks_playbooks_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**PlaybooksSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_retention_policies_retention_policies_by_id¶

RetentionPoliciesSchema retrieve_iceberg_retention_policies_retention_policies_by_id(authorization=authorization, working=working)

Get all retention-policies’ configuration.

Get the configuration of all the retention-policies.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get all retention-policies' configuration.
    api_response = api_instance.retrieve_iceberg_retention_policies_retention_policies_by_id(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_retention_policies_retention_policies_by_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**RetentionPoliciesSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_retention_policy_retention_policy¶

list[str] retrieve_iceberg_retention_policy_retention_policy(authorization=authorization, working=working)

List all retention-policy-names.

Get a list of all the retention-policy-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all retention-policy-names.
    api_response = api_instance.retrieve_iceberg_retention_policy_retention_policy(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_retention_policy_retention_policy: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_retention_policy_retention_policy_by_id¶

RetentionPolicySchema retrieve_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, authorization=authorization, working=working)

Get a retention-policy’s configuration.

Get the configuration details of a retention policy by retention-policy-name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policy_name = 'retention_policy_name_example' # str | ID of retention-policy-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a retention-policy's configuration.
    api_response = api_instance.retrieve_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_retention_policy_retention_policy_by_id: %s\n" % e)

Name	Type	Description	Notes
retention_policy_name	str	ID of retention-policy-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**RetentionPolicySchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_destination_by_id¶

DestinationSchema retrieve_iceberg_system_destination_by_id(name, authorization=authorization, working=working)

Retrieve destination by name

Get the configuration details of a destination by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve destination by name
    api_response = api_instance.retrieve_iceberg_system_destination_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**DestinationSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_destinations¶

DestinationsSchema retrieve_iceberg_system_destinations(authorization=authorization, working=working)

Retrieve destinations by name

Get the configuration details of all destinations.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve destinations by name
    api_response = api_instance.retrieve_iceberg_system_destinations(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_destinations: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**DestinationsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_report_by_id¶

ReportSchema retrieve_iceberg_system_report_by_id(name, authorization=authorization, working=working)

Retrieve report by name

Get the configuration details of a report by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve report by name
    api_response = api_instance.retrieve_iceberg_system_report_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**ReportSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_reports¶

ReportsSchema retrieve_iceberg_system_reports(authorization=authorization, working=working)

Retrieve reports by name

Get the configuration details of all reports.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve reports by name
    api_response = api_instance.retrieve_iceberg_system_reports(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_reports: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**ReportsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_scheduler_by_id¶

SchedulerSchema retrieve_iceberg_system_scheduler_by_id(name, authorization=authorization, working=working)

Retrieve scheduler by name

Get the configuration details of a scheduler by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve scheduler by name
    api_response = api_instance.retrieve_iceberg_system_scheduler_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SchedulerSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_schedulers¶

SchedulersSchema retrieve_iceberg_system_schedulers(authorization=authorization, working=working)

Retrieve schedulers by name

Get the configuration details of all schedulers.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve schedulers by name
    api_response = api_instance.retrieve_iceberg_system_schedulers(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_schedulers: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SchedulersSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_destination_by_id¶

DestinationSchema retrieve_iceberg_system_settings_destination_by_id(name, authorization=authorization, working=working)

Retrieve destination by name

Get the configuration details of a destination by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve destination by name
    api_response = api_instance.retrieve_iceberg_system_settings_destination_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**DestinationSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_destinations¶

DestinationsSchema retrieve_iceberg_system_settings_destinations(authorization=authorization, working=working)

Retrieve destinations by name

Get the configuration details of all destinations.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve destinations by name
    api_response = api_instance.retrieve_iceberg_system_settings_destinations(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_destinations: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**DestinationsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_report_by_id¶

ReportSchema retrieve_iceberg_system_settings_report_by_id(name, authorization=authorization, working=working)

Retrieve report by name

Get the configuration details of a report by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve report by name
    api_response = api_instance.retrieve_iceberg_system_settings_report_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**ReportSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_reports¶

ReportsSchema retrieve_iceberg_system_settings_reports(authorization=authorization, working=working)

Retrieve reports by name

Get the configuration details of all reports.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve reports by name
    api_response = api_instance.retrieve_iceberg_system_settings_reports(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_reports: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**ReportsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_scheduler_by_id¶

SchedulerSchema retrieve_iceberg_system_settings_scheduler_by_id(name, authorization=authorization, working=working)

Retrieve scheduler by name

Get the configuration details of a scheduler by its name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve scheduler by name
    api_response = api_instance.retrieve_iceberg_system_settings_scheduler_by_id(name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SchedulerSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_schedulers¶

SchedulersSchema retrieve_iceberg_system_settings_schedulers(authorization=authorization, working=working)

Retrieve schedulers by name

Get the configuration details of all schedulers.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve schedulers by name
    api_response = api_instance.retrieve_iceberg_system_settings_schedulers(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_schedulers: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SchedulersSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_settings_system_settings¶

SystemSettingsSchema retrieve_iceberg_system_settings_system_settings(authorization=authorization, working=working)

Retrieve system-settings

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve system-settings
    api_response = api_instance.retrieve_iceberg_system_settings_system_settings(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_settings_system_settings: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SystemSettingsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_system_system¶

SystemSettingsSchema retrieve_iceberg_system_system(authorization=authorization, working=working)

Retrieve system data

Retrieve system details

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries undeployed configuration (optional)

try:
    # Retrieve system data
    api_response = api_instance.retrieve_iceberg_system_system(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_system_system: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries undeployed configuration	[optional]

**SystemSettingsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_topic_rule_rule¶

list[str] retrieve_iceberg_topic_rule_rule(topic_name, authorization=authorization, working=working, action=action)

List all rule-names in a topic.

Get a list of all the rule-names in a topic.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)
action = 'action_example' # str | Action to be performed (optional)

try:
    # List all rule-names in a topic.
    api_response = api_instance.retrieve_iceberg_topic_rule_rule(topic_name, authorization=authorization, working=working, action=action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_topic_rule_rule: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]
action	str	Action to be performed	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_topic_rule_rule_by_id¶

RuleSchema retrieve_iceberg_topic_rule_rule_by_id(topic_name, rule_name, authorization=authorization, working=working)

Get a rule’s configuration.

Get the configuration details of a rule by rule-name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
rule_name = 'rule_name_example' # str | ID of rule-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a rule's configuration.
    api_response = api_instance.retrieve_iceberg_topic_rule_rule_by_id(topic_name, rule_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_topic_rule_rule_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
rule_name	str	ID of rule-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**RuleSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_topic_topic¶

list[str] retrieve_iceberg_topic_topic(authorization=authorization, working=working)

List all topic-names.

Get a list of all the topic-names.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # List all topic-names.
    api_response = api_instance.retrieve_iceberg_topic_topic(authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_topic_topic: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_topic_topic_by_id¶

TopicSchema retrieve_iceberg_topic_topic_by_id(topic_name, authorization=authorization, working=working)

Get a topic’s configuration.

Get the configuration details of a topic by the topic-name.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)

try:
    # Get a topic's configuration.
    api_response = api_instance.retrieve_iceberg_topic_topic_by_id(topic_name, authorization=authorization, working=working)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_topic_topic_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]

**TopicSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_topics_topics¶

TopicsSchema retrieve_iceberg_topics_topics(authorization=authorization, working=working, sort=sort)

Get all topics’ configuration.

Get the configuration details of all topics.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)
sort = 'sort_example' # str | asc/desc queries sorted configuration (optional)

try:
    # Get all topics' configuration.
    api_response = api_instance.retrieve_iceberg_topics_topics(authorization=authorization, working=working, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_iceberg_topics_topics: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]
sort	str	asc/desc queries sorted configuration	[optional]

**TopicsSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_network_group_status¶

ServiceStatus retrieve_network_group_status(network_group_name, authorization=authorization)

Get network-group’s status.

Get information about the status of a network-group’s services.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | Name of network-group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get network-group's status.
    api_response = api_instance.retrieve_network_group_status(network_group_name, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_network_group_status: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	Name of network-group
authorization	str	authentication header object	[optional]

**ServiceStatus**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_orchestrator¶

retrieve_orchestrator(authorization=authorization)

Get Orchestrator type

Get orchestrator type. Will be one of kubernetes or compose.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get Orchestrator type
    api_instance.retrieve_orchestrator(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->retrieve_orchestrator: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rollback_unsaved_configuration¶

rollback_unsaved_configuration(authorization=authorization)

Delete the un-committed configuration.

The API server follows a commit model. Unsaved configuration is called a working configuration. This API call deletes the working configuration.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete the un-committed configuration.
    api_instance.rollback_unsaved_configuration(authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->rollback_unsaved_configuration: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_device_device_by_id¶

update_iceberg_device_device_by_id(device_id, device, authorization=authorization)

Overwrite a device.

Overwrite a device by device ID. The device ID specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_id = 'device_id_example' # str | ID of device-id
device = swagger_client.DeviceSchema() # DeviceSchema | devicebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a device.
    api_instance.update_iceberg_device_device_by_id(device_id, device, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_device_device_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	ID of device-id
device	DeviceSchema	devicebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_device_group_device_group_by_id¶

update_iceberg_device_group_device_group_by_id(device_group_name, device_group, authorization=authorization)

Overwrite a device-group.

Overwrite a device-group by its device-group-name. The device-group-name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_group_name = 'device_group_name_example' # str | ID of device-group-name
device_group = swagger_client.DeviceGroupSchema() # DeviceGroupSchema | device_groupbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a device-group.
    api_instance.update_iceberg_device_group_device_group_by_id(device_group_name, device_group, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_device_group_device_group_by_id: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	ID of device-group-name
device_group	DeviceGroupSchema	device_groupbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_device_groups_device_groups_by_id¶

update_iceberg_device_groups_device_groups_by_id(device_groups, authorization=authorization)

Overwrite device-groups.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
device_groups = swagger_client.DeviceGroupsSchema() # DeviceGroupsSchema | device-groupsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite device-groups.
    api_instance.update_iceberg_device_groups_device_groups_by_id(device_groups, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_device_groups_device_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
device_groups	DeviceGroupsSchema	device-groupsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_devices_devices_by_id¶

update_iceberg_devices_devices_by_id(devices, authorization=authorization)

Overwrite devices.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
devices = swagger_client.DevicesSchema() # DevicesSchema | devicesbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite devices.
    api_instance.update_iceberg_devices_devices_by_id(devices, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_devices_devices_by_id: %s\n" % e)

Name	Type	Description	Notes
devices	DevicesSchema	devicesbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_network_group_network_group_by_id¶

update_iceberg_network_group_network_group_by_id(network_group_name, network_group, authorization=authorization)

Overwrite a network-group.

Overwrite a network-group by the network-group-name. The network-group-name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_group_name = 'network_group_name_example' # str | ID of network-group-name
network_group = swagger_client.NetworkGroupSchema() # NetworkGroupSchema | network_groupbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a network-group.
    api_instance.update_iceberg_network_group_network_group_by_id(network_group_name, network_group, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_network_group_network_group_by_id: %s\n" % e)

Name	Type	Description	Notes
network_group_name	str	ID of network-group-name
network_group	NetworkGroupSchema	network_groupbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_network_groups_network_groups_by_id¶

update_iceberg_network_groups_network_groups_by_id(network_groups, authorization=authorization)

Overwrite network-groups.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
network_groups = swagger_client.NetworkGroupsSchema() # NetworkGroupsSchema | network-groupsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite network-groups.
    api_instance.update_iceberg_network_groups_network_groups_by_id(network_groups, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_network_groups_network_groups_by_id: %s\n" % e)

Name	Type	Description	Notes
network_groups	NetworkGroupsSchema	network-groupsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_notification_notification_by_id¶

update_iceberg_notification_notification_by_id(notification_name, notification, authorization=authorization)

Overwrite a notification.

Overwrite a notification by the notification-name. The notification-name specified in URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notification_name = 'notification_name_example' # str | ID of notification-name
notification = swagger_client.NotificationSchema() # NotificationSchema | notificationbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a notification.
    api_instance.update_iceberg_notification_notification_by_id(notification_name, notification, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_notification_notification_by_id: %s\n" % e)

Name	Type	Description	Notes
notification_name	str	ID of notification-name
notification	NotificationSchema	notificationbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_notifications_notifications_by_id¶

update_iceberg_notifications_notifications_by_id(notifications, authorization=authorization)

Overwrite notifications.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
notifications = swagger_client.NotificationsSchema() # NotificationsSchema | notificationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite notifications.
    api_instance.update_iceberg_notifications_notifications_by_id(notifications, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_notifications_notifications_by_id: %s\n" % e)

Name	Type	Description	Notes
notifications	NotificationsSchema	notificationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_playbook_playbook_by_id¶

update_iceberg_playbook_playbook_by_id(playbook_name, playbook, authorization=authorization)

Overwrite a playbook.

Overwrite a playbook by the playbook-name. The playbook-name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbook_name = 'playbook_name_example' # str | ID of playbook-name
playbook = swagger_client.PlaybookSchema() # PlaybookSchema | playbookbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a playbook.
    api_instance.update_iceberg_playbook_playbook_by_id(playbook_name, playbook, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_playbook_playbook_by_id: %s\n" % e)

Name	Type	Description	Notes
playbook_name	str	ID of playbook-name
playbook	PlaybookSchema	playbookbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_playbooks_playbooks_by_id¶

update_iceberg_playbooks_playbooks_by_id(playbooks, authorization=authorization)

Overwrite all playbooks.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
playbooks = swagger_client.PlaybooksSchema() # PlaybooksSchema | playbooksbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite all playbooks.
    api_instance.update_iceberg_playbooks_playbooks_by_id(playbooks, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_playbooks_playbooks_by_id: %s\n" % e)

Name	Type	Description	Notes
playbooks	PlaybooksSchema	playbooksbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_retention_policies_retention_policies_id¶

update_iceberg_retention_policies_retention_policies_id(retention_policies, authorization=authorization)

Overwrite all retention-policies.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policies = swagger_client.RetentionPoliciesSchema() # RetentionPoliciesSchema | retention-policies body object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite all retention-policies.
    api_instance.update_iceberg_retention_policies_retention_policies_id(retention_policies, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_retention_policies_retention_policies_id: %s\n" % e)

Name	Type	Description	Notes
retention_policies	RetentionPoliciesSchema	retention-policies body object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_retention_policy_retention_policy_by_id¶

update_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, retention_policy, authorization=authorization)

Overwrite a retention-policy.

Overwrite a retention-policy by the retention-policy-name. The retention-policy-name specified in URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
retention_policy_name = 'retention_policy_name_example' # str | ID of retention-policy-name
retention_policy = swagger_client.RetentionPolicySchema() # RetentionPolicySchema | retention_policybody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a retention-policy.
    api_instance.update_iceberg_retention_policy_retention_policy_by_id(retention_policy_name, retention_policy, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_retention_policy_retention_policy_by_id: %s\n" % e)

Name	Type	Description	Notes
retention_policy_name	str	ID of retention-policy-name
retention_policy	RetentionPolicySchema	retention_policybody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_destination_by_id¶

update_iceberg_system_destination_by_id(name, destination, authorization=authorization)

Update destination by name

Overwrite a destination by destination name. The destination name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
destination = swagger_client.DestinationSchema() # DestinationSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update destination by name
    api_instance.update_iceberg_system_destination_by_id(name, destination, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
destination	DestinationSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_destinations¶

update_iceberg_system_destinations(destinations, authorization=authorization)

Update destinations by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
destinations = swagger_client.DestinationsSchema() # DestinationsSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update destinations by name
    api_instance.update_iceberg_system_destinations(destinations, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_destinations: %s\n" % e)

Name	Type	Description	Notes
destinations	DestinationsSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_report_by_id¶

update_iceberg_system_report_by_id(name, report, authorization=authorization)

Update report by name

Overwrite a report by report name. The report name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
report = swagger_client.ReportSchema() # ReportSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update report by name
    api_instance.update_iceberg_system_report_by_id(name, report, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
report	ReportSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_reports¶

update_iceberg_system_reports(reports, authorization=authorization)

Update reports by name

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
reports = swagger_client.ReportsSchema() # ReportsSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update reports by name
    api_instance.update_iceberg_system_reports(reports, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_reports: %s\n" % e)

Name	Type	Description	Notes
reports	ReportsSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_scheduler_by_id¶

update_iceberg_system_scheduler_by_id(name, scheduler, authorization=authorization)

Update scheduler by name

Overwrite a scheduler by scheduler name. The scheduler name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
scheduler = swagger_client.SchedulerSchema() # SchedulerSchema | schedulerbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update scheduler by name
    api_instance.update_iceberg_system_scheduler_by_id(name, scheduler, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
scheduler	SchedulerSchema	schedulerbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_schedulers¶

update_iceberg_system_schedulers(schedulers, authorization=authorization)

Update schedulers by name

Update operation of resource: schedulers

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
schedulers = swagger_client.SchedulersSchema() # SchedulersSchema | schedulersbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update schedulers by name
    api_instance.update_iceberg_system_schedulers(schedulers, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_schedulers: %s\n" % e)

Name	Type	Description	Notes
schedulers	SchedulersSchema	schedulersbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_destination_by_id¶

update_iceberg_system_settings_destination_by_id(name, destination, authorization=authorization)

Update destination by name

Overwrite a destination by destination name. The destination name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of destination
destination = swagger_client.DestinationSchema() # DestinationSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update destination by name
    api_instance.update_iceberg_system_settings_destination_by_id(name, destination, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_destination_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of destination
destination	DestinationSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_destinations¶

update_iceberg_system_settings_destinations(destinations, authorization=authorization)

Update destinations by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
destinations = swagger_client.DestinationsSchema() # DestinationsSchema | destinationsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update destinations by name
    api_instance.update_iceberg_system_settings_destinations(destinations, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_destinations: %s\n" % e)

Name	Type	Description	Notes
destinations	DestinationsSchema	destinationsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_report_by_id¶

update_iceberg_system_settings_report_by_id(name, report, authorization=authorization)

Update report by name

Overwrite a report by report name. The report name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of report
report = swagger_client.ReportSchema() # ReportSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update report by name
    api_instance.update_iceberg_system_settings_report_by_id(name, report, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_report_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of report
report	ReportSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_reports¶

update_iceberg_system_settings_reports(reports, authorization=authorization)

Update reports by name

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
reports = swagger_client.ReportsSchema() # ReportsSchema | reportsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update reports by name
    api_instance.update_iceberg_system_settings_reports(reports, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_reports: %s\n" % e)

Name	Type	Description	Notes
reports	ReportsSchema	reportsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_scheduler_by_id¶

update_iceberg_system_settings_scheduler_by_id(name, scheduler, authorization=authorization)

Update scheduler by name

Overwrite a scheduler by scheduler name. The scheduler name specified in the URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
name = 'name_example' # str | Name of Scheduler
scheduler = swagger_client.SchedulerSchema() # SchedulerSchema | schedulerbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update scheduler by name
    api_instance.update_iceberg_system_settings_scheduler_by_id(name, scheduler, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_scheduler_by_id: %s\n" % e)

Name	Type	Description	Notes
name	str	Name of Scheduler
scheduler	SchedulerSchema	schedulerbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_schedulers¶

update_iceberg_system_settings_schedulers(schedulers, authorization=authorization)

Update schedulers by name

Update operation of resource: schedulers

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
schedulers = swagger_client.SchedulersSchema() # SchedulersSchema | schedulersbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update schedulers by name
    api_instance.update_iceberg_system_settings_schedulers(schedulers, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_schedulers: %s\n" % e)

Name	Type	Description	Notes
schedulers	SchedulersSchema	schedulersbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_settings_system_settings_by_id¶

update_iceberg_system_settings_system_settings_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)

Update system-settings by ID

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
system_settings = swagger_client.SystemSettingsSchema() # SystemSettingsSchema | system_settingsbody object
authorization = 'authorization_example' # str | authentication header object (optional)
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Update system-settings by ID
    api_instance.update_iceberg_system_settings_system_settings_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_settings_system_settings_by_id: %s\n" % e)

Name	Type	Description	Notes
system_settings	SystemSettingsSchema	system_settingsbody object
authorization	str	authentication header object	[optional]
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_system_system_by_id¶

update_iceberg_system_system_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)

Update system by ID

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
system_settings = swagger_client.SystemSettingsSchema() # SystemSettingsSchema | system_settings body object
authorization = 'authorization_example' # str | authentication header object (optional)
force_tsdb = false # bool | force update tsdb when force is set to True (optional) (default to false)

try:
    # Update system by ID
    api_instance.update_iceberg_system_system_by_id(system_settings, authorization=authorization, force_tsdb=force_tsdb)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_system_system_by_id: %s\n" % e)

Name	Type	Description	Notes
system_settings	SystemSettingsSchema	system_settings body object
authorization	str	authentication header object	[optional]
force_tsdb	bool	force update tsdb when force is set to True	[optional] [default to false]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_topic_rule_rule_by_id¶

update_iceberg_topic_rule_rule_by_id(topic_name, rule_name, rule, authorization=authorization)

Overwrite a rule.

Overwrite a rule by the rule-name. The rule-name specified in URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
rule_name = 'rule_name_example' # str | ID of rule-name
rule = swagger_client.RuleSchema() # RuleSchema | rulebody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a rule.
    api_instance.update_iceberg_topic_rule_rule_by_id(topic_name, rule_name, rule, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_topic_rule_rule_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
rule_name	str	ID of rule-name
rule	RuleSchema	rulebody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_topic_topic_by_id¶

update_iceberg_topic_topic_by_id(topic_name, topic, authorization=authorization)

Overwrite a topic.

Overwrite a topic by the topic-name. The topic-name specified in URL and the request body must match.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topic_name = 'topic_name_example' # str | ID of topic-name
topic = swagger_client.TopicSchema() # TopicSchema | topicbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite a topic.
    api_instance.update_iceberg_topic_topic_by_id(topic_name, topic, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_topic_topic_by_id: %s\n" % e)

Name	Type	Description	Notes
topic_name	str	ID of topic-name
topic	TopicSchema	topicbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_topics_topics_by_id¶

update_iceberg_topics_topics_by_id(topics, authorization=authorization)

Overwrite topics.

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.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
topics = swagger_client.TopicsSchema() # TopicsSchema | topicsbody object
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Overwrite topics.
    api_instance.update_iceberg_topics_topics_by_id(topics, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConfigurationApi->update_iceberg_topics_topics_by_id: %s\n" % e)

Name	Type	Description	Notes
topics	TopicsSchema	topicsbody object
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_retrieve_user_profile¶

InlineResponse2005 user_retrieve_user_profile(authorization)

Get users profile information

Get user profile

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object

try:
    # Get users profile information
    api_response = api_instance.user_retrieve_user_profile(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->user_retrieve_user_profile: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object

**InlineResponse2005**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_update_user_profile¶

list[InlineResponse2003] user_update_user_profile(authorization, user)

Update user profile informations.

Update user profile in the system

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConfigurationApi()
authorization = 'authorization_example' # str | authentication header object
user = swagger_client.User1() # User1 | topics body object

try:
    # Update user profile informations.
    api_response = api_instance.user_update_user_profile(authorization, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->user_update_user_profile: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
user	User1	topics body object

**list[InlineResponse2003]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Event¶

Properties¶

Name	Type	Description	Notes
color	str	Event severity	[optional]
event_name	str	Event name	[optional]
frequency	int	Frequency of the event.	[optional]
timestamp	datetime		[optional]

[Back to Model list] [Back to API list] [Back to README]

TableSchema¶

Properties¶

Name	Type	Description	Notes
name	str	Name of the table
type	str
db_name	str	Database name in which the measurement is present.	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSyslogPatternset¶

Properties¶

Name	Type	Description	Notes
description	str	Pattern-set description	[optional]
name	str	Name of a pattern-set. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
pattern_names	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

InstancesScheduleStateSchema¶

Properties¶

Name	Type	Description	Notes
instance	list[InstanceScheduleStateSchema]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaSyslog¶

Properties¶

Name	Type	Description	Notes
pattern_set	str	Pattern-set applicable for this sensor
maximum_hold_period	str	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	[optional] [default to ‘1s’]

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaOpenconfig¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

RefreshToken¶

Properties¶

Name	Type	Description	Notes
token	str	Refresh token	[optional]

[Back to Model list] [Back to API list] [Back to README]

ReportGenerationSchema¶

Properties¶

Name	Type	Description	Notes
destination	list[DestinationSchema]		[optional]
report	list[ReportSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

SchedulerSchemaRunfor¶

Properties¶

Name	Type	Description	Notes
days	int	Duration of time in days	[optional]
hours	int	Duration of time in hours	[optional]
minutes	int	Duration of time in minutes	[optional]

[Back to Model list] [Back to API list] [Back to README]

User¶

Properties¶

Name	Type	Description	Notes
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]
password	str	Password of the user	[optional]
active	bool	Status of the user	[optional]
groups	AssociatedGroupSchema		[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the notification	[optional]
http_post	NotificationSchemaHttppost		[optional]
notification_name	str	Name of the notification. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
slack	NotificationSchemaSlack		[optional]
microsoft_teams	NotificationSchemaMicrosoftteams		[optional]
emails	NotificationSchemaEmails		[optional]
kafka_publish	NotificationSchemaKafkapublish		[optional]

[Back to Model list] [Back to API list] [Back to README]

SchedulerSchema¶

Properties¶

Name	Type	Description	Notes
end_time	str	End scheduler at this time	[optional]
name	str	Name of the scheduler
repeat	SchedulerSchemaRepeat
start_time	str	Start scheduler at this time
run_for	SchedulerSchemaRunfor		[optional]
type	str	Type of the scheduler.	[optional] [default to ‘continuous’]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaHttppostBasic¶

Properties¶

Name	Type	Description	Notes
password	str	Password for http basic authentication
username	str	Username for http basic authentication

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaVendor¶

Properties¶

Name	Type	Notes
cisco	DeviceSchemaVendorCisco	[optional]
juniper	DeviceSchemaVendorJuniper	[optional]
other_vendor	DeviceSchemaVendorOthervendor	[optional]

[Back to Model list] [Back to API list] [Back to README]

LicenseKeySchema¶

Properties¶

Name	Type	Description	Notes
license_id	str	Unique ID of the license
start_date	datetime	License start date and time
end_date	datetime	License end date and time
validity_type	str	License validity type
version	int	License key version, an integer value indicating version of license vendor info
sku_name	str	License stock keeping unit name, indicates category of purchased license
customer_id	str	Identification of customer who has purchased this license
order_type	str	License purchase order type
sw_serial_id	str	Software serial number used for license activation	[optional]
mode	str	License mode of operation	[optional]
features	list[LicensekeySchemaFeatures]	Features which are part of the license

[Back to Model list] [Back to API list] [Back to README]

swagger_client.DataStoreApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
delete_data_store	DELETE /data-store/{group_name}/	Delete dashboard details.
retrieve_data_store	GET /data-store/{group_name}/	Delete dashboard details.
update_data_store	PUT /data-store/{group_name}/	Update data_store details.

delete_data_store¶

delete_data_store(group_name, authorization=authorization, key=key)

Delete dashboard details.

Delete data_store details for the given group-name, or as per the keys passed in query.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataStoreApi()
group_name = 'group_name_example' # str | Group name
authorization = 'authorization_example' # str | authentication header object (optional)
key = ['key_example'] # list[str] | ID of dashboard (optional)

try:
    # Delete dashboard details.
    api_instance.delete_data_store(group_name, authorization=authorization, key=key)
except ApiException as e:
    print("Exception when calling DataStoreApi->delete_data_store: %s\n" % e)

Name	Type	Description	Notes
group_name	str	Group name
authorization	str	authentication header object	[optional]
key	list[str]	ID of dashboard	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_data_store¶

DatastoreSchema retrieve_data_store(group_name, authorization=authorization, key=key)

Delete dashboard details.

Retrieve data_store details for the given group-name, or as per the keys passed in query.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataStoreApi()
group_name = 'group_name_example' # str | Group name
authorization = 'authorization_example' # str | authentication header object (optional)
key = ['key_example'] # list[str] | Key of data_store object (optional)

try:
    # Delete dashboard details.
    api_response = api_instance.retrieve_data_store(group_name, authorization=authorization, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataStoreApi->retrieve_data_store: %s\n" % e)

Name	Type	Description	Notes
group_name	str	Group name
authorization	str	authentication header object	[optional]
key	list[str]	Key of data_store object	[optional]

**DatastoreSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_data_store¶

update_data_store(key, data, group_name, authorization=authorization)

Update data_store details.

Update data-store details in database for the requested group name and key.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataStoreApi()
key = 'key_example' # str | key of data_store
data = swagger_client.DatastoreSchema() # DatastoreSchema | value of data_store object
group_name = 'group_name_example' # str | Group name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update data_store details.
    api_instance.update_data_store(key, data, group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DataStoreApi->update_data_store: %s\n" % e)

Name	Type	Description	Notes
key	str	key of data_store
data	DatastoreSchema	value of data_store object
group_name	str	Group name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaFormulaCount¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which count operation needs to be performed
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

AssociatedGroupSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

ProfileSchemaDatasummarizationRaw¶

Properties¶

Name	Type	Description	Notes
data_type	list[RawSchemaDatatype]		[optional]
name	str	Name of raw-data summarization profile
path	list[RawSchemaPath]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaTrigger¶

Properties¶

Name	Type	Description	Notes
description	str	Description about the trigger	[optional]
frequency	str	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	[optional]
synopsis	str	Synopsis about the trigger	[optional]
disable_alarm_deduplication	list[ERRORUNKNOWN]	Disable alarm deduplication, so that alarms are always generated	[optional]
term	list[RuleSchemaTerm]
trigger_name	str	Trigger name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaByoi¶

Properties¶

Name	Type	Description	Notes
plugin	RuleSchemaByoiPlugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.FactsApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
retrieve_iceberg_device_device_facts_by_id	GET /device/{device_id}/facts/	Get a device's facts.
retrieve_iceberg_devices_devices_facts	GET /devices/facts/	Get devices facts.
retrieve_iceberg_devices_facts_by_group	GET /device-group/{device_group_name}/facts/	Get a devices facts for given group.

retrieve_iceberg_device_device_facts_by_id¶

DeviceSchema retrieve_iceberg_device_device_facts_by_id(device_id, authorization=authorization, working=working, update=update, timeout=timeout)

Get a device’s facts.

Get the fact details of a device by its device-id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FactsApi()
device_id = 'device_id_example' # str | ID of device-id
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)
update = true # bool | true will first update facts from device and then return facts (optional)
timeout = 56 # int | timeout in seconds to wait for facts from given device id (optional)

try:
    # Get a device's facts.
    api_response = api_instance.retrieve_iceberg_device_device_facts_by_id(device_id, authorization=authorization, working=working, update=update, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->retrieve_iceberg_device_device_facts_by_id: %s\n" % e)

Name	Type	Description	Notes
device_id	str	ID of device-id
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]
update	bool	true will first update facts from device and then return facts	[optional]
timeout	int	timeout in seconds to wait for facts from given device id	[optional]

**DeviceSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_devices_devices_facts¶

DeviceSchema retrieve_iceberg_devices_devices_facts(authorization=authorization, working=working, update=update, timeout=timeout)

Get devices facts.

Get the fact details of every device

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FactsApi()
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)
update = true # bool | true will first update facts from device and then return facts (optional)
timeout = 56 # int | timeout in seconds to wait for facts from every device (optional)

try:
    # Get devices facts.
    api_response = api_instance.retrieve_iceberg_devices_devices_facts(authorization=authorization, working=working, update=update, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->retrieve_iceberg_devices_devices_facts: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]
update	bool	true will first update facts from device and then return facts	[optional]
timeout	int	timeout in seconds to wait for facts from every device	[optional]

**DeviceSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_devices_facts_by_group¶

DeviceSchema retrieve_iceberg_devices_facts_by_group(device_group_name, authorization=authorization, working=working, update=update, timeout=timeout)

Get a devices facts for given group.

Get the fact details of every device under given group

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FactsApi()
device_group_name = 'device_group_name_example' # str | ID of group
authorization = 'authorization_example' # str | authentication header object (optional)
working = true # bool | true queries un-committed configuration (optional)
update = true # bool | true will first update facts from device and then return facts (optional)
timeout = 56 # int | timeout in seconds to wait for facts from every device (optional)

try:
    # Get a devices facts for given group.
    api_response = api_instance.retrieve_iceberg_devices_facts_by_group(device_group_name, authorization=authorization, working=working, update=update, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->retrieve_iceberg_devices_facts_by_group: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	ID of group
authorization	str	authentication header object	[optional]
working	bool	true queries un-committed configuration	[optional]
update	bool	true will first update facts from device and then return facts	[optional]
timeout	int	timeout in seconds to wait for facts from every device	[optional]

**DeviceSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DebugJobResponseSchema¶

Properties¶

Name	Type	Notes
job_id	str	[optional]
job_status	str	[optional]
job_details	str	[optional]
debug_data	str	[optional]
debug_type	str	[optional]
debug_name	str	[optional]

[Back to Model list] [Back to API list] [Back to README]

TlivekafkaocSchemaSecuritySasl¶

Properties¶

Name	Type	Description	Notes
password	str	SASL password	[optional]
username	str	SASL username	[optional]

[Back to Model list] [Back to API list] [Back to README]

GroupHealthSchema¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

DestinationSchema¶

Properties¶

Name	Type	Description	Notes
disk	DestinationSchemaDisk		[optional]
email	DestinationSchemaEmail		[optional]
name	str	Name of the destination. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenExists¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
field_name	str	Field name which needs to be present
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

RawSchema¶

Properties¶

Name	Type	Description	Notes
data_type	list[RawSchemaDatatype]		[optional]
name	str	Name of raw-data summarization profile
path	list[RawSchemaPath]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaOpenconfig¶

Properties¶

Name	Type	Description	Notes
frequency	str	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
sensor_name	str	Sensor to subscribe

[Back to Model list] [Back to API list] [Back to README]

ProfileSchemaDatasummarization¶

Properties¶

Name	Type	Description	Notes
raw	list[ProfileSchemaDatasummarizationRaw]		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettings¶

Properties¶

Name	Type	Notes
flow	IngestsettingsSchemaIngestsettingsFlow	[optional]
syslog	IngestsettingsSchemaIngestsettingsSyslog	[optional]
byoi	IngestsettingsSchemaIngestsettingsByoi	[optional]
frequency_profile	list[IngestsettingsSchemaIngestsettingsFrequencyprofile]	[optional]

[Back to Model list] [Back to API list] [Back to README]

DestinationsSchema¶

Properties¶

Name	Type	Description	Notes
destination	list[DestinationSchema]		[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.SystemApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
retrieve_available_nodes	GET /nodes/	List of available nodes
retrieve_sensor_device_group	GET /sensor/device-group/{device_group_name}/	Get all All API's.
retrieve_system_details	GET /system-details/	Retrieve system details.
retrieve_tsdb_counters	GET /tsdb-counters/	TSDB counters

retrieve_available_nodes¶

retrieve_available_nodes(authorization=authorization)

List of available nodes

Get the list of available nodes in the installation.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # List of available nodes
    api_instance.retrieve_available_nodes(authorization=authorization)
except ApiException as e:
    print("Exception when calling SystemApi->retrieve_available_nodes: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_sensor_device_group¶

retrieve_sensor_device_group(device_group_name, authorization=authorization)

Get all All API’s.

GET sensors subscribed for a device-group

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()
device_group_name = 'device_group_name_example' # str | Device Group
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get all All API's.
    api_instance.retrieve_sensor_device_group(device_group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling SystemApi->retrieve_sensor_device_group: %s\n" % e)

Name	Type	Description	Notes
device_group_name	str	Device Group
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_system_details¶

retrieve_system_details(authorization=authorization, service_name=service_name)

Retrieve system details.

Retrieve system details for HealthBot system.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()
authorization = 'authorization_example' # str | authentication header object (optional)
service_name = 'service_name_example' # str | service name takes in the name of the service for which details are required. (optional)

try:
    # Retrieve system details.
    api_instance.retrieve_system_details(authorization=authorization, service_name=service_name)
except ApiException as e:
    print("Exception when calling SystemApi->retrieve_system_details: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]
service_name	str	service name takes in the name of the service for which details are required.	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_tsdb_counters¶

retrieve_tsdb_counters(authorization=authorization)

TSDB counters

Get TSDB counters

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # TSDB counters
    api_instance.retrieve_tsdb_counters(authorization=authorization)
except ApiException as e:
    print("Exception when calling SystemApi->retrieve_tsdb_counters: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaThen¶

Properties¶

Name	Type	Description	Notes
next	list[ERRORUNKNOWN]	Continue evaluating next term in a trigger	[optional]
status	RuleSchemaThenStatus		[optional]
user_defined_action	list[RuleSchemaThenUserdefinedaction]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RawSchemaPath¶

Properties¶

Name	Type	Description	Notes
aggregation_functions	list[str]
name	str	Sensor field path for which summarization should be changed. Apart from JTI OC sensor path, '<sensor-name>:' should be prepended to the sensor path

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaUserdefinedfunctionArgument¶

Properties¶

Name	Type	Description	Notes
argument	str	Argument name
value	str	Argument value

[Back to Model list] [Back to API list] [Back to README]

PatternSetSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Pattern-set description	[optional]
name	str	Name of a pattern-set. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
pattern_names	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaMin¶

Properties¶

Name	Type	Description	Notes
field_name	str	Field name on which min operation needs to be performed
time_range	str	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

[Back to Model list] [Back to API list] [Back to README]

SchedulerSchemaRepeatInterval¶

Properties¶

Name	Type	Description	Notes
days	int	Duration of time in days	[optional]
hours	int	Duration of time in hours	[optional]
minutes	int	Duration of time in minutes	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaOutlierdetectionAlgorithmDbscanSensitivity¶

Properties¶

Name	Type	Description	Notes
absolute_percentage	float	Absolute percentage of members that are to be marked as outliers	[optional]
level	str	Fuzzy level of outliers to be detected	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaIAgentArgs¶

Properties¶

Name	Type	Description	Notes
arg_name	str	name of argument
arg_value	str	value of argument	[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.LicenseApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
create_iceberg_add_license_from_file	POST /license/keys/	Add license from file.
delete_iceberg_delete_all_license	DELETE /license/keys/	Delete all licenses.
delete_iceberg_delete_license_by_id	DELETE /license/key/{license_id}/	Delete a license.
retrieve_iceberg_get_all_license_id	GET /license/keys/	List of available license id's.
retrieve_iceberg_license_features_info	GET /license/status/	Status of all the licensed features.
retrieve_iceberg_license_file_by_license_id	GET /license/key/{license_id}/	Download license file.
retrieve_iceberg_license_key_contents	GET /license/keys/contents/	Get the contents of all licenses.
retrieve_iceberg_license_key_contents_by_id	GET /license/key/{license_id}/contents/	Get the contents of a license.
update_iceberg_replace_license	PUT /license/keys/	Update the license.

create_iceberg_add_license_from_file¶

InlineResponse2001 create_iceberg_add_license_from_file(license_file, authorization=authorization)

Add license from file.

Add license keys from file.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
license_file = '/path/to/file.txt' # file | License key file content
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Add license from file.
    api_response = api_instance.create_iceberg_add_license_from_file(license_file, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->create_iceberg_add_license_from_file: %s\n" % e)

Name	Type	Description	Notes
license_file	file	License key file content
authorization	str	authentication header object	[optional]

**InlineResponse2001**

No authorization required

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_delete_all_license¶

delete_iceberg_delete_all_license(authorization=authorization)

Delete all licenses.

Delete all the previously added license keys.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete all licenses.
    api_instance.delete_iceberg_delete_all_license(authorization=authorization)
except ApiException as e:
    print("Exception when calling LicenseApi->delete_iceberg_delete_all_license: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_iceberg_delete_license_by_id¶

delete_iceberg_delete_license_by_id(license_id, authorization=authorization)

Delete a license.

Delete a license matching the license id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
license_id = 'license_id_example' # str | License id
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Delete a license.
    api_instance.delete_iceberg_delete_license_by_id(license_id, authorization=authorization)
except ApiException as e:
    print("Exception when calling LicenseApi->delete_iceberg_delete_license_by_id: %s\n" % e)

Name	Type	Description	Notes
license_id	str	License id
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_get_all_license_id¶

list[str] retrieve_iceberg_get_all_license_id(authorization=authorization)

List of available license id’s.

Get the list of all available license id’s.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # List of available license id's.
    api_response = api_instance.retrieve_iceberg_get_all_license_id(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->retrieve_iceberg_get_all_license_id: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

list[str]

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_license_features_info¶

LicenseFeaturesSchema retrieve_iceberg_license_features_info(authorization=authorization)

Status of all the licensed features.

Get the status of all the licensed features. Also provides the compliance info per feature

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Status of all the licensed features.
    api_response = api_instance.retrieve_iceberg_license_features_info(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->retrieve_iceberg_license_features_info: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

**LicenseFeaturesSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_license_file_by_license_id¶

file retrieve_iceberg_license_file_by_license_id(license_id, authorization=authorization)

Download license file.

Download the specified license file based on license id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
license_id = 'license_id_example' # str | License id
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Download license file.
    api_response = api_instance.retrieve_iceberg_license_file_by_license_id(license_id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->retrieve_iceberg_license_file_by_license_id: %s\n" % e)

Name	Type	Description	Notes
license_id	str	License id
authorization	str	authentication header object	[optional]

**file**

No authorization required

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_license_key_contents¶

LicenseKeysSchema retrieve_iceberg_license_key_contents(authorization=authorization)

Get the contents of all licenses.

Get the license key contents for all the available licenses.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get the contents of all licenses.
    api_response = api_instance.retrieve_iceberg_license_key_contents(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->retrieve_iceberg_license_key_contents: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object	[optional]

**LicenseKeysSchema**

No authorization required

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_iceberg_license_key_contents_by_id¶

LicenseKeySchema retrieve_iceberg_license_key_contents_by_id(license_id, authorization=authorization)

Get the contents of a license.

Get the license key contents by the license id.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
license_id = 'license_id_example' # str | License id
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Get the contents of a license.
    api_response = api_instance.retrieve_iceberg_license_key_contents_by_id(license_id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->retrieve_iceberg_license_key_contents_by_id: %s\n" % e)

Name	Type	Description	Notes
license_id	str	License id
authorization	str	authentication header object	[optional]

**LicenseKeySchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_iceberg_replace_license¶

InlineResponse2001 update_iceberg_replace_license(license_raw_keys, authorization=authorization)

Update the license.

Update existing license keys with the new one provided in this request.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
license_raw_keys = swagger_client.LicenseRawKeysSchema() # LicenseRawKeysSchema | License raw keys contents
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Update the license.
    api_response = api_instance.update_iceberg_replace_license(license_raw_keys, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->update_iceberg_replace_license: %s\n" % e)

Name	Type	Description	Notes
license_raw_keys	LicenseRawKeysSchema	License raw keys contents
authorization	str	authentication header object	[optional]

**InlineResponse2001**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

IngestmappingSchemaIAgent¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

swagger_client.AdministrationApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
create_groups	POST /group/	Create groups
create_users	POST /user/	Create an user.
delete_group	DELETE /group/{groupid}/	Delete groups
delete_user	DELETE /user/{userid}/	Delete list of users.
flush_groups	PUT /group/	Flush the groups
flush_users	PUT /user/	Flush user base with new set of records.
get_group_details	GET /group/{groupid}/	Get lits of all the groups
get_user_details	GET /user/{userid}/	Get lits of all the users
retrieve_groups	GET /group/	Get lits of all the groups
retrieve_roles	GET /role/	Get list of all the roles
retrieve_users	GET /user/	Get lits of all the users
update_group	POST /group/{groupid}/	Get lits of all the roles
update_user_profile	POST /user/{userid}/	Update user profile informations.

create_groups¶

create_groups(authorization, groups)

Create groups

Create group in the system

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
groups = [swagger_client.Groups()] # list[Groups] | group details

try:
    # Create groups
    api_instance.create_groups(authorization, groups)
except ApiException as e:
    print("Exception when calling AdministrationApi->create_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
groups	list[Groups]	group details

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_users¶

list[str] create_users(authorization, users)

Create an user.

Create users in the system

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
users = [swagger_client.UserSchema()] # list[UserSchema] | List of users

try:
    # Create an user.
    api_response = api_instance.create_users(authorization, users)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->create_users: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
users	list[UserSchema]	List of users

list[str]

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_group¶

delete_group(authorization, groupid)

Delete groups

Delete the groups

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
groupid = 'groupid_example' # str | Id of group

try:
    # Delete groups
    api_instance.delete_group(authorization, groupid)
except ApiException as e:
    print("Exception when calling AdministrationApi->delete_group: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
groupid	str	Id of group

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user¶

delete_user(authorization, userid)

Delete list of users.

Delete list of users from system, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
userid = 'userid_example' # str | Id of user

try:
    # Delete list of users.
    api_instance.delete_user(authorization, userid)
except ApiException as e:
    print("Exception when calling AdministrationApi->delete_user: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
userid	str	Id of user

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

flush_groups¶

flush_groups(authorization, groups)

Flush the groups

Flush the existing groups and create new set of groups

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
groups = [swagger_client.Groups()] # list[Groups] | Group data

try:
    # Flush the groups
    api_instance.flush_groups(authorization, groups)
except ApiException as e:
    print("Exception when calling AdministrationApi->flush_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
groups	list[Groups]	Group data

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

flush_users¶

list[InlineResponse2003] flush_users(authorization, users)

Flush user base with new set of records.

Flush the user base with new records

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
users = [swagger_client.UserSchema()] # list[UserSchema] | User details

try:
    # Flush user base with new set of records.
    api_response = api_instance.flush_users(authorization, users)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->flush_users: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
users	list[UserSchema]	User details

**list[InlineResponse2003]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group_details¶

InlineResponse2008 get_group_details(authorization, groupid)

Get lits of all the groups

Get list of registered groups, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
groupid = 'groupid_example' # str | Id of group

try:
    # Get lits of all the groups
    api_response = api_instance.get_group_details(authorization, groupid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_group_details: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
groupid	str	Id of group

**InlineResponse2008**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_details¶

InlineResponse2004 get_user_details(authorization, userid)

Get lits of all the users

Get details of registered users, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
userid = 'userid_example' # str | Id of user

try:
    # Get lits of all the users
    api_response = api_instance.get_user_details(authorization, userid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->get_user_details: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object
userid	str	Id of user

**InlineResponse2004**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_groups¶

list[InlineResponse2008] retrieve_groups(authorization)

Get lits of all the groups

Get list of registered groups, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object

try:
    # Get lits of all the groups
    api_response = api_instance.retrieve_groups(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->retrieve_groups: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object

**list[InlineResponse2008]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_roles¶

RoleSchema retrieve_roles(authorization)

Get list of all the roles

Get list of registered roles, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object

try:
    # Get list of all the roles
    api_response = api_instance.retrieve_roles(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->retrieve_roles: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object

**RoleSchema**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_users¶

list[InlineResponse2002] retrieve_users(authorization)

Get lits of all the users

Get list of registered users, for administrative purpose

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object

try:
    # Get lits of all the users
    api_response = api_instance.retrieve_users(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->retrieve_users: %s\n" % e)

Name	Type	Description	Notes
authorization	str	authentication header object

**list[InlineResponse2002]**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_group¶

InlineResponse2009 update_group(authorization, groupid, group)

Get lits of all the roles

Update group

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
groupid = 'groupid_example' # str | Id of group
group = swagger_client.Group() # Group | group details

try:
    # Get lits of all the roles
    api_response = api_instance.update_group(authorization, groupid, group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdministrationApi->update_group: %s\n" % e)

Name	Type	Description
authorization	str	authentication header object
groupid	str	Id of group
group	Group	group details

**InlineResponse2009**

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user_profile¶

update_user_profile(authorization, userid, user)

Update user profile informations.

Update a user profile in the system

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdministrationApi()
authorization = 'authorization_example' # str | authentication header object
userid = 'userid_example' # str | Id of user
user = swagger_client.User() # User | user details

try:
    # Update user profile informations.
    api_instance.update_user_profile(authorization, userid, user)
except ApiException as e:
    print("Exception when calling AdministrationApi->update_user_profile: %s\n" % e)

Name	Type	Description
authorization	str	authentication header object
userid	str	Id of user
user	User	user details

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Groups¶

Properties¶

Name	Type	Description	Notes
group_name	str	Name of the group	[optional]
group_description	str	Details of the group	[optional]
roles	AssociatedRoleSchema		[optional]
users	AssociatedUserSchema		[optional]

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2004¶

Properties¶

Name	Type	Description	Notes
user_id	str	ID generated by system	[optional]
user_name	str	Name of the user	[optional]
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]
active	bool	Status of the user	[optional]
groups	AssociatedGroupSchema		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenDoesnotmatchwith¶

Properties¶

Name	Type	Description	Notes
all	list[ERRORUNKNOWN]	With this flag, result is set to True only if all the data matches the given condition	[optional]
any	list[ERRORUNKNOWN]	With this flag, result is set to True if any one of the data matches the condition	[optional]
ignore_case	list[ERRORUNKNOWN]	Flag to ignore case while matching the string	[optional]
left_operand	str	Left operand. This is the string in which we have to match the expression.
right_operand	str	Right operand. This is the match expression.
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

CustomPluginSchema¶

Properties¶

Name	Type	Description	Notes
name	str	Name is the identifier of this config, referred in sensor config under topic/rule
parameters	list[CustompluginSchemaParameters]	Plugin specific parameters (config)	[optional]
plugin_name	str	Name of the loaded input plugin of BYOI	[optional]
security_parameters	CustompluginSchemaSecurityparameters		[optional]
service_name	str	Name of the service (docker container) which implements this plugin	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaReference¶

Properties¶

Name	Type	Description	Notes
data_if_missing	RuleSchemaReferenceDataifmissing		[optional]
path	str	Reference to a field or trigger in different rule. Format is /topic[topic-name=<topic-name>]/rule[rule-name=<rule-name>]/field[<condition>]/<field-name> for field reference and /topic[topic-name=<topic-name>]/rule[rule-name=<rule-name>]/trigger[trigger-name=<trigger-name>]/key[condition]/trigger_field for trigger reference. Filtering part where field and key are mentioned is optional
time_range	str	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	[optional]

[Back to Model list] [Back to API list] [Back to README]

PatternSchemaField¶

Properties¶

Name	Type	Description	Notes
description	str	Field description	[optional]
_from	str	Field from the structured syslog which supplies the value	[optional]
name	str	Field name
type	str	Data type of field	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsByoi¶

Properties¶

Name	Type	Description	Notes
custom_plugin	list[CustomPluginSchema]		[optional]
default_plugin	IngestsettingsSchemaIngestsettingsByoiDefaultplugin		[optional]
ingest_mapping	list[IngestMappingSchema]	Ingest to sensor/device mapping	[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsSensor¶

Properties¶

Name	Type	Description	Notes
frequency	str	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
sensor_name	str	Name of sensor. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevices¶

Properties¶

Name	Type	Description	Notes
juniper	RuleSchemaRulepropertiesSupporteddevicesJuniper		[optional]
other_vendor	list[RuleSchemaRulepropertiesSupporteddevicesOthervendor]		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaNetflow¶

Properties¶

Name	Type	Description	Notes
for_device_groups	list[str]		[optional]
use_plugin	IngestmappingSchemaIAgentUseplugin		[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaAuthentication¶

Properties¶

Name	Type	Notes
password	DevicegroupSchemaAuthenticationPassword	[optional]
ssh	DevicegroupSchemaAuthenticationSsh	[optional]
ssl	DevicegroupSchemaAuthenticationSsl	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevicesJuniperProducts¶

Properties¶

Name	Type	Description	Notes
product_name	str	Product name
releases	list[RuleSchemaRulepropertiesSupporteddevicesJuniperReleases]	Release information for the products	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaWhenIncreasingatleastbyrate¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaPublish¶

Properties¶

Name	Type	Notes
destination	list[str]
field	list[str]	[optional]
sensor	list[str]	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaDynamicthreshold¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2005¶

Properties¶

Name	Type	Description	Notes
user_id	str	ID generated by system	[optional]
user_name	str	Name of the user	[optional]
first_name	str	First name of the user	[optional]
last_name	str	Last name of the user	[optional]
email	str	Email of the user	[optional]

[Back to Model list] [Back to API list] [Back to README]

TliveKafkaOcSchema¶

Properties¶

Name	Type	Description	Notes
brokers	list[str]
collector_settings	object		[optional]
name	str	Name of this instance
security	TlivekafkaocSchemaSecurity		[optional]
topics	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaMicroburst¶

Properties¶

Name	Type	Description
if_name	str	Interface name. This should be field name where interface names are being stored
packets	str	Queue egress packets. This should be field name where queue egress packets are being stored
percentage	str	Queue buffer occupancy percentage. This should be field name where queue buffer occupancy percentage are being stored
queue_no	str	Queue numbers. This should be field name where queue numbers are being stored

[Back to Model list] [Back to API list] [Back to README]

DatastoreSchema¶

Properties¶

Name	Type	Description	Notes
group_name	str	group name	[optional]
key	str	key name for the group	[optional]
value	object	value for the key	[optional]

[Back to Model list] [Back to API list] [Back to README]

TemplateSchema¶

Properties¶

Name	Type	Description	Notes
description	str	Template description.	[optional]
key_fields	list[str]		[optional]
name	str	Name of the template.
priority	int	Priority given to template during matching.	[optional]
protocol_version	str	Flow protocol version.	[optional]
recognition_pattern	FlowSchemaFlowRecognitionpattern		[optional]

[Back to Model list] [Back to API list] [Back to README]

AffectedGroups¶

Properties¶

Name	Type	Description	Notes
device_groups	list[str]		[optional]
network_groups	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestMappingSchema¶

Properties¶

Name	Type	Description	Notes
i_agent	IngestmappingSchemaIAgent		[optional]
name	str	Name of the mapping
native_gpb	IngestmappingSchemaNativegpb		[optional]
netflow	IngestmappingSchemaNetflow		[optional]
open_config	IngestmappingSchemaOpenconfig		[optional]
snmp	IngestmappingSchemaSnmp		[optional]
syslog	IngestmappingSchemaSyslog		[optional]

[Back to Model list] [Back to API list] [Back to README]

CommitJob¶

Properties¶

Name	Type	Description	Notes
detail	str
status	int
url	str

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaKafkapublishSasl¶

Properties¶

Name	Type	Description	Notes
certificate	str	File path to kafka CA-Certificate. Should be of pattern .+.pem	[optional]
password	str	Password for sasl_ssl authentication	[optional]
username	str	Username for sasl_ssl authentication	[optional]

[Back to Model list] [Back to API list] [Back to README]

DevicegroupSchemaSyslog¶

Properties¶

Name	Type	Description	Notes
ports	list[int]		[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaEmailsFilter¶

Properties¶

Name	Type	Description	Notes
rules	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]

SshKeyProfileSchema¶

Properties¶

Name	Type	Description
name	str	SSH Key profile name. Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*
ssh_private_key_file	str	SSH private key file name
ssh_private_key_passphrase	str	SSH private key passphrase

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaSnmp¶

Properties¶

Name	Type	Description	Notes
frequency	str	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
table	str	OID of an SNMP table

[Back to Model list] [Back to API list] [Back to README]

IngestmappingSchemaIAgentUseplugin¶

Properties¶

Name	Type	Description	Notes
instance	str	Plugin instance name	[optional]
name	str	BYOI plugin name
type	str	Plugin type

[Back to Model list] [Back to API list] [Back to README]

DeviceSchemaVendorOthervendor¶

Properties¶

Name	Type	Description	Notes
operating_system	str	Vendor operating system, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*	[optional]
vendor_name	str	Vendor-name, Should be of pattern [a-zA-Z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaAnomalydetection¶

Properties¶

[Back to Model list] [Back to API list] [Back to README]

swagger_client.DataSourceApi¶

All URIs are relative to http://api-server/api/v1

Method	HTTP request	Description
create_data_store	POST /data-store/{group_name}/	Create dashboard details.

create_data_store¶

create_data_store(key, data, group_name, authorization=authorization)

Create dashboard details.

Store data-store details in database for the requested group name and key.

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataSourceApi()
key = 'key_example' # str | Key of data_store object
data = swagger_client.DatastoreSchema() # DatastoreSchema | Value of data_store object
group_name = 'group_name_example' # str | Group name
authorization = 'authorization_example' # str | authentication header object (optional)

try:
    # Create dashboard details.
    api_instance.create_data_store(key, data, group_name, authorization=authorization)
except ApiException as e:
    print("Exception when calling DataSourceApi->create_data_store: %s\n" % e)

Name	Type	Description	Notes
key	str	Key of data_store object
data	DatastoreSchema	Value of data_store object
group_name	str	Group name
authorization	str	authentication header object	[optional]

void (empty response body)

No authorization required

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RuleSchemaFormulaOutlierdetection¶

Properties¶

Name	Type	Description	Notes
algorithm	RuleSchemaFormulaOutlierdetectionAlgorithm		[optional]
dataset	str	Variable containing the list of XPATHs to the data

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaKafkapublish¶

Properties¶

Name	Type	Description	Notes
bootstrap_servers	list[str]
sasl	NotificationSchemaKafkapublishSasl		[optional]
topic	str	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>.<device-id>.<topic>.<rule>.<trigger>	[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaRulepropertiesSupporteddevicesJuniperOperatingsystem¶

Properties¶

Name	Type	Description	Notes
os_name	str
products	list[RuleSchemaRulepropertiesSupporteddevicesJuniperProducts]		[optional]

[Back to Model list] [Back to API list] [Back to README]

DeviceGroupsSchema¶

Properties¶

Name	Type	Description	Notes
device_group	list[DeviceGroupSchema]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaReferenceDataifmissing¶

Properties¶

Name	Type	Description	Notes
value	str	Assign given default value for field in case of data missing	[optional]

[Back to Model list] [Back to API list] [Back to README]

NotificationSchemaSlack¶

Properties¶

Name	Type	Description	Notes
channel	str	Channel on which notification should be posted
url	str	URL on which slack notification needs to be posted

[Back to Model list] [Back to API list] [Back to README]

InlineResponse2001¶

Properties¶

Name	Type	Description	Notes
license_id	str		[optional]

[Back to Model list] [Back to API list] [Back to README]

FlowSchemaFlowTemplate¶

Properties¶

Name	Type	Description	Notes
description	str	Template description.	[optional]
key_fields	list[str]		[optional]
name	str	Name of the template.
priority	int	Priority given to template during matching.	[optional]
protocol_version	str	Flow protocol version.	[optional]
recognition_pattern	FlowSchemaFlowRecognitionpattern		[optional]

[Back to Model list] [Back to API list] [Back to README]

IngestsettingsSchemaIngestsettingsFrequencyprofile¶

Properties¶

Name	Type	Description	Notes
name	str	Frequency profile name
non_sensor	list[FrequencyprofileSchemaNonsensor]		[optional]
sensor	list[IngestsettingsSchemaIngestsettingsSensor]		[optional]

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormula1And¶

Properties¶

Name	Type	Description	Notes
left_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*
right_vector	str	Vector name. Pattern for giving vector name is @[a-z][a-zA-Z0-9_-]*

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaFormulaUserdefinedfunction¶

Properties¶

Name	Type	Description	Notes
argument	list[RuleSchemaFormulaUserdefinedfunctionArgument]		[optional]
function_name	str	Function name

[Back to Model list] [Back to API list] [Back to README]

RuleSchemaThenArgument¶

Properties¶

Name	Type	Description	Notes
argument	str	Argument name
value	str	Argument value

[Back to Model list] [Back to API list] [Back to README]

NetworkgroupSchemaPublish¶

Properties¶

Name	Type	Description	Notes
destination	list[str]
field	list[str]		[optional]

[Back to Model list] [Back to API list] [Back to README]