api.alarms.v1 package

Submodules

api.alarms.v1.alarm module

Autogenerated API

api.alarms.v1.alarm.get_alarm_by_id(id: int, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get alarm by Id (PUBLIC)

Return type:

dict

Parameters:

id (int) – ID of alarm

Raises:
Returns:

{‘offset’: 123, ‘limit’: 683, ‘responseCode’: 200, ‘count’: 784, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘As hear happen bit.’, ‘messageTemplate’: ‘Evening break science whom middle what keep allow.’, ‘field’: ‘More responsibility account stuff surface.’, ‘parameter’: {}, ‘timestamp’: 1500419040}], ‘currentPage’: 749, ‘size’: 899}

api.alarms.v1.alarm.get_alarms(keywords: list = None, keywordField: list = None, keywordMatch: str = 'all', offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all alarms (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • keywordMatch (str) – Set match strategy for keyword search
  • offset (int) – Skip a number of alarms
  • limit (int) – Maximum number of returned alarms
Raises:
Returns:

{‘offset’: 563, ‘limit’: 950, ‘responseCode’: 200, ‘count’: 847, ‘data’: [{‘id’: 604, ‘mappings’: [{‘lastUpdatedTimestamp’: 972701567, ‘comments’: [{‘timestamp’: 1372528008, ‘comment’: ‘Capital between now describe town make.’}], ‘mappedTimestamp’: 1027950597, ‘firstTriggeredTimestamp’: 1024690292, ‘lastTriggeredTimestamp’: 929672160, ‘triggerAmount’: 577, ‘signature’: ‘Give impact compare amount.’, ‘flags’: [‘DELETED’]}], ‘comments’: [{‘timestamp’: 1309345056, ‘comment’: ‘Quickly least treatment impact letter.’}], ‘references’: [‘Company customer face every condition.’], ‘labels’: [‘Allow building billion see.’], ‘info’: ‘Sense international cover necessary hotel left statement.’, ‘description’: ‘Home pay body sister media member.’, ‘links’: [‘Appear fund his agent.’], ‘createdByUser’: {‘id’: 927, ‘customerID’: 146, ‘userName’: ‘robert14’, ‘name’: ‘Stephen Barton’}, ‘createdTimestamp’: 862191237, ‘lastUpdatedByUser’: {‘id’: 710, ‘customerID’: 612, ‘userName’: ‘rebecca56’, ‘name’: ‘Robert Daugherty’}, ‘lastUpdatedTimestamp’: 870099623, ‘lastCheckedByUser’: {‘id’: 912, ‘customerID’: 184, ‘userName’: ‘karenhaney’, ‘name’: ‘Devin Mcneil’}, ‘lastCheckTimestamp’: 630503804, ‘nextCheckTimestamp’: 1164731268, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Position reality real.’, ‘messageTemplate’: ‘Concern trade ok talk thus.’, ‘field’: ‘Source detail speech energy citizen owner cell.’, ‘parameter’: {}, ‘timestamp’: 1457646060}], ‘currentPage’: 565, ‘size’: 847}

api.alarms.v1.alarm.search_alarms(limit: int = None, offset: int = None, subCriteria: list = None, attackCategoryID: list = None, alarmID: list = None, alarmReferences: list = None, labels: list = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: list = None, keywords: list = None, keywordFieldStrategy: list = None, signature: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, timeMatchStrategy: str = 'any', keywordMatchStrategy: str = 'all', includeDeleted: bool = None, exclude: bool = None, required: bool = None, includeMappings: bool = None, includeComments: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all alarms matching a given search criteria (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • attackCategoryID (list) – A set of IDs for attack categories (alarm category).
  • alarmID (list) – A set of IDs for alarms.
  • alarmReferences (list) – A set of references. It does an exact match.
  • labels (list) – A set of labels. It does an exact match.
  • startTimestamp (int) – Only include alarms based on the set TimeFieldStrategy and TimeMatchStrategy (start timestamp)
  • endTimestamp (int) – Only include alarms based on the set TimeFieldStrategy and TimeMatchStrategy (end timestamp)
  • timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match. (default lastUpdatedTimestamp)
  • keywords (list) – A set of keywords matched against alarms based on the set KeywordFieldStrategy and KeywordMatchStrategy.
  • keywordFieldStrategy (list) – KeywordFieldStrategy to define which field(s) to match against keywords. (default all)
  • signature (list) – A set of signatures. It does an exact match.
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with fields. (default any)
  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how to match keywords with fields. (default all)
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • includeMappings (bool) – Set to include mappings in the search result. (default false)
  • includeComments (bool) – Set to include comments in the search result. (default false)
Raises:
Returns:

{‘offset’: 675, ‘limit’: 171, ‘responseCode’: 200, ‘count’: 846, ‘data’: [{‘id’: 837, ‘mappings’: [{‘lastUpdatedTimestamp’: 141869288, ‘comments’: [{‘timestamp’: 942797836, ‘comment’: ‘Artist collection out me.’}], ‘mappedTimestamp’: 645901664, ‘firstTriggeredTimestamp’: 1497557799, ‘lastTriggeredTimestamp’: 814742113, ‘triggerAmount’: 602, ‘signature’: ‘Approach hot modern indicate.’, ‘flags’: [‘DELETED’]}], ‘comments’: [{‘timestamp’: 387206257, ‘comment’: ‘Whole off place student.’}], ‘references’: [‘Trade all hot moment.’], ‘labels’: [‘Else stand election budget.’], ‘info’: ‘Measure central improve continue daughter democratic.’, ‘description’: ‘Campaign miss culture everybody key if example consider.’, ‘links’: [‘Very attack to camera also.’], ‘createdByUser’: {‘id’: 935, ‘customerID’: 687, ‘userName’: ‘cardenasveronica’, ‘name’: ‘Jeffrey Gardner’}, ‘createdTimestamp’: 980172360, ‘lastUpdatedByUser’: {‘id’: 762, ‘customerID’: 209, ‘userName’: ‘emily27’, ‘name’: ‘Megan Morris’}, ‘lastUpdatedTimestamp’: 91266829, ‘lastCheckedByUser’: {‘id’: 39, ‘customerID’: 836, ‘userName’: ‘turneramanda’, ‘name’: ‘Steven Frank’}, ‘lastCheckTimestamp’: 1208333868, ‘nextCheckTimestamp’: 501946315, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Say wait instead save town low.’, ‘messageTemplate’: ‘Meeting attack real.’, ‘field’: ‘Option role during call home product.’, ‘parameter’: {}, ‘timestamp’: 1300717810}], ‘currentPage’: 211, ‘size’: 570}

api.alarms.v1.category module

Autogenerated API

api.alarms.v1.category.get_categories(keywords: list = None, keywordField: list = None, offset: int = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all categories (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Filter categories by keywords
  • keywordField (list) – Set field strategy for keyword search
  • offset (int) – Skip a number of categories
  • limit (int) – Maximum number of returned categories
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{‘offset’: 253, ‘limit’: 945, ‘responseCode’: 200, ‘count’: 970, ‘data’: [{‘id’: 558, ‘info’: ‘Help because board stop.’, ‘name’: ‘Tanya Cohen’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Again citizen whatever project season movie house place.’, ‘messageTemplate’: ‘Paper nothing alone white if.’, ‘field’: ‘Family anything knowledge clearly anything institution half head.’, ‘parameter’: {}, ‘timestamp’: 414432778}], ‘currentPage’: 77, ‘size’: 522}

api.alarms.v1.category.get_category_by_id(id: int, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get category by Id (PUBLIC)

Return type:

dict

Parameters:

id (int) – ID of category

Raises:
Returns:

{‘offset’: 434, ‘limit’: 23, ‘responseCode’: 200, ‘count’: 955, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Amount tree by series.’, ‘messageTemplate’: ‘Though despite person best.’, ‘field’: ‘Chance example course information to class.’, ‘parameter’: {}, ‘timestamp’: 749478214}], ‘currentPage’: 845, ‘size’: 624}

api.alarms.v1.category.search_categories(limit: int = None, offset: int = None, subCriteria: list = None, attackCategoryID: list = None, keywords: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, keywordMatchStrategy: str = 'all', includeDeleted: bool = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all categories matching a given search criteria (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • attackCategoryID (list) – A set of IDs for attack categories (alarm category).
  • keywords (list) – A set of keywords matched against categories based on the set KeywordFieldStrategy and KeywordMatchStrategy.
  • keywordFieldStrategy (list) – KeywordFieldStrategy to define which field(s) to match against keywords. (default all)
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how to match keywords with fields. (default all)
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{‘offset’: 561, ‘limit’: 4, ‘responseCode’: 200, ‘count’: 467, ‘data’: [{‘id’: 949, ‘info’: ‘Most boy detail senior huge much bit.’, ‘name’: ‘Andrew Morgan’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Exactly the direction animal question during activity.’, ‘messageTemplate’: ‘Drive particularly water into word enough.’, ‘field’: ‘Especially environment without parent on.’, ‘parameter’: {}, ‘timestamp’: 120208669}], ‘currentPage’: 325, ‘size’: 762}

api.alarms.v1.signature module

Autogenerated API

api.alarms.v1.signature.get_signatures(keywords: list = None, keywordField: list = None, keywordMatch: str = 'all', offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all signatures including alarms if mapped (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • keywordMatch (str) – Set match strategy for keyword search
  • offset (int) – Skip a number of signatures
  • limit (int) – Maximum number of returned signatures
Raises:
Returns:

{‘offset’: 261, ‘limit’: 135, ‘responseCode’: 200, ‘count’: 62, ‘data’: [{‘lastUpdatedByUser’: {‘id’: 115, ‘customerID’: 468, ‘userName’: ‘alucas’, ‘name’: ‘Matthew Pierce’}, ‘lastUpdatedTimestamp’: 995944791, ‘comments’: [{‘timestamp’: 922027884, ‘comment’: ‘Interesting trip down plan agent treatment.’}], ‘mappedTimestamp’: 610023042, ‘mappedByUser’: {‘id’: 626, ‘customerID’: 208, ‘userName’: ‘samanthahunt’, ‘name’: ‘Stephanie Ellis’}, ‘firstTriggeredTimestamp’: 755442308, ‘lastTriggeredTimestamp’: 1260346932, ‘triggerAmount’: 698, ‘signature’: ‘Produce perform home have question.’, ‘flags’: [‘DEFAULT_BLOCK’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Idea since special conference child four toward necessary.’, ‘messageTemplate’: ‘Discover guess thousand better general.’, ‘field’: ‘Open speech just security popular through.’, ‘parameter’: {}, ‘timestamp’: 656657579}], ‘currentPage’: 902, ‘size’: 653}

api.alarms.v1.signature.search_signatures(limit: int = None, offset: int = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: list = None, attackCategoryID: list = None, alarmID: list = None, signature: list = None, minTriggerAmount: int = None, maxTriggerAmount: int = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: list = None, keywords: list = None, keywordFieldStrategy: list = None, sortBy: list = None, timeMatchStrategy: str = 'any', keywordMatchStrategy: str = 'all', includeDeleted: bool = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Get all signatures matching a given search criteria (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • includeFlags (int) – Only include objects which have includeFlags set.
  • excludeFlags (int) – Exclude objects which have excludeFlags set.
  • subCriteria (list) –
  • attackCategoryID (list) – A set of IDs for attack categories (alarm category).
  • alarmID (list) – A set of IDs for alarms.
  • signature (list) – A set of signatures. It does an exact match.
  • minTriggerAmount (int) – Minimum trigger amount, default 0 means disabled
  • maxTriggerAmount (int) – Maximum trigger amount, default 0 means disabled
  • startTimestamp (int) – Only include mappings based on the set TimeFieldStrategy and TimeMatchStrategy (start timestamp)
  • endTimestamp (int) – Only include mappings based on the set TimeFieldStrategy and TimeMatchStrategy (end timestamp)
  • timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match. (default lastTriggeredTimestamp)
  • keywords (list) – A set of keywords matched against mappings based on the set KeywordFieldStrategy and KeywordMatchStrategy.
  • keywordFieldStrategy (list) – KeywordFieldStrategy to define which field(s) to match against keywords. (default all)
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with fields. (default any)
  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how to match keywords with fields. (default all)
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{‘offset’: 265, ‘limit’: 65, ‘responseCode’: 200, ‘count’: 529, ‘data’: [{‘lastUpdatedByUser’: {‘id’: 11, ‘customerID’: 210, ‘userName’: ‘zachary34’, ‘name’: ‘Hailey Miller’}, ‘lastUpdatedTimestamp’: 1201568889, ‘comments’: [{‘timestamp’: 1298418708, ‘comment’: ‘Ready stand sign law social.’}], ‘mappedTimestamp’: 1440450227, ‘mappedByUser’: {‘id’: 254, ‘customerID’: 416, ‘userName’: ‘whitesuzanne’, ‘name’: ‘Angela Torres’}, ‘firstTriggeredTimestamp’: 1302184276, ‘lastTriggeredTimestamp’: 78862770, ‘triggerAmount’: 222, ‘signature’: ‘Staff concern degree number certainly lay.’, ‘flags’: [‘SNORT’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Seek society point money recently use agent send.’, ‘messageTemplate’: ‘Before name method chance ever reflect this do.’, ‘field’: ‘Someone site trade adult energy including though.’, ‘parameter’: {}, ‘timestamp’: 1485320377}], ‘currentPage’: 483, ‘size’: 516}

Module contents