signature#

Autogenerated API

argus_api.lib.alarms.v1.signature.delete_signatures(signature: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Delete signatures. They must not be mapped to any alarms. (INTERNAL)

Parameters
  • signature (list) – Signatures to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.alarms.v1.signature.get_signatures(keywords: str = None, keywordField: str = None, keywordMatch: str = 'all', limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Get all signatures. Alarm data is included if signature is mapped. (PUBLIC)

Parameters
  • keywords (list) – Search by keywords

  • keywordField (list) – Set field strategy for keyword search

  • keywordMatch (str) – Set match strategy for keyword search

  • limit (int) – Maximum number of returned signatures

  • offset (int) – Skip a number of signatures

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.alarms.v1.signature.search_signatures(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, attackCategoryID: int = None, alarmID: int = None, signature: str = None, minTriggerAmount: int = None, maxTriggerAmount: int = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, sortBy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Get all signatures matching a given search criteria (PUBLIC)

Parameters
  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • 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)

  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with fields. (default any)

  • 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)

  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how to match keywords with fields. (default all)

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON