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 = '', authentication: dict = {}) → dict[source]

Get alarm by Id (PUBLIC)

Return type:

dict

Parameters:

id (int) – ID of alarm

Raises:
Returns:

{“offset”: 295, “limit”: 904, “responseCode”: 200, “count”: 74, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Public enough sound take nature seek.”, “messageTemplate”: “Affect you sure impact buy music follow.”, “field”: “That if occur behind.”, “parameter”: {}, “timestamp”: 149711893}], “currentPage”: 544, “size”: 574}

api.alarms.v1.alarm.get_alarms(keywords: list = None, keywordField: list = None, keywordMatch: str = 'all', offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', 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”: 560, “limit”: 627, “responseCode”: 200, “count”: 596, “data”: [{“id”: 98, “mappings”: [{“lastUpdatedTimestamp”: 1168867658, “comments”: [{“timestamp”: 966201729, “comment”: “Skill thus offer leg determine fall back reduce.”}], “mappedTimestamp”: 153583951, “firstTriggeredTimestamp”: 511437760, “lastTriggeredTimestamp”: 235998723, “triggerAmount”: 799, “signature”: “Finally him tough paper political story.”, “flags”: [“ISS_SIGNATURE”]}], “comments”: [{“timestamp”: 1501611969, “comment”: “Order between could tonight keep.”}], “references”: [“Pretty water miss specific require behind.”], “labels”: [“Poor large stay defense focus product.”], “info”: “In travel maybe policy natural.”, “description”: “Citizen popular pay until wide song just.”, “links”: [“Away often action care matter treat.”], “createdByUser”: {“id”: 678, “customerID”: 235, “userName”: “pwolf”, “name”: “Alexa Rogers”}, “createdTimestamp”: 1279744404, “lastUpdatedByUser”: {“id”: 622, “customerID”: 223, “userName”: “lgomez”, “name”: “Mary Smith”}, “lastUpdatedTimestamp”: 720668143, “lastCheckedByUser”: {“id”: 964, “customerID”: 45, “userName”: “brownmatthew”, “name”: “Brian Weaver”}, “lastCheckTimestamp”: 529024452, “nextCheckTimestamp”: 310704273, “flags”: [“DELETED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Society yard cup push term.”, “messageTemplate”: “Identify person budget although officer least we.”, “field”: “Turn prove director current call technology no.”, “parameter”: {}, “timestamp”: 515172767}], “currentPage”: 123, “size”: 466}

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 = 'False', exclude: bool = 'False', required: bool = 'False', includeMappings: bool = 'False', includeComments: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', 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”: 882, “limit”: 114, “responseCode”: 200, “count”: 393, “data”: [{“id”: 719, “mappings”: [{“lastUpdatedTimestamp”: 125146401, “comments”: [{“timestamp”: 97224788, “comment”: “Choose relate force option.”}], “mappedTimestamp”: 656164389, “firstTriggeredTimestamp”: 247471690, “lastTriggeredTimestamp”: 40291557, “triggerAmount”: 684, “signature”: “Process face dark let son thus.”, “flags”: [“DEFAULT_BLOCK”]}], “comments”: [{“timestamp”: 1092197088, “comment”: “Create future bill finally color new.”}], “references”: [“Though rather buy series.”], “labels”: [“Sign several head their guy structure peace over.”], “info”: “Establish take challenge cost result whose stage.”, “description”: “Painting dinner mission while degree.”, “links”: [“Scene weight do girl.”], “createdByUser”: {“id”: 689, “customerID”: 767, “userName”: “dbarnes”, “name”: “Sandra White”}, “createdTimestamp”: 1189756469, “lastUpdatedByUser”: {“id”: 312, “customerID”: 440, “userName”: “garciabridget”, “name”: “Chase Norris”}, “lastUpdatedTimestamp”: 564309522, “lastCheckedByUser”: {“id”: 487, “customerID”: 510, “userName”: “burgesscharles”, “name”: “Mary Winters”}, “lastCheckTimestamp”: 1446630777, “nextCheckTimestamp”: 1132984629, “flags”: [“DISABLED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Show opportunity least natural tax.”, “messageTemplate”: “Manage around out.”, “field”: “Forward speak if other city within.”, “parameter”: {}, “timestamp”: 1086003361}], “currentPage”: 374, “size”: 88}

api.alarms.v1.category module

Autogenerated API

api.alarms.v1.category.get_categories(keywords: list = None, keywordField: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', 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”: 183, “limit”: 533, “responseCode”: 200, “count”: 541, “data”: [{“id”: 307, “info”: “Worker toward be husband sort carry close.”, “name”: “Edwin Clark”, “flags”: [“DELETED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Audience just each behind others.”, “messageTemplate”: “Main wind baby.”, “field”: “Each fall act home try by month.”, “parameter”: {}, “timestamp”: 1393600735}], “currentPage”: 401, “size”: 459}

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

Get category by Id (PUBLIC)

Return type:

dict

Parameters:

id (int) – ID of category

Raises:
Returns:

{“offset”: 419, “limit”: 795, “responseCode”: 200, “count”: 450, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Station central herself company after fact tough.”, “messageTemplate”: “Relationship media bag.”, “field”: “Reason decade skin special.”, “parameter”: {}, “timestamp”: 183193815}], “currentPage”: 672, “size”: 922}

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 = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', 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”: 19, “limit”: 962, “responseCode”: 200, “count”: 266, “data”: [{“id”: 216, “info”: “Attention fish once popular positive mission.”, “name”: “Bryan Campbell”, “flags”: [“DISABLED”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Avoid vote degree conference would move remain.”, “messageTemplate”: “Down lay box take stock question.”, “field”: “Happy president service why.”, “parameter”: {}, “timestamp”: 853508838}], “currentPage”: 116, “size”: 106}

api.alarms.v1.signature module

Autogenerated API

api.alarms.v1.signature.get_signatures(keywords: list = None, keywordField: list = None, keywordMatch: str = 'all', offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', 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”: 710, “limit”: 484, “responseCode”: 200, “count”: 248, “data”: [{“lastUpdatedByUser”: {“id”: 973, “customerID”: 139, “userName”: “mcdonaldjennifer”, “name”: “Patrick Brooks”}, “lastUpdatedTimestamp”: 1250111928, “comments”: [{“timestamp”: 768627410, “comment”: “Audience price change issue edge.”}], “mappedTimestamp”: 1190970539, “mappedByUser”: {“id”: 736, “customerID”: 561, “userName”: “amoore”, “name”: “Cody Baldwin”}, “firstTriggeredTimestamp”: 163652404, “lastTriggeredTimestamp”: 153406368, “triggerAmount”: 315, “signature”: “Ready keep get campaign.”, “flags”: [“SNORT”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “A market bring reflect look.”, “messageTemplate”: “Our myself upon former action ball early.”, “field”: “Fill yet more watch alone.”, “parameter”: {}, “timestamp”: 872435576}], “currentPage”: 155, “size”: 386}

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 = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', 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”: 523, “limit”: 589, “responseCode”: 200, “count”: 627, “data”: [{“lastUpdatedByUser”: {“id”: 387, “customerID”: 989, “userName”: “donaldgraham”, “name”: “Kristen Horne”}, “lastUpdatedTimestamp”: 512706881, “comments”: [{“timestamp”: 1046666458, “comment”: “Bill mean decision way.”}], “mappedTimestamp”: 261327939, “mappedByUser”: {“id”: 93, “customerID”: 550, “userName”: “markwhite”, “name”: “Scott Crosby”}, “firstTriggeredTimestamp”: 592656240, “lastTriggeredTimestamp”: 352926705, “triggerAmount”: 520, “signature”: “On see dark including care.”, “flags”: [“ISS_SIGNATURE”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Lead decide capital look agent but let painting.”, “messageTemplate”: “Thus public professor put head.”, “field”: “Worker another do put.”, “parameter”: {}, “timestamp”: 1136747933}], “currentPage”: 738, “size”: 125}

Module contents