type#

Autogenerated API

argus_api.lib.sensors.v1.type.add_sensor_type(shortName: str = None, name: str = None, url: str = None, department: str = None, reportingSeverity: str = None, expectedSensorUpdateTime: int = None, monitorCollectionOnly: bool = 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#

Create a new sensor type (INTERNAL)

Parameters

  • shortName (str) – Short name of Sensor Type, needs to be unique => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of sensor type => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • url (str) – URL of sensor type => ((https?|ftp|gopher|telnet|file):((/)|(\))+[wd:\#@%/;$()~_?\+-=\.&]*)

  • department (str) – Department that the sensor type belongs to (default none)

  • reportingSeverity (str) – Flag to determine escalation workflow for Sensors of this type (default medium)

  • expectedSensorUpdateTime (int) – Expected maximum update time duration in millis of sensor which belong to the type (default 0)

  • monitorCollectionOnly (bool) – Flag to determine whether sensors of this type are monitored by analysis or only by collection (default false)

  • 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.sensors.v1.type.delete_sensor_type(idOrShortName: str, newType: 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#

Delete a sensor type and update existing Sensors of that type to a new sensor type (INTERNAL)

Parameters

  • idOrShortName (str) – Sensor type ID or short name

  • newType (str) – Sensor type delete request

  • 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.sensors.v1.type.get_sensor_type(idOrShortName: 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#

Get sensor type by ID or short name (INTERNAL)

Parameters

  • idOrShortName (str) – Sensor type ID or short name

  • 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.sensors.v1.type.get_sensor_types(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 sensor types (INTERNAL)

Parameters

  • 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.sensors.v1.type.update_sensor_type(idOrShortName: str, shortName: str = None, name: str = None, url: str = None, expectedSensorUpdateTime: int = None, department: str = None, monitorCollectionOnly: bool = None, reportingSeverity: 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#

Update a sensor type (INTERNAL)

Parameters

  • idOrShortName (str) – Sensor type ID or short name

  • shortName (str) – New unique short name of the Sensor Type. => [a-zA-Z0-9_:\-.]*

  • name (str) – New name of the Sensor Type => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • url (str) – New URL of the Sensor Type => ((https?|ftp|gopher|telnet|file):((/)|(\))+[wd:\#@%/;$()~_?\+-=\.&]*)

  • expectedSensorUpdateTime (int) – Update expected Sensor update time for the Sensor Type

  • department (str) – Update department of the Sensor Type

  • monitorCollectionOnly (bool) – Flag to determine whether Sensors of this Type are monitored by analysis or only by collection

  • reportingSeverity (str) – Flag to determine escalation workflow for Sensors of this type

  • 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