sensor#

Autogenerated API

argus_api.lib.sensors.v1.sensor.acknowledge_sensor(sensorID: int, comment: 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#

Acknowledge a sensor by its ID (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to acknowledge

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.acknowledge_sensors(sensorID: int, comment: 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#

Acknowledge Sensors by their ID Any comment will be applied to ALL specified sensors. (INTERNAL)

Parameters

  • sensorID (list) – ID of sensors to acknowledge

  • comment (str) – Any comments to append to the request. NB: Each Sensor specified in the request will receive the same comment. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.add_comment(sensorID: int, comment: 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#

Add comment to a sensor (INTERNAL)

Parameters

  • sensorID (int) – SensorID

  • comment (str) – Any comments to append to the 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.sensor.bulk_cancel_sensor_downtime(sensorID: int, 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#

Cancels downtime for supplied sensorIDs (INTERNAL)

Parameters

  • sensorID (list) – Cancel downtime for these Sensor IDs

  • 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.sensor.bulk_schedule_sensor_downtime(fromTime: int = None, toTime: int = None, keepDowntimeOnUpdate: bool = None, comment: str = None, sensorIDs: 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#

Schedules downtime for provided sensorIDs (INTERNAL)

param int fromTime

Timestamp in epoch ms from which the requested change takes effect. (default now)

param int toTime

Timestamp in epoch ms until which the requested change takes effect.

param bool keepDowntimeOnUpdate

Flag to maintain existing downtime configurations.

If set, downtime will not automatically end when the Sensor registers a new event.
param str comment

Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

param list sensorIDs

IDs of the Sensors for which we want to schedule downtime.

param 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.

param verify

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

param apiKey

Argus API key.

param authentication

authentication override

param server_url

API base URL override

param body

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

param api_session

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

raises AuthenticationFailedException

on 401

raises AccessDeniedException

on 403

raises ObjectNotFoundException

on 404

raises ValidationErrorException

on 412

raises ArgusException

on other status codes

returns

dictionary translated from JSON

argus_api.lib.sensors.v1.sensor.bulk_update_contractual_status(sensorIDs: int = None, contractual: bool = None, comment: 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 Sensors’ contractual statusAny comment will be applied to ALL specified sensors.The operation will only return Sensors that were actually updated. (INTERNAL)

Parameters

  • sensorIDs (list) – IDs of Sensors to remove acknowledgement.

  • contractual (bool) – Whether to set or unset the Sensors’ contractual status

  • comment (str) – Any comments to append to the request. NB: Each Sensor specified in the request will receive the same comment. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.bulk_update_initial_tuning(sensorID: int, initialTuning: bool, comment: 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#

Bulk updating initial tuning property for Sensors by their IDs. If provided any comment will be applied to ALL updated sensors. (INTERNAL)

Parameters

  • sensorID (list) – ID of sensors to remove acknowledgement

  • initialTuning (bool) – Desired new Sensor initial tuning status

  • comment (str) – Any comments to append to the request. NB: Each Sensor specified in the request will receive the same comment. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.cancel_sensor_downtime(sensorID: int, 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#

Cancels downtime for supplied sensorID (INTERNAL)

Parameters

  • sensorID (int) –

  • 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.sensor.cluster_sensor(sensorID: int, clusterSensorID: 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#

Cluster sensor (INTERNAL)

Parameters

  • sensorID (int) – ID of the sensor to cluster

  • clusterSensorID (int) – Sensor with which we want to cluster

  • 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.sensor.create_sensor(sslTerminating: bool = None, location: str = None, customer: str = None, application: str = None, information: str = None, hostname: str = None, ipAddress: str = None, additionalData: str = None, reportingSeverity: str = None, clusterSensorID: int = None, expectedUpdateTime: int = None, scheduledDowntimeFromTime: int = None, scheduledDowntimeUntilTime: int = None, active: bool = None, monitored: bool = None, monitoredOnlyDaytime: bool = None, initialTuning: bool = None, overrideDefaultUpdateTime: bool = None, sharedCustomerData: bool = None, contractual: 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#

Creates a Sensor (INTERNAL)

param bool sslTerminating

param str location

Sensor Location ID or short name. The Location must be Global or belong to the same Customer as this Sensor.

param str customer

Sensor Customer ID or short name

param str application

Sensor type ID or short name

param str information

Sensor information

param str hostname

Sensor hostname. One of hostname or ipAddresss must be defined.

Attempts to create a Sensor with a duplicate hostname for the same customer will be rejected. If you need to make a Sensor with a duplicate hostname ensure the additional data field’s contents are unique.

=> Sanitize by regex ([p{Alnum}._-]+)
param str ipAddress

Sensor’s IP address, one of hostname or ipAddress must be assigned

Attempts to create a Sensor with a duplicate IP address for the same customer will be rejected. If you need to make a Sensor with a duplicate IP address ensure the additional data field’s contents are unique.

=> format:ip
param str additionalData

Any additional data

param str reportingSeverity

If specified overwrite the ReportingSeverity level for this Sensor’s Application

param int clusterSensorID

ID of the Sensor this new Sensor will be clustered with. 0 if unclustered. (default 0)

param int expectedUpdateTime

When the Sensor is expected to be updated, 0 if not known/never (default 0)

param int scheduledDowntimeFromTime

Time from which the Sensor will be offline, 0 if not scheduled (default 0)

param int scheduledDowntimeUntilTime

Time until which the Sensor will be offline, 0 if not scheduled (default 0)

param bool active

Sensor active flag (default false)

param bool monitored

Sensor monitored flag (default false)

param bool monitoredOnlyDaytime

Sensor is monitored only daytime flag (default false)

param bool initialTuning

Sensor’s initial tuning status (default false)

param bool overrideDefaultUpdateTime

Override default update time (default false)

param bool sharedCustomerData

Sensor’s shared customer data flag (default false)

param bool contractual

Whether the Sensor contributes to the customer’s contractual Sensor limit (default false)

param 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.

param verify

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

param apiKey

Argus API key.

param authentication

authentication override

param server_url

API base URL override

param body

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

param api_session

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

raises AuthenticationFailedException

on 401

raises AccessDeniedException

on 403

raises ValidationErrorException

on 412

raises ArgusException

on other status codes

returns

dictionary translated from JSON

argus_api.lib.sensors.v1.sensor.create_sensor_interface(sensorID: int, interfaceName: str = None, location: str = None, customer: str = None, comment: str = None, active: bool = None, sslTerminating: 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#

Adds an interface to a sensor (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to which we want to add the interface

  • interfaceName (str) – Name of the Sensor Interface. Must be unique per Sensor. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • location (str) – Location ID or short name of the Sensor’s Interface.

  • customer (str) – Customer id or shortname of the Interface.If neither the Interface nor Sensor’s Location is Global, the Interface and Sensor Customer must be the sameunless the shared data flag is set on the Sensor (default null)

  • comment (str) – Comment describing why the Interface was added

  • active (bool) – Status of the Sensor Interface (default false)

  • sslTerminating (bool) – Interface’s SSL terminating flag (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.sensor.decluster_sensor(sensorID: int, 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#

Decluster sensor (INTERNAL)

Parameters

  • sensorID (int) – ID of the sensor to decluster

  • 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.sensor.delete_interface(sensorID: int, interface: 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#

Deletes one of a Sensor’s interfaces by its ID or name (INTERNAL)

Parameters

  • sensorID (int) – ID of the sensor to which the interface belongs

  • interface (str) – ID of the interface

  • 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.sensor.delete_sensor(sensorID: int, 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 sensor by ID (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor 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.sensors.v1.sensor.delete_sensor_comment(sensorID: int, timestamp: int, 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#

Deletes a comment (INTERNAL)

Parameters

  • sensorID (int) – Delete comment from this sensor

  • timestamp (int) – Delete comment made at this timestamp

  • 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.sensor.delete_sensors(sensorIDs: int = None, comment: 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 sensors by ID (INTERNAL)

Parameters

  • sensorIDs (list) – IDs of Sensors we want to update.

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.disable_monitoring(sensorID: int, 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#

Disable sensor monitoring (INTERNAL)

Parameters

  • sensorID (int) – ID for sensor to disable monitoring

  • 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.sensor.disable_monitoring_bulk(sensorIDs: int = None, comment: 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#

Bulk disable sensor monitoring (INTERNAL)

Parameters

  • sensorIDs (list) – IDs of Sensors whose monitoring we want to update.

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.disable_sensor(sensorID: int, 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#

Deactivates a sensor (INTERNAL)

Parameters

  • sensorID (int) –

  • 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.sensor.disable_sensors(comment: str = None, sensorIDs: 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#

Bulk deactivation of Sensors (INTERNAL)

Parameters

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • sensorIDs (list) – IDs of Sensors to deactivate.

  • 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.sensor.enable_monitoring(sensorID: int, daytime: 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#

Enable sensor monitoring. To set daytime only monitoring use the ‘daytime’ queryParm. (INTERNAL)

Parameters

  • sensorID (int) – ID for sensor to enable monitoring

  • daytime (bool) – Daytime only monitoring flag

  • 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.sensor.enable_monitoring_bulk(sensorIDs: int = None, comment: str = None, daytime: 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#

Bulk enable sensor monitoring. To set daytime only monitoring use the ‘daytime’ queryParm. (INTERNAL)

Parameters

  • sensorIDs (list) – IDs of Sensors whose monitoring we want to update.

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • daytime (bool) – Daytime only monitoring flag

  • 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.sensor.enable_sensor(sensorID: int, 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#

Activates a sensor (INTERNAL)

Parameters

  • sensorID (int) –

  • 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.sensor.enable_sensors(comment: str = None, sensorIDs: 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#

Bulk activation of sensors (INTERNAL)

Parameters

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • sensorIDs (list) – IDs of Sensors to activate.

  • 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.sensor.get_comment(sensorID: int, 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#

DEPRECATED : get_comment is an alias for list_sensor_comments. Exists only for backward compatibility - do not use - use list_sensor_comments instead.

argus_api.lib.sensors.v1.sensor.get_comment_1(sensorID: int, timestamp: int, 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#

DEPRECATED : get_comment_1 is an alias for get_sensor_comment. Exists only for backward compatibility - do not use - use get_sensor_comment instead.

argus_api.lib.sensors.v1.sensor.get_interface(sensorID: int, interfaceNameOrID: 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#

Gets one of a Sensor’s interfaces (INTERNAL)

Parameters

  • sensorID (int) – ID of the sensor to which the interface belongs

  • interfaceNameOrID (str) – ID or name of the Interface

  • 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.sensor.get_interface_1(sensorID: int, interfaceNameOrID: 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#

DEPRECATED : get_interface_1 is an alias for get_interface. Exists only for backward compatibility - do not use - use get_interface instead.

argus_api.lib.sensors.v1.sensor.get_sensor(sensorID: int, 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#

Fetch sensor by ID (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to fetch

  • 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.sensor.get_sensor_1(sensorID: int, 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#

DEPRECATED : get_sensor_1 is an alias for get_sensor. Exists only for backward compatibility - do not use - use get_sensor instead.

argus_api.lib.sensors.v1.sensor.get_sensor_comment(sensorID: int, timestamp: int, 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#

Fetch comment by timestamp for sensor (INTERNAL)

Parameters

  • sensorID (int) – SensorID

  • timestamp (int) – Timestamp

  • 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.sensor.get_sensor_comments(sensorID: int, 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#

Fetch sensor comments by sensor ID (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to fetch comments for

  • limit (int) – Limit results

  • offset (int) – Offset results

  • 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.sensor.get_sensor_status(sensorID: int, 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#

DEPRECATED : get_sensor_status is an alias for get_sensor_status_by_sensor. Exists only for backward compatibility - do not use - use get_sensor_status_by_sensor instead.

argus_api.lib.sensors.v1.sensor.get_sensor_status_by_sensor(sensorID: int, 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#

Gets status for a sensor (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor whose status we want to fetch

  • 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.sensor.get_sensors(customerID: int = None, customer: str = None, applicationName: str = None, keywords: str = None, minExpectedUpdateTime: int = None, maxExpectedUpdateTime: int = None, 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#

List sensors (INTERNAL)

Parameters

  • customerID (list) – Limit search to these customer IDs

  • customer (list) – Limit search to these customer ids or shortname

  • applicationName (list) – Limit search to these applications by name

  • keywords (list) – Limit search by sensor hostname or IP address

  • minExpectedUpdateTime (int) – Filter by sensors with expectedUpdateTime at least this value in millis

  • maxExpectedUpdateTime (int) – Filter by sensors with expectedUpdateTime at most this value in millis

  • limit (int) – Limit results

  • offset (int) – Offset results

  • 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

requests.Response object or dictionary translated from JSON

argus_api.lib.sensors.v1.sensor.list_sensor_comments(sensorID: int, 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#

Fetch comments for sensor (INTERNAL)

Parameters

  • sensorID (int) – SensorID

  • limit (int) – Limit results

  • offset (int) – Offset results

  • 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.sensor.list_sensor_interfaces(sensorID: int, 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#

Gets a Sensor’s interfaces (INTERNAL)

Parameters

  • sensorID (int) – ID of the sensor to which the interface belongs

  • limit (int) – Limit results

  • offset (int) – Offset results

  • 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.sensor.list_sensors_1(customerID: int = None, customer: str = None, applicationName: str = None, keywords: str = None, minExpectedUpdateTime: int = None, maxExpectedUpdateTime: int = None, 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#

DEPRECATED : list_sensors_1 is an alias for get_sensors. Exists only for backward compatibility - do not use - use get_sensors instead.

argus_api.lib.sensors.v1.sensor.remove_acknowledgement_sensor(sensorID: int, comment: 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#

Remove acknowledgement for a sensor by its ID. (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to remove acknowledgment

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.remove_acknowledgement_sensors(sensorID: int, comment: 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#

Bulk remove acknowledgement for Sensors by their IDs. Any comment will be applied to ALL specified sensors. (INTERNAL)

Parameters

  • sensorID (list) – ID of sensors to remove acknowledgement

  • comment (str) – Any comments to append to the request. NB: Each Sensor specified in the request will receive the same comment. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.restore_sensor(sensorID: int, enable: 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#

Restore sensor by ID (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to restore

  • enable (bool) – Whether to enable the Sensor at the same time as restoring it. (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.sensor.restore_sensors(sensorIDs: int = None, comment: str = None, enable: 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#

Restore sensors by ID (INTERNAL)

Parameters

  • sensorIDs (list) – IDs of Sensors we want to update.

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • enable (bool) – Whether to enable the Sensors at the same time as restoring them. (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.sensor.schedule_sensor_downtime(sensorID: int, fromTime: int = None, toTime: int = None, keepDowntimeOnUpdate: bool = None, comment: 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#

Schedules downtime for supplied sensorID (INTERNAL)

param int sensorID

param int fromTime

Timestamp in epoch ms from which the requested change takes effect. (default now)

param int toTime

Timestamp in epoch ms until which the requested change takes effect.

param bool keepDowntimeOnUpdate

Flag to maintain existing downtime configurations.

If set, downtime will not automatically end when the Sensor registers a new event.
param str comment

Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

param 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.

param verify

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

param apiKey

Argus API key.

param authentication

authentication override

param server_url

API base URL override

param body

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

param api_session

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

raises AuthenticationFailedException

on 401

raises AccessDeniedException

on 403

raises ObjectNotFoundException

on 404

raises ValidationErrorException

on 412

raises ArgusException

on other status codes

returns

dictionary translated from JSON

argus_api.lib.sensors.v1.sensor.search_sensors(limit: int = None, offset: int = None, includeDeleted: bool = None, customerID: int = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, customer: str = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, minExpectedUpdateTimeInterval: int = None, maxExpectedUpdateTimeInterval: int = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, sensorID: int = None, locationName: str = None, applicationName: 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#

Search sensors (INTERNAL)

Parameters

  • limit (int) – Limit results

  • offset (int) – Offset results

  • includeDeleted (bool) – Also include deleted objects (where implemented)

  • customerID (list) – Limit result to objects belonging to these customers

  • keywords (list) – Search for sensors matching these hostnames or IP-addresses

  • keywordMatchStrategy (str) – Defines how strictly different keywords should be matched (default match any keywords) (default any)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (defaults to all supported fields) (default all)

  • customer (list) – Search for sensors belonging to customers identified by their ID or shortname

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any) (default any)

  • timeFieldStrategy (list) – Defines which timestamps fields will be filtered with start/endTimestamp (default lastUpdatedTimestamp)

  • minExpectedUpdateTimeInterval (int) – Filter sensors by min expected update time interval in millis

  • maxExpectedUpdateTimeInterval (int) – Filter sensors by max expected update time interval in millis

  • startTimestamp (int) – Search objects from this timestamp

  • endTimestamp (int) – Search objects until this timestamp

  • sortBy (list) – Order results by these properties (prefix with - to sort descending)

  • includeFlags (list) – Search objects with these flags set

  • excludeFlags (list) – Exclude objects with these flags set

  • sensorID (list) – Search for specific sensors by ID

  • locationName (list) – DEPRECATED: Use location instead.

  • applicationName (list) – Search for sensors by application 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

requests.Response object or dictionary translated from JSON

argus_api.lib.sensors.v1.sensor.submit_sensor_status_bulk(records: dict = None, ignoreOnFailed: 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#

Submit sensor status records in a bulk operation (INTERNAL)

Parameters

  • records (list) – Sensor status records for submission

  • ignoreOnFailed (bool) – If set to true submitted records with errors will be discarded and all remaining records will be processed. If set to false errors will fail the whole request. (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.sensor.update_initial_tuning(sensorID: int, initialTuning: bool, comment: 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 initial tuning property for a Sensor. (INTERNAL)

Parameters

  • sensorID (int) – ID of sensor to change initial tuning status

  • initialTuning (bool) – Desired new Sensor initial tuning status

  • comment (str) – Any comment to append to the request. If not specified the service will generate a generic one. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.sensor.update_interface(sensorID: int, interface: str, sslTerminating: bool = None, newInterfaceName: str = None, location: str = None, active: 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#

Update Interface by ID (INTERNAL)

Parameters

  • sensorID (int) – ID of the Sensor to which the Interface belongs

  • interface (str) – ID of the Interface we want to update

  • sslTerminating (bool) –

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

  • location (str) – New Location ID or short name of the Sensor Interface.

  • active (bool) – New Status of the Sensor interface

  • 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.sensor.update_sensor(sensorID: int, location: str = None, clusterSensorID: int = None, information: str = None, hostname: str = None, ipAddress: str = None, additionalData: str = None, application: str = None, expectedUpdateTime: int = None, reportingSeverity: str = None, initialTuning: bool = None, overrideDefaultUpdateTime: bool = None, sharedCustomerData: bool = None, sslTerminating: bool = None, contractual: 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#

Update sensor by ID (INTERNAL)

param int sensorID

ID of sensor to update

param str location

ID or shortname of the Sensor’s location

param int clusterSensorID

DEPRECATED: Deprecated. Please use the dedicated clustering endpoint(s) instead.

param str information

Sensor information

param str hostname

Sensor hostname.

Unless the Sensor’s additional data is unique the hostname must also be unique for its owning customer. If removing the hostname the Sensor must have a valid IP address.

=> Sanitize by regex ([p{Alnum}._-]+)
param str ipAddress

Sensor’s IP address.

Unless the Sensor’s additional data is unique the IP address must also be unique for its owning customer. If removing the IP address the Sensor must have a valid IP address.

=> format:ip
param str additionalData

Additional identifier

param str application

ID or shortname of Sensor type

param int expectedUpdateTime

Expected updated time, only set if overrideDefaultUpdateTime is true

param str reportingSeverity

If specified overwrite the ReportingSeverity level for this Sensor’s Application

param bool initialTuning

Sensor’s initial tuning status (default null)

param bool overrideDefaultUpdateTime

Sensor’s override default update time flag (default null)

param bool sharedCustomerData

Sensor’s shared customer data flag (default null)

param bool sslTerminating

Sensor’s SSL terminating flag (default null)

param bool contractual

Whether the Sensor contributes to the customer’s contractual Sensor limit (default null)

param 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.

param verify

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

param apiKey

Argus API key.

param authentication

authentication override

param server_url

API base URL override

param body

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

param api_session

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

raises AuthenticationFailedException

on 401

raises AccessDeniedException

on 403

raises ObjectNotFoundException

on 404

raises ValidationErrorException

on 412

raises ArgusException

on other status codes

returns

dictionary translated from JSON