Information about Domotz API current usage and usage limitsThe number of calls originated from that IP addressint32integerThe IP addressstringobjectarrayThe number of calls done using this key in the last 24 hoursint32integerThe ID of the API keyint32integerThe mnemonic API key namestringobjectarrayThe number of calls for the resourceint32integerThe base resource namestringobjectarrayNumber of allowed calls to the API in a minute.int32integerNumber of allowed calls to the API in a 24 hours span.int32integerNumber of API call performed in the last 24 hours. int32integerobjectBase abstract class for all devicesWhen defined the device requires authentication info to perform extended discovery <ul> <li> *REQUIRED*: the device requires authentication, extended discovery is locked </li><li> *PENDING*: credentials have been submitted but not verified yet </li><li> *WRONG_CREDENTIALS*: device authentication failed </li><li> *AUTHENTICATED*: device authentication succeeded </li></ul> NO_AUTHENTICATIONAUTHENTICATEDPENDINGREQUIREDWRONG_CREDENTIALSstring

DeviceDetailsstring256string256stringSet to null to reset and allow the automatically discovered serial number to be used for device32stringDeprecated. Please use <a href='#getsnmpauthentication'> getSNMPAuthentication </a>stringDeprecated. Please use <a href='#getsnmpauthentication'> getSNMPAuthentication </a>string256stringobject

stringdate-timestringint32integerVITALFLOATINGstringWhen true, the Domotz Collector is ignoring the device for all the automatic operations. The Domotz Collector will scan one time the device after its IP address change. An excluded device is listed on Device Blacklist section on webapp.booleanIn a clustered configuration, the main device idint32integerint32integerstringobjectDeviceOSstringstringstringobjectIPDUMMYIP_EXTERNALstringGet the status of SNMP service for the device <ul> <li> *CHECKING*: Indicates that Domotz is currently verifying the SNMP status on the device. This is a transient state. </li><li> *NOT_FOUND*: This status indicates that the SNMP service could not be found on the device. </li><li> *NOT_AUTHENTICATED*: This status occurs when the SNMP service is detected as active, but Domotz is unable to retrieve data from it. This is most likely due to incorrect community strings or credentials. </li><li> *AUTHENTICATED*: This status indicates that Domotz is successfully reading SNMP data from the device. </li></ul> CHECKINGNOT_FOUNDNOT_AUTHENTICATEDAUTHENTICATEDstringThe device type, if recognised by domotzint32integerint32integerstringobject100string64stringint32integer100stringobjectdisplay_nameidprotocolobjectAn activity log itemDescription of the eventstring

TrueAdditional details of the eventobject

Device that triggered the event (if applicable)int32integerTimestamp of the eventdate-timestringType of the eventnoteagent_alert_level_setagent_alert_resumertd_session_startcresnet_node_rebootdevice_rebootfirmware_update_startapplications_terminateconfiguration_restorefactory_resetnetwork_configuration_changecustom_driver_executeremote_session_startremote_session_terminateremote_session_limit_reachedvpn_session_startvpn_session_terminatechat_startedchat_resolvedoperator_joinedoperator_leftpower_onpower_offpower_cyclecamera_snapshotcamera_streaming_startconfiguration_management_status_changestringUser who triggered the eventstringdescriptiontimestamptypeuserobjectIf `false` the collector plan doesn't allow for API access: you only can see this collector in the listbooleanemailstringobject<ul><li> *OWNED*: you own this collector </li><li> *PROPOSED*: the owner proposed you to access the collector, you can accept or reject the offer </li><li> *GRANTED*: you accepted the collaboration request for this collector </li><li> *ASSIGNED*: your team leader has given you access to the collector </li></ul>OWNEDGRANTEDPROPOSEDASSIGNEDstringobjectdate-timestringstringint32integerstringstringobjectdate-timestringThe MAC address of the primary interface of the device the software collector runs onstringstringdate-timestringint32integerobject^-?\d+(\.\d{8})?$string^-?\d+(\.\d{8})?$stringobjectint32integerstringobjectdate-timestringONLINEOFFLINEstringobjectThe Team and Company Area information, only available for companiesint32integerobjectint32integerint32integerstringobjectstringstringstringobjectstringstringobjectdisplay_nameidobject<__ref>#/components/schemas/AgentBaseThe local IP and port the Domotz Agent software is listening on if online - the last known value otherwisestring^-?\d+(\.\d{8})?$string^-?\d+(\.\d{8})?$stringobjectstringstringobjectobjectThe list of applications of all devices belonging to the collectorstringstringdate-timestringstringdate-timestringstringdate-timestringdate-timestringstringstringstringapplication_iddevice_idfirst_time_seenobjectThe representation of a device variableThe creation time of the variabledate-timestringThe ID of the deviceint32integerIf true the history of the variable can be retrieved with <a href='#getvariablehistory'> getVariableHistory</a>booleanThe ID of the variableint32integerThe labelstringThe metricstringThe variable pathstringThe previous value of the variablestringThe unit of measurementstringThe variable valuestringThe update time of the variable valuedate-timestringdevice_idhas_historyidpathobjectEnable/disable this scan methodbooleanenabledobjectEnable/disable this scan method. The collector sends a TCP packet with only the acknowledgement (ACK) flag set, and a responding reset (RST) packet from the host reveals its presence.booleanThe list of TCP port to be scanned with this method. The list cannot be empty if this method is enabledint32integerarrayenabledportsobjectEnable or disable this scan method. The collector sends a SYN packet to the target host and waits for a response. If the target responds with a SYN/ACK packet or an RST packet, the host is considered up.booleanThe list of TCP port to be scanned with this method. The list cannot be empty if this method is enabledint32integerarrayenabledportsobjectobjectThe time the sample was reported to Domotzdate-timestringThe collector event typeCONNECTION_RECOVEREDCONNECTION_LOSTUPDOWNstringtimestamptypeobjectThe list of IP addresses always checked by the collector. By default the list is empty and the collector performs hosts discovery automatically. The addresses must be expressed in dotted decimal notation and must belong to private networks (see <a href='https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml/'>iana-ipv4-special-registry</a>)stringarrayThe list of IP address ranges always checked by the collector. By default the list is empty and the collector performs hosts discovery automatically. The addresses must be expressed in dotted decimal notation and must belong to private networks (see <a href='https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml/'>iana-ipv4-special-registry</a>)192.168.1.10string192.168.1.1stringendstartobjectarrayforced_ip_addressesforced_ip_rangesobjectallowdenystringRules can be expressed as lists of case-insensitive strings representing the names of the interfaces to be matched. The `*` wildcard can be used to match variable parts of the interface name. Example: `["eth*", "tun0"]`stringarraypolicyrulesobjectResponse model for agent interfaces API.Attached network interfaces<__ref>#/components/schemas/AttachedInterfaceModelarrayRouted network interfaces<__ref>#/components/schemas/RoutedInterfaceModelarrayobjectint32integerstringobjectarraystringobjectTriggered when gateway, DNS servers, DHCP servers change<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integerstringarraystringarrayobjectstringarraystringarrayobjectstringstringobjectagent_idobjectagent_lan_changestringThe timestamp of the eventdate-timestringnametimestampobjectTriggered when Domotz detects a security issue<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integerint32integerTCP_OPEN_PORTUPNP_IGD_FORWARDUPNP_IGD_SERVICEstringobjectarrayobjectagent_security_issuestringThe timestamp of the eventdate-timestringnametimestampobjectTriggered when the measured Internet speed goes below the defined threshold<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integerSPEED_TEST_ISSUE_DETECTEDSPEED_TEST_ISSUE_RESOLVEDstringThe configured download thresholdint32integerThe configured upload thresholdint32integerobjectThe measured download valueint32integerThe measured upload valueint32integerobjectobjectagent_speed_teststringThe timestamp of the eventdate-timestringnametimestampobjectTriggered when the collector connectivity status changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integerUPDOWNstringobjectagent_statusstringThe timestamp of the eventdate-timestringnametimestampobjectint32integerdate-timestringdate-timestringobjectarrayint32integerint32integerThe uptime percentage of the collectorstringagent_idonline_secondstotal_secondsuptimeobjectCurrent VPN connection consumption (bytes) int32integerdate-timestringdate-timestringThe ID of the VPN connectionint32integerThe user that started the VPN connectionstringThe status of the vpn connectionACTIVEINACTIVEEXPIREDstringbytescreation_timeexpiration_timeidnamestatusobjectThe only public IP address allowed to access the connection. It will be impossible to use the connection from other IP addresses. You should use your public IP address. ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$stringThe traffic routing policy for the VPN connection: </br>- *global*: All the traffic is routed through the VPN On Demand. More consumption on the Domotz Cloud </br>- *local*: Only LAN traffic passes through the VPN On Demand. Less consumption on the Domotz Cloud globallocalstring1The duration in hours of the connection.int32241integerallowed_iprouting_policyobjectThe representation of a collector variableThe creation time of the variabledate-timestringIf true the history of the variable can be retrieved with <a href='#getvariablehistory'> getVariableHistory</a>booleanThe ID of the variableint32integerThe labelstringThe metricstringThe variable pathstringThe previous value of the variablestringThe unit of measurementstringThe variable valuestringThe update time of the variable valuedate-timestringhas_historyidpathobjectTriggered when ISP or Public IP address changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer

string

stringobject

string

stringobjectobjectstringstringstringstringobjectstringstringstringstringobjectobjectagent_idobjectagent_wan_changestringThe timestamp of the eventdate-timestringnametimestampobjectThe description of the alert profilestringThe list of events associated to the profiledevice_status_updevice_status_downdevice_heartbeat_lostdevice_ip_changedevice_snmpdevice_tcpdevice_rtddevice_configuration_changedevice_configuration_misalignmentagent_feature_discoveryagent_status_upagent_status_downagent_speed_testagent_device_discoveryagent_security_issueagent_wan_changeagent_lan_changestringarrayThe id of the event profileint32integertrue if the event profile is enabled, false otherwisebooleanThe symbolic name associated to the profilestringA label associated to the profilestringidobjectThe id of the alert profileint32integeralert_profile_idobjectThe id of the alert profileint32integerint32integeralert_profile_iddevice_idobjectRepresents an area of the CompanyThe identifier of the Areaint32integerThe name of the AreastringidnameobjectModel representing an attached network interface on the collector.

IP address of the interfacestring

MAC address of the interfacestringInterface namestringNetwork maskinteger4095.00.0integernullVLAN ID if availablenamemac_addressaddressnetmaskobjectCurrent connection consumption (bytes) int32integerMaximum connection consumption (bytes) int32integercurrentlimitobjectThe only public IP address allowed to access the connection. It will be impossible to use the connection from other IP addresses. You should use your public IP address. ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$stringThe time after which the connection will be closeddate-timestringThe unique identifier of the `connection`int32integerEither the link to access the device's HTTP(s) interface in the browser or the host/port coordinates of the proxied TCP port, depending on the protocol (see protocol description in the request)stringint32655350integerThe protocol wrapped by the connection: </br>- *http/https*: the `link` field in the reply will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. If the protocol is `https` the device's certificate will be accepted without checks and its information ignored (our server will act as a proxy). </br>- *tcp*: the `link` field will be in the form `tcp://{host}:{port}`. Any connection established (e.g. with `telnet` or `ssh`) on these coordinates will be securely forwarded to the requested `port` of the device. </br>- *ssh*: the `link` field will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. </br>- *rdp*: the `link` field will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. httphttpstcpsshrdpstringallowed_ipidportprotocolobject<b>Possible values:</b> gray, light-blue, dark-green, yellow, red, purple, blue, orange, pink, greenstringstringnamecolorobjectA Custom Driver that can be applied on devicesResult of the Custom Driver code analysisA list of functions of the {CUSTOM_DRIVER} that save data. Only a one of these can be executed on the same device at a time.stringarrayTrue if the Custom Driver creates independent variables on executionbooleanTrue if the Custom Driver uses parameters during executionbooleanTrue if the Custom Driver creates a variable table on executionbooleandata_saving_functionshas_independent_variableshas_parametershas_tableobjectDescription of the Custom DriverstringList of the device IDs the Custom Driver is applied onint32integerarrayThe identifier of the Custom Driverint32integerTrue if the Custom Driver has valid code, False otherwisebooleanThe minimal sampling interval of the Custom Driver (in seconds)int32integerName of the Custom DriverstringTrue if the Custom Driver requires credentials to run, False otherwisebooleanThe Custom Driver type. Driver usage differs between types such as data collection and/or available actionsGENERICCONFIGURATION_MANAGEMENTstringcode_inspectiondevice_idsidis_validminimal_sample_periodnamerequires_credentialstypeobjectAn association between a Custom Driver and a deviceThe id of the Custom Driverint32integerThe id of the device the Custom Driver is applied toint32integerThe id of the associationint32integerThe last time (datetime) the device inspection was executeddate-timestringParameters used in the associationThe id of the parameter on the driver levelint32integerDescription of the parameterstringThe identifier by which the parameter is called in the driver scriptstringValue of the parameter used for the association. In case it is not set on the association level, the Custom Driver default is shown. Empty if the parameter was added to the Custom Driver without a default value after the association was createdValue type of the parameter. Numbers are treated as floats, list items are treated as stringsSTRINGNUMBERLISTstringcustom_driver_parameter_idnamevalue_typeobjectarrayThe sampling interval of the Custom Driver (in seconds)int32integer<ul><li> *ENABLED*: The association is enabled and running </li><li> *DISABLED*: The association is disabled due to failure </li></ul>ENABLEDDISABLEDstringThe number of variables used by this Custom Driver associationint32integercustom_driver_iddevice_ididlast_inspection_timesample_periodstatusused_variablesobjectProperties for associating a Custom Driver and a deviceThe credentials for the Custom Driver (with scope CUSTOM_DRIVER_MANAGEMENT). Only required if the driver requires credentials, and there are none saved for the devicepasswordstringusernamestringpasswordusernameobjectA list of parameters to be used for the association. Only required if the Custom Driver uses parameters. Parameters with default values at the driver level can be skipped.The id of the parameter on the driver levelint32integerValue of the parameter for the association. Its type can be either a float, a string or a list based on its value_type. The following restrictions apply based on the value type: <ul><li>STRING: maximum 100 characters</li><li>LIST: maximum 50 items, maximum 100 characters each</li></ul>custom_driver_parameter_idobjectarrayThe sampling interval of the Custom Driver (in seconds). Must be one of [300, 600, 900, 1800, 3600, 7200, 21600, 43200, 86400] and equal to or greater than the minimal_sample_period of the Custom Driver. Default value is the minimal_sample_period of the Custom Driverint32integerobjectThe outcome of applying a Custom Driver to a deviceDescription of the error that occurred. Returned in case of failure.stringThe id of the newly created association. Returned in case of success.int32integerobjectCreation data for multiple association parametersThe id of the parameter on the driver levelint32integerValue of the parameter for the association. Its type can be either a float, a string or a list based on its value_type. The following restrictions apply based on the value type: <ul><li>STRING: maximum 100 characters</li><li>LIST: maximum 50 items, maximum 100 characters each</li></ul>custom_driver_parameter_idobjectarrayparametersobjectDetailed information for a Custom Driver that can be applied on devicesA list of the custom actions that can be executed by this Custom Driver (empty if none exist)Detailed description of the custom driver actionstringIdentifier of the custom driver action. Used in execution API Values range 1-30 depending on defined actions in the driver codeint32integerThe label of the action, shown as the button label in the ui when the driver is applied to a devicestringLine number of the function declaration for the actionint32integerdocumentationidlabellineobjectarrayThe source code of the driverstringResult of the Custom Driver code analysisA list of functions of the {CUSTOM_DRIVER} that save data. Only a one of these can be executed on the same device at a time.stringarrayTrue if the Custom Driver creates independent variables on executionbooleanTrue if the Custom Driver uses parameters during executionbooleanTrue if the Custom Driver creates a variable table on executionbooleandata_saving_functionshas_independent_variableshas_parametershas_tableobjectDescription of the Custom DriverstringA list of errors in this driver's code. Only returned if the driver's code is invalid and cannot be executedThe line number in the code that raised the error.int32integerError messagestringType of the errorstringtypeobjectarrayThe identifier of the Custom Driverint32integerTrue if the Custom Driver has valid code, False otherwisebooleanThe minimal sampling interval of the Custom Driver (in seconds)int32integerName of the Custom DriverstringA list of parameters used by this Custom Driver. Only returned if the driver has parameters definedDefault value of the parameter. Its type can be either a float, a string or a list based on its value_type.Description of the parameterstringUnique idint32integerThe identifier by which the parameter is called in the driver scriptstringValue type of the parameter. Numbers are treated as floats, list items are treated as stringsSTRINGNUMBERLISTstringidnamevalue_typeobjectarrayTrue if the Custom Driver requires credentials to run, False otherwisebooleanThe Custom Driver type. Driver usage differs between types such as data collection and/or available actionsGENERICCONFIGURATION_MANAGEMENTstringactionscodecode_inspectionidis_validminimal_sample_periodnamerequires_credentialstypeobjectOptions provided to a Custom Driver execution commandIf false, the Custom Driver variables will be persisted in history. Defaults to truebooleanobjectThe result of a Custom Driver execution commandThe time it took to Execute the Custom Driver Action (in milliseconds)int32integerExpanded description of the errorType returned in a failed Custom Driver ExecutionstringShort name of the error returned with a failed outcome of the Custom Driver ExecutionstringList of log messages generated during the Custom Driver ExecutionstringarrayundefinedOutcome from the Custom Driver ExecutionsuccessfailureundefinedstringoutcomeobjectWhen set to 'true', the collector will create devices that initiate DHCP requests even if they fail to obtain an IP addressbooleandhcp_device_discoveryobjectA device type, detected by the Domotz device identification featureThe features of the devicestringarrayAn unique identifier of the type, referred in the `Device` entityint32integerThe name of the typestringA human-readable short description of the typestringThe corresponding `device type` int32integerobjectThe list of applications of a devicestringdate-timestringstringdate-timestringstringdate-timestringdate-timestringstringstringstringapplication_idfirst_time_seenobjectA device type, either set by the user or as identified by the Domotz systemAn unique identifier of the type, referred in the `Device` entityint32integerThe name of the typestringA human-readable short description of the type stringWhether a device of this type will be marked as `VITAL` as soon as recognisedbooleanobject<__ref>#/components/schemas/DeviceConfigurationMetadataA device configurationThe running configurationstringThe startup configuration, skipped if not saved or if it is the same as the running configurationstringrunningobjectTriggered when the device configuration changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerdevice_idobjectdevice_configuration_changestringThe timestamp of the eventdate-timestringnametimestampobjectDevice configuration data to create a backupHuman readable configuration labelstringBase64 encoded running configurationstringOptional base64 encoded startup configurationstringlabelrunningobjectA backed up device configuration metadataHuman readable configuration labelstringMD5 hash of the running configurationstringMD5 hash of the startup configurationstringTimestamp of when the backup was made in ISO format (%Y-%m-%dT%H:%M:%S%z)stringlabelrunning_md5timestampobjectTriggered when the device configuration becomes different from the startup one<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerdevice_idobjectdevice_configuration_misalignmentstringThe timestamp of the eventdate-timestringnametimestampobjectThe only public IP address allowed to access the connection. It will be impossible to use the connection from other IP addresses. You should use your public IP address. ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$stringint32655350integerThe protocol wrapped by the connection: </br>- *http/https*: the `link` field in the reply will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. If the protocol is `https` the device's certificate will be accepted without checks and its information ignored (our server will act as a proxy). </br>- *tcp*: the `link` field will be in the form `tcp://{host}:{port}`. Any connection established (e.g. with `telnet` or `ssh`) on these coordinates will be securely forwarded to the requested `port` of the device. </br>- *ssh*: the `link` field will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. </br>- *rdp*: the `link` field will contain an `https` URL. A browser or a similar user agent must be used: the client must have cookies enabled and the capability of following 302 redirects. httphttpstcpsshrdpstring1The duration in hours of the connection.int32241integerallowed_ipportprotocolobjectpasswordstringDEVICE_MANAGEMENTThe Scope for the Credentials. Default is 'DEVICE_MANAGEMENT' used for device integrationsCUSTOM_DRIVER_MANAGEMENTCONFIGURATION_MANAGEMENTDEVICE_MANAGEMENTOS_MANAGEMENTstringusernamestringpasswordusernameobjectTriggered when a new device appears on the network<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerobjectagent_device_discoverystringThe timestamp of the eventdate-timestringnametimestampobjectstringThe time the sample was reported to Domotzdate-timestringstringtimestampvalueobjectTriggered when a device does not respond to a ping<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerdevice_idobjectdevice_heartbeat_loststringThe timestamp of the eventdate-timestringnametimestampobject

The new IP addressesstringarrayThe old IP addressesstringarrayobject

The time the sample was reported to Domotzdate-timestringThe device event typeIP_CHANGECREATEDUPDOWNstringtimestamptypeobjectTriggered when the device IP address changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerThe list of previous IP addressesstringarrayThe list of new IP addressesstringarraydevice_idobjectdevice_ip_changestringThe timestamp of the eventdate-timestringnametimestampobjectA device inventory fielddate-timestringThe name of the field, unique in the Inventory251/^[a-z][a-z0-9_-]{0,24}]$/string255stringkeyvalueobjectThe value that the device monitoring state will assumeMANAGEDUNMANAGEDstringmonitoring_stateobjectPower outlet of a deviceTrue if power actions can be executed on the outletbooleanName of the outlet assigned by the userstringUnique identifier of the device the outlet belongs toint32integerUnique identifier of the outletstringList of device ids attached to the outletint32integerarrayName of the outlet discovered automaticallystringThe current power state of the outletONOFFunknownstringcan_writedevice_ididlinksnamepowerobjectOutlet update dataCustom name to assign to the outletstringobjectIndicates that a power cycle on the device is possible. Available if the device is connected to just one PDU.booleanIndicates that the device can be powered off. Available if the device is connected to one or more PDU. <br><br> In the latter case the operation will be performed on all available PDUs.<br><br> If there no PDU but there is one POE connection, the operation will still be available through that connection.<br><br>booleanIndicates that the device can be powered on. Available if the device is connected to one or more PDU. <br><br> In the latter case the operation will be performed on all available PDUs.<br><br> If there is no PDU but there is one POE connection, the operation will still available through that connection.booleanIndicates that software reboot on the device is possible.<br><br> The operation availability depends on the device.booleanobjectThe time the device profile was createddate-timestringDevice profile descriptionstringDevice profile idint32integerThe last time the device profile was editeddate-timestringThe user that edited the device profileUser idint32integerUsernamestringobjectThe list of modules associated to the device profilethe mode used to apply the module configurationREPLACEADDITIVEstringThe time the device profile module was addeddate-timestringModule idint32integerModule statusbooleanThe last time the device profile module was editeddate-timestringModule typeINFOSHARED_ALERTSNMP_CUSTOM_OIDSNMP_PRECONFIGURED_SENSORTCP_SENSORstringapply_modecreation_timeidis_activelast_modifiedmodule_typeobjectarrayDevice profile namestringcreation_timedescriptionidlast_modifiedmodified_bymodulesnameobjectThe list of device ids on which to apply the device profileint32integerarraydevice_idsobjectint32integer^-?\d+(\.\d{1})?$string^-?\d+(\.\d{1})?$string^-?\d+(\.\d{1})?$stringint32integerThe time the sample was reported to Domotzdate-timestringtimestampobjectTriggered when the Round-Trip-Delay values of a device exceeds the defined thresholds<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerRTD_ISSUE_DETECTEDRTD_ISSUE_RESOLVEDstringThe configured latency thresholdint32integerThe configured packet loss percentage thresholdint32integerobjectThe current latency valueint32integerThe current packet loss percentage valueint32integerobjectdevice_idobjectdevice_rtdstringThe timestamp of the eventdate-timestringnametimestampobject^-?\d+(\.\d{1})?$string^-?\d+(\.\d{1})?$string^-?\d+(\.\d{1})?$stringint32integerThe number of lost packets of the latest collection sampleint32integerThe median value of the latest collection sample^-?\d+(\.\d{1})?$stringThe number of sent packets of the latest collection sampleint32integerThe timestamp of the latest updatedate-timestringdevice_idtimestampobjectTriggered when the status of an SNMP value changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerThe current enum value of the SNMP sensor if the OID is of type enumstringstringThe current value of the SNMP sensorstringdevice_idobjectdevice_snmpstringThe timestamp of the eventdate-timestringnametimestampobjectDefines new read snmp communitystringDefines new write snmp community (defaults to read community if not used)stringreadobjectTriggered when the status of a device changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerUPDOWNstringdevice_idobjectdevice_statusstringThe timestamp of the eventdate-timestringnametimestampobjectTriggered when the status of a monitored TCP service changes<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerint32integerUPDOWNstringobjectarraydevice_idobjectdevice_tcpstringThe timestamp of the eventdate-timestringnametimestampobjectstringintegerstringidnamecolorobjectThe uptime percentage of the collectorstringdate-timestringdate-timestringobjectarrayint32integerint32integerThe uptime percentage of the devicestringagent_uptimeonline_secondstotal_secondsuptimeobjectThe representation of a device variableThe creation time of the variabledate-timestringIf true the history of the variable can be retrieved with <a href='#getvariablehistory'> getVariableHistory</a>booleanThe ID of the variableint32integerThe labelstringThe metricstringThe variable pathstringThe previous value of the variablestringThe unit of measurementstringThe variable valuestringThe update time of the variable valuedate-timestringhas_historyidpathobjectInformation about Domotz Sensors current usage and limitsNumber of allowed Domotz Sensors for the collectorint32integerNumber of configured Domotz Sensors of type `snmp` on the collector.int32integerNumber of configured Domotz Sensors of type `tcp` on the collector.int32integerNumber of configured Domotz Sensors on the collector.int32integerobjectobjectInformation about Domotz Sensors current usage and limitsNumber of allowed Domotz Sensors for the collectorint32integerNumber of configured Domotz Sensors of type `custom driver` on the collector.int32integerNumber of configured Domotz Sensors of type `snmp` on the collector.int32integerNumber of configured Domotz Sensors of type `tcp` on the collector.int32integerNumber of configured Domotz Sensors on the collector.int32integerobjectobject<__ref>#/components/schemas/AbstractDeviceA device that has no network access whatsoever and cannot be discovered or interacted with by the collector. A user can create a Dummy Device to attach it to a power outlet so that it is easier to remember which port controls the deviceobjectHostname or IP AddressstringDevice Namestringhostnameobject<__ref>#/components/schemas/IpDeviceA device added by the means of 'Advanced Monitoring': it is an IP device manually added by the user, no discoveries are done over it, just periodical ping to see whether it is reachablestringstringobjectobjectTriggered when a new feature is discovered on a device<__ref>#/components/schemas/AgentBaseThe `id` of the `collector`int32integer<__ref>#/components/schemas/AbstractDeviceThe `id` of the `device`int32integerThe discovered featuremib_discoverystringTrueobjectobjectobjectagent_feature_discoverystringThe timestamp of the eventdate-timestringnametimestampobject<__ref>#/components/schemas/ValidationErrorarrayobject<__ref>#/components/schemas/WriteInventoryFieldDTO Returned by the API describing an Inventory Fielddate-timestringThe `id` of the user that defined the inventory field - if different from your id, this field can't be deleted or changedint32integerThe name of the field, unique in the Inventory251/^[a-z][a-z0-9_-]{0,24}]$/stringkeyobject<__ref>#/components/schemas/AbstractDeviceBase abstract class for all IP devicesWhen `true` the device is reachable by the collector over an IP network. When `false` Domotz knows about the status of the device by the means of another source e.g. a third party controller. This field is significant only when the status of the device is `ONLINE` and its value is `false` because it means that even if the IP device is up and running, many features aren't allowed, such as the direct connection or the TCP services monitoring.booleanThe number of seconds a device must be unreachable before being declared DOWNint32integer^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$stringarraydate-timestring255stringThe list of TCP and UDP open ports. Domotz scans a subset of all the ports, visit the <a href='https://help.domotz.com/user-guide/device-tcp-udp-ports-services-discovery/'>user guide</a> for more details.int32integerarrayint32integerarrayobjectONLINEOFFLINEDOWNHIDDENstring100stringobject<__ref>#/components/schemas/IpDeviceStandard device, automatically discovered in the local IP network of the collector.MAC AddressstringWhen true, the Domotz Agent is blocking the device to access the Internet. The device can still reach every other device in the local networkbooleanstringstringstringstringstringstringstringstringobjectobject<__ref>#/components/schemas/FeatureDiscoveryEventTriggered when a new feature MIB is discovered on a device<__ref>#/components/schemas/AgentBase<__ref>#/components/schemas/AbstractDeviceThe discovered MIBstringarrayobjectobjectobjectobjectA minimal representation of a device, containing only the most essential fields.stringdate-timestringint32integer^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$stringarraystring100stringIPDUMMYIP_EXTERNALstringThe device type, if recognised by domotzint32integerint32integerstringobject100stringdisplay_nameidprotocolobjectTriggered when a monitoring profile state changes<__ref>#/components/schemas/AgentBase

Trueobject

<__ref>#/components/schemas/AbstractDevicestringstringstringnameobjectstringstringobjectTrueobjectTrueobjectobject<__ref>#/components/schemas/DeviceVariablemetricobjectmonitoring_profile_state_changedstringThe timestamp of the eventdate-timestringnametimestampobjectA Network Speed Sample is the result of the measurement of the Internet download and upload speed, in bits per second, taken by the AgentThe time the sample was reported to Domotzdate-timestringA pair of values: the download and upload speed, in Bit Per Seconds (bps), as measured by the Agentint32integerarrayobjectThe list of edges. Each item contains the IDs of the connected devices.int32integerint32integerfromtoobjectarrayedgesobjectModel representing a routed network interface on the collector.

IP address of the interfacestring

Interface namestringNetwork maskintegernameaddressnetmaskobject

string

stringint32integeraddressnamenetmaskobjectInformation about a configured SNMP Domotz SensorThe category of the OIDOTHERCONSUMABLECPUDISK_SPACEMEMORYNETWORK_TRAFFICTEMPERATUREstringThe unique identifier of the deviceint32integerThe ID of the SNMP Domotz Sensorint32integerThe name of the Domotz SensorsstringThe OID stringstringThe type of the OIDSTRINGNUMERICENUMstringcategoryidnameoidvalue_typeobjectThe SNMP authentication setting of a devicestringThe SNMP authentication protocolMD5SHASHA-224SHA-256SHA-384SHA-512stringstringThe SNMP encryption protocolDESAESAES-256BAES-256RstringstringstringstringThe configured SNMP versionV2V1V3_AUTH_PRIVV3_NO_AUTHV3_AUTH_NO_PRIVstringversionobjectInformation about a configured SNMP Domotz SensorThe category of the OIDOTHERCONSUMABLECPUDISK_SPACEMEMORYNETWORK_TRAFFICTEMPERATUREstringThe unique identifier of the deviceint32integerThe ID of the SNMP Domotz Sensorint32integerThe timestamp of the latest updatedate-timestringThe enum value retrieved on the OIDstringThe value retrieved on the OIDstringThe name of the Domotz SensorsstringThe OID stringstringThe type of the OIDSTRINGNUMERICENUMstringcategoryidlast_updatelatest_valuenameoidvalue_typeobjectSNMP Domotz Sensor DataThe category of the OIDOTHERCONSUMABLECPUDISK_SPACEMEMORYNETWORK_TRAFFICTEMPERATUREstringThe name of the Domotz SensorsstringThe OID stringstringThe type of the OIDSTRINGNUMERICENUMstringcategorynameoidvalue_typeobjectInformation about a triggerThe alerts detailsTrue if the email alert is activebooleanTrue if the mobile alert is activebooleanobjectdate-timestringThe unique identifier of the function assigned to the triggerint32integerThe unique identifier of the SNMP Triggerint32integerThe name of the triggerstringThe operands for the functionstringarrayfunction_ididnameoperandsobjectInformation about a trigger functionThe number of arguments of the functionint32integerThe unique identifier of the SNMP Trigger functionint32integerThe name of the functionstringThe type of the operandsSTRINGNUMERICENUMstringcardinalityidnamevalue_typesobjectSNMP Trigger AlertobjectSNMP TriggerThe unique identifier of the sensor functionint32integerThe name of the triggerstringThe operands for the functionstringarrayfunction_idnameoperandsobject<__ref>#/components/schemas/IpDeviceA device automatically discovered by the collector that exists in an IP subnet defined by the user. The collector reaches the device through a Level 3 switch or similar device, so it cannot get the MAC address or other level 2 information, such as DHCP lease data stringstringstringstringstringobjectobjectInformation about a configured TCP sensorThe unique identifier of the deviceint32integerThe ID of the TCP sensorint32integerThe timestamp of the latest updatedate-timestringThe port numberint32integerThe status of the TCP serviceUPDOWNstringidlast_updateportstatusobjectTCP sensor DataThe port numberint32integerportobjectstringintegerintegerstringidnamecolordevice_countobjectRepresents a team of the CompanyThe identifier of the Teamint32integerThe name of the TeamstringidnameobjectTeam Creation under specified AreaThe Team Leader

The Team Leader's detailsThe Team Leader's display namestringdisplay_nameobject

The Team Leader's namestringThe Team Leader's passwordstringdetailsnamepasswordobjectThe Team's namestringleadernameobjectint32integerstringobject<__ref>#/components/schemas/TagResponseModelarraytagsobjectobjectstringintegerarraystringstringlocmsgtypeobjectThe time the sample was reported to Domotzdate-timestringThe sample valuestringtimestampvalueobjectDTO Used for creating/updating Inventory fieldsA detailed description of the field, for documentation100stringlabelobjectCreate your API Key from the <a href="https://portal.domotz.com/portal/settings/services?selected_menu=api_keys">Domotz Portal</a> or contact usheaderX-Api-KeyapiKeysupport@domotz.comAPI Supporthttps://www.domotz.com/# Introduction To begin using the Domotz Public API, first obtain your `API key` and `server` reference from the <a href="https://portal.domotz.com/portal/settings/services?selected_menu=api_keys">Domotz Portal</a>. The Domotz Public API follows standard REST principles. It uses conventional HTTP response codes, authentication mechanisms, and HTTP verbs. All requests accept JSON bodies, and all responses are returned in JSON format. Date-time values must follow the `yyyy-mm-ddThh:mm:ss` format and must always be expressed in UTC. Other time zones are not supported. # Webhooks You can subscribe to events occurring on the Domotz platform by using Webhooks. Subscriptions are available for both Collector-level events and Device-level events. Refer to the [user-guide](https://help.domotz.com/user-guide/shared-alerts-webhooks-ticketing-systems/) for detailed instructions on how to configure Webhooks as a notification channel and how to create a Shared Alert Profile. You can also consult the sections on [Alert profiles list](#tag/alerts/get/alert-profile), [Alert profile collector binding](#tag/alerts/post/alert-profile/{alert_profile_id}/binding/agent/{agent_id}), and [Alert profile device binding](#tag/alerts/post/alert-profile/{alert_profile_id}/binding/agent/{agent_id}/device/{device_id}) to retrieve all Shared Alert Profiles and to bind them to specific Collectors or Devices. These sections also contain the complete list of available Webhook events and provide links to their corresponding schemas. https://www.domotz.com/terms-and-conditions/13.1.0<__agent>Returns the collectors list.listAgentsThe maximum number of items to return. Min value is 1. Max value is 100. Default value is 10querypage_sizeFalse10int321001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerConsider only collectors with `display_name` containing the string (case insensitive)querydisplay_nameFalsestringFilters by team name (companies only)queryteam_nameFalsestring<_200><__ref>#/components/schemas/AgentBasearrayThe collector list

Collectors list

CollectorCounts the collectors.countAgentsConsider only collectors with `display_name` containing the string (case insensitive)querydisplay_nameFalsestringFilters by team name (companies only)queryteam_nameFalsestring<_204>The number of collectors matching the filtering criteriaThe number of collectors matching the filtering criteriaint32integer

Collectors count

Collector<__agent_uptime>Returns the uptime of all collectors.getAgentListUptimeThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/AgentUptimearrayThe uptime of the collectors

All collectors uptime

Metrics<__agent__agent_id_>Deletes a collector.deleteAgentAgent IDpathagent_idTrueint32integer<_204>

Collector deletion

CollectorReturns the details of a collector.getAgentAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentDetailThe collector

Collector details

Collector<__agent__agent_id__activity-log>Returns the activity log of a collector.getAgentActivityLogAgent IDpathagent_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestringIf present, only the specified type(s) will be fetched.querytypeFalsenoteagent_alert_level_setagent_alert_resumertd_session_startcresnet_node_rebootdevice_rebootfirmware_update_startapplications_terminateconfiguration_restorefactory_resetnetwork_configuration_changecustom_driver_executeremote_session_startremote_session_terminateremote_session_limit_reachedvpn_session_startvpn_session_terminatechat_startedchat_resolvedoperator_joinedoperator_leftpower_onpower_offpower_cyclecamera_snapshotcamera_streaming_startconfiguration_management_status_changestring<_200><__ref>#/components/schemas/ActivityLogarrayList of activity log entries

Activity log

Collector<__agent__agent_id__connection_consumption>Returns the remote connection consumption on the given collector.getConnectionConsumptionAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/ConnectionConsumption

Remote connections consumption

Remote Connection<__agent__agent_id__connection_vpn-session>Returns the active VPN connections for the collector.getAgentVPNActiveConnectionsAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentVPNActiveConnectionarrayCollector VPN Connection information

Active VPN connections list

Remote ConnectionCreates a temporary VPN server on the collector and returns the vpn configuration file content. Current consumption and consumption limits can be retrieved with a call to <a href='#getconnectionconsumption'> getConnectionConsumption</a> endpoint.createAgentVPNConnectionAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/AgentVPNConnectionTrue<_201>binarystringOpenVPN Configuration file content

VPN connection creation

Remote Connection<__agent__agent_id__connection_vpn-session__vpn_session_id_>Closes an active VPN connection session for the collector.deleteAgentVPNConnectionAgent IDpathagent_idTrueint32integerSession IDpathvpn_session_idTrueint32integer<_204>

Active VPN connection closure

Remote Connection<__agent__agent_id__device>Deletes all the DOWN devices of *IP* protocol.deleteDownDevicesAgent IDpathagent_idTrueint32integer<_204>

Bulk offline devices deletion

DeviceReturns all the devices of a collector. On per-device licensing collectors, only the managed devices are included.listDevicesAgent IDpathagent_idTrueint32integerWhether to include hidden devices in the returned listqueryshow_hiddenFalsebooleanWhether to include excluded devices in the returned list. Default is Truequeryshow_excludedFalseboolean<_200>#/components/schemas/DummyDevice#/components/schemas/LocalIpDevice#/components/schemas/ExternalIpDevice#/components/schemas/SubnetIpDeviceprotocol<__ref>#/components/schemas/DummyDevice<__ref>#/components/schemas/LocalIpDevice<__ref>#/components/schemas/ExternalIpDevice<__ref>#/components/schemas/SubnetIpDevicearrayThe list of all devices in the collector's monitored networks

Collector devices list

Device<__agent__agent_id__device_application>Returns the list of applications of all the devices belonging to the collector. The feature is only available on collectors under the Enterprise Plan.listAgentDeviceApplicationsAgent IDpathagent_idTrueint32integerThe maximum number of items to return. Min value is 1. Max value is 1000. Default value is 100querypage_sizeFalse100int3210001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerAllows filtering by `name`querynameFalsestringAllows filtering by `device_ids`querydevice_idsFalsestring<_200><__ref>#/components/schemas/AgentDeviceApplicationarrayThe list of applications of all the devices belonging to the collector

Collector device applications list

DeviceCounts the applications of all devices belonging to the collector. The feature is only available on collectors under the Enterprise Plan.countAgentDeviceApplicationsAgent IDpathagent_idTrueint32integerAllows filtering by `name`querynameFalsestringAllows filtering by `device_ids`querydevice_idsFalsestring<_204>Returns the application countReturns the application countint32integer

Collector device applications count

Device<__agent__agent_id__device_external-host>Creates an external host.createExternalHostAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/ExternalHostTrue<_201>

External host creation

Network Configuration<__agent__agent_id__device_eye_snmp>Returns the list of configured SNMP sensors on the collector.listAgentEyesSNMPAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/SNMPDomotzAgentEyearrayThe list of configured SNMP sensors on the collector

Collector SNMP sensors list

Sensor<__agent__agent_id__device_eye_tcp>Returns the list of configured TCP sensors on the collector.listAgentEyesTCPAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/TCPDomotzEyearrayThe list of configured TCP sensors on the collector and their latest values

Collector TCP sensors list

Sensor<__agent__agent_id__device_monitoring-state_unmanaged>Returns the list of unmanaged devices for a specific collector. This endpoint returns a limited set of data to support per-device licensing flows. The list of managed devices can be retrieved using the listDevices API.listUnmanagedDevicesAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/MinimalDevicearrayThe list of all unmanaged devices in the collector's monitored networks

Unmanaged devices list

Device<__agent__agent_id__device_rtd>Returns the Round Trip Delay statistics for all devices monitored by the collector. The aggregate values of _avg_min_, _avg_max_, _avg_median_ help to understand the baseline response time of a device in a weekly time frame, while _latest_median_ helps detecting a possible deviation from the baseline.getAgentRTDStatsAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/DeviceRTDStatisticsarrayDevices RTD Statistics

Round Trip Delay statistics

Metrics<__agent__agent_id__device_variable>Returns the list of all device variables of the collector.listAgentDeviceVariablesAgent IDpathagent_idTrueint32integerThe maximum number of items to return. Min value is 1. Max value is 1000. Default value is 100querypage_sizeFalse100int3210001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`, `device_id`querysort_byFalsepathidvaluelabelvalue_update_timecreation_timedevice_idstringThe default is `asc`querysorting_directionFalseascdescstringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_200><__ref>#/components/schemas/AgentDeviceVariablearrayThe list of all device variables of a collector

Collector device variables list

MetricsReturns the device variables count of the collector.countAgentDeviceVariablesAgent IDpathagent_idTrueint32integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_204>The device variables countThe device variables countint32integer

Collector device variables count

Metrics<__agent__agent_id__device__device_id_>Deletes a device, whether ONLINE, OFFLINE or DOWN. If a device is deleted while online, it may reappear when rediscovered automatically.deleteDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Device deletion

DeviceReturns the details of a device.getDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200>#/components/schemas/DummyDevice#/components/schemas/LocalIpDevice#/components/schemas/ExternalIpDevice#/components/schemas/SubnetIpDeviceprotocol<__ref>#/components/schemas/DummyDevice<__ref>#/components/schemas/LocalIpDevice<__ref>#/components/schemas/ExternalIpDevice<__ref>#/components/schemas/SubnetIpDeviceAn object containing the device details

Device details

Device<__agent__agent_id__device__device_id__action_power>Returns the power management actions available on the device at the current moment. See <a href='#schemadevicepoweraction'> DevicePowerAction </a> schema for further details.getDevicePowerActionsAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/DevicePowerActionReturns a JSON object indicating the current availability of each power action on the device

Device power management actions

Power Management<__agent__agent_id__device__device_id__action_power__field_>Performs the action on the device, according to the specified {<b> field </b>} value. The availability of such operations can be determined with a call to <a href='#getdevicepoweractions'> getDevicePowerActions </a> operation.powerActionOnDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSpecifies the power action to performpathfieldTrueonoffcyclesoftware-rebootstring<_204>

Device power action operation

Power Management<__agent__agent_id__device__device_id__application>Returns the list of applications of the device. The feature is only available on collectors under the Enterprise Plan.listDeviceApplicationsAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe maximum number of items to return. Min value is 1. Max value is 1000. Default value is 100querypage_sizeFalse100int3210001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerAllows filtering by `name`querynameFalsestringAllows filtering by `device_ids`querydevice_idsFalsestring<_200><__ref>#/components/schemas/DeviceApplicationarrayThe list of applications of the device

Device applications list

DeviceCounts the applications. The feature is only available on collectors under the Enterprise Plan.countDeviceApplicationsAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerAllows filtering by `name`querynameFalsestringAllows filtering by `device_ids`querydevice_idsFalsestring<_204>Returns the application countReturns the application countint32integer

Device applications count

Device<__agent__agent_id__device__device_id__configuration-management_backup>Sends a command to backup a device configuration.backupDeviceConfigurationAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_202>Command has been sent

Device configuration backup execution

Configuration Management<__agent__agent_id__device__device_id__configuration-management_history>Returns the list of available device configurations.deviceConfigurationHistoryListAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/DeviceConfigurationMetadataarrayThe list of saved device configurations

Device configurations list

Configuration ManagementCreates a device configuration backup in the configuration history.createDeviceConfigurationAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/DeviceConfigurationCreateTrue<_202>Configuration backup has been created

Device configuration creation

Configuration Management<__agent__agent_id__device__device_id__configuration-management_history__configuration_timestamp___>Returns the details of a device configuration entry.getDeviceConfigurationAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerConfiguration timestamp ("latest" or YYYY-MM-DDTHH:MM:SS+00:00)pathconfiguration_timestampTruelatest|\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\+00:00)?string<_200><__ref>#/components/schemas/DeviceConfigurationThe device's configuration

Device configuration detail

Configuration Management<__agent__agent_id__device__device_id__connection>Establishes a direct secure connection to the `device`. Current consumption and consumption limits can be retrieved with a call to <a href='#getconnectionconsumption'> getConnectionConsumption</a> endpoint.connectToDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/DeviceConnectionTrue<_201><__ref>#/components/schemas/ConnectionSession

Device secure connection creation

Remote Connection<__agent__agent_id__device__device_id__credentials>Sets the device credentials to perform extended discovery. This operation will affect the <b> authentication_status </b> of the device.setCredentialsAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/DeviceCredentialsdevice credentials payloadTrue<_204>

Device credentials update

Device<__agent__agent_id__device__device_id__custom-tag_binding>Retrieves all the user's custom tags associated to a devicegetDeviceCustomTagBindingspathagent_idTrueintegerpathdevice_idTrueinteger<_200><__ref>#/components/schemas/DeviceTagResponseModelarraySuccessful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag device bindings list

Custom Tags<__agent__agent_id__device__device_id__custom-tag__custom_tag_id__binding>Disassociates a custom tag to a devicedeleteDeviceCustomTagBindingpathagent_idTrueintegerpathdevice_idTrueintegerpathcustom_tag_idTrueinteger<_204>Successful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag device unbinding

Custom TagsAssociates a custom tag to a devicecreateDeviceCustomTagBindingpathagent_idTrueintegerpathdevice_idTrueintegerpathcustom_tag_idTrueinteger<_204>Successful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag device binding

Custom Tags<__agent__agent_id__device__device_id__eye_snmp>Returns the list of configured SNMP sensors.listEyesSNMPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/SNMPDomotzEyearrayThe list of configured SNMP sensors for the device and their latest values

SNMP sensors list

SensorCreates a new SNMP sensors.createEyeSNMPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/SNMPDomotzEyeCreationTrue<_201>

SNMP sensor creation

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id_>Deletes the SNMP sensor.deleteEyeSNMPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integer<_204>

SNMP sensor deletion

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id__function>Returns the list of functions for the SNMP sensor trigger.listEyesSNMPTriggerFunctionAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integer<_200><__ref>#/components/schemas/SNMPDomotzEyeTriggerFunctionarrayThe list of functions that can be used by the trigger

SNMP sensor trigger functions list

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id__history>Returns the time series of the SNMP sensor collected samples.getEyesSNMPHistoryAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/DeviceEyeSNMPHistorySamplearrayThe list of SNMP sensor samples

SNMP sensor time series

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id__trigger>Returns the list of triggers for the SNMP Sensor.listEyesSNMPTriggerAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integer<_200><__ref>#/components/schemas/SNMPDomotzEyeTriggerarrayThe list of triggers associated to the sensor

SNMP sensor triggers list

SensorCreates a new SNMP Trigger for the sensor. For instance, to receive a notification when the value of the sensor is above a threshold x, it is required to add a trigger specifying the function_id = 2 (is greater than) and the operand value equals to [x]. The function_id value can be retrieved with the listEyesSNMPTriggerFunction call. To activate the alert, it is required to call createEyeSNMPTriggerAlert after the trigger creation.createEyeSNMPTriggerAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integer<__ref>#/components/schemas/SNMPDomotzSnmpTriggerCreationTrue<_201>

SNMP sensor trigger creation

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id__trigger__trigger_id_>Deletes the SNMP Trigger for the sensor.deleteEyeSNMPTriggerAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integerSNMP Sensor Trigger IDpathtrigger_idTrueint32integer<_204>

SNMP sensor trigger deletion

Sensor<__agent__agent_id__device__device_id__eye_snmp__sensor_id__trigger__trigger_id__alert__medium_name_>Deletes the alert for thee SNMP Trigger.deleteEyeSNMPTriggerAlertAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integerSNMP Sensor Trigger IDpathtrigger_idTrueint32integerthe name of the mediumpathmedium_nameTrueemailmobilestring<_204>

SNMP sensor trigger alert deletion

SensorAdd an alert to a SNMP Trigger.createEyeSNMPTriggerAlertAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerSNMP Sensor IDpathsensor_idTrueint32integerSNMP Sensor Trigger IDpathtrigger_idTrueint32integerthe name of the mediumpathmedium_nameTrueemailmobilestring<__ref>#/components/schemas/SNMPDomotzSnmpTriggerAlertCreationTrue<_201>

SNMP sensor trigger alert creation

Sensor<__agent__agent_id__device__device_id__eye_tcp>Returns the list of configured TCP sensors.listEyesTCPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/TCPDomotzEyearrayThe list of configured TCP sensors for the device and their latest values

TCP sensors list

SensorCreates a new TCP sensors.createEyeTCPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/TCPDomotzEyeCreationTrue<_201>

TCP sensor creation

Sensor<__agent__agent_id__device__device_id__eye_tcp__service_id_>Deletes the TCP sensor.deleteEyeTCPAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerTCP Sensor IDpathservice_idTrueint32integer<_204>

TCP sensor deletion

Sensor<__agent__agent_id__device__device_id__history_network_event>Returns the time series of the state changes of the device.getDeviceStatusHistoryAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/DeviceHistoryarrayA time series

Device state change history

Metrics<__agent__agent_id__device__device_id__history_rtd>Returns the Round Trip Delay history for the device. Each item represents the statistical aggregate of a set of Round Trip Delay measurements.getDeviceRTDHistoryAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/DeviceRTDHistorySamplearrayDevice RTD History

Round Trip Delay statistics history

Metrics<__agent__agent_id__device__device_id__inventory>Returns the device's inventory data.getDeviceInventoryAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/DeviceInventoryFieldarrayThe device's inventory, with the fields sorted alphabetically. Not set fields will be null

Device inventory fields list

Inventory Fields<__agent__agent_id__device__device_id__inventory__inventory_field_>Deletes the Inventory field for the device.deleteDeviceInventoryFieldAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerField identifier, unique within the Inventorypathinventory_fieldTrue^[a-z][a-z0-9_-]{0,24}$string<_204>

Device inventory field deletion

Inventory FieldsSets the value of an Inventory field for the device, a value can't be set to `null`.setDeviceInventoryFieldValueAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerField identifier, unique within the Inventorypathinventory_fieldTrue^[a-z][a-z0-9_-]{0,24}$string255stringTrue<_204>

Device inventory field update

Inventory Fields<__agent__agent_id__device__device_id__monitoring-state>Sets the monitoring state of a device to either managed or unmanaged. This endpoint is available only for agents using per-device licensing.updateDeviceMonitoringStateAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/DeviceMonitoringStateThe value that the device monitoring state will assumeTrue<_204>

Device monitoring state update

Device<__agent__agent_id__device__device_id__multimedia_camera_snapshot>Take a snapshot of the camera. Internally, a device connection is established. Current consumption and consumption limits can be retrieved with a call to <a href='#getconnectionconsumption'> getConnectionConsumption</a> endpoint.onvifSnapshotAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200>binarystringA binary image

Take camera snapshot

Multimedia<__agent__agent_id__device__device_id__power-outlet>Returns a list of the power outlets discovered on the device.getDeviceOutletsAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/DeviceOutletarrayA list of outlet objects

Device power outlets list

Power Management<__agent__agent_id__device__device_id__power-outlet__power_outlet_id_>Update the power outlet with the specified custom name.updateDeviceOutletAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerOutlet IDpathpower_outlet_idTruestring<__ref>#/components/schemas/DeviceOutletUpdateFalse<_204>

Power outlet name update

Power Management<__agent__agent_id__device__device_id__power-outlet__power_outlet_id__action__action_>Trigger an action on a power outlet.triggerOutletActionAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerOutlet IDpathpower_outlet_idTruestringAction to perform on the outletpathactionTrueonoffcyclestring<_202>

Power outlet action operation

Power Management<__agent__agent_id__device__device_id__power-outlet__power_outlet_id__attach__attached_device_id_>Detach a device from a power outlet.detachDeviceFromOutletAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerOutlet IDpathpower_outlet_idTruestringDevice IDpathattached_device_idTrueint32integer<_204>

Power outlet device detachment

Power ManagementAttach a device to a power outlet.attachDeviceToOutletAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerOutlet IDpathpower_outlet_idTruestringDevice IDpathattached_device_idTrueint32integer<_204>

Power outlet device attachment

Power Management<__agent__agent_id__device__device_id__snmp-authentication>Returns the SNMP authentication info.getSNMPAuthenticationAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_200><__ref>#/components/schemas/SNMPDomotzAuthenticationThe SNMP authentication info for the device

Device SNMP authentication details

DeviceSets the SNMP authentication info. <ul><li>_snmp_read_community_ and _snmp_write_community_ are relevant only for _V1_ and _V2_. </li><li>_V3_NO_AUTH_ requires a valid _username_. </li><li>_V3_AUTH_NO_PRIV_ requires _username_, _authentication_protocol_ and _authentication_key_. </li><li>_V3_AUTH_PRIV_ requires _username_, _authentication_protocol_, _authentication_key_, _encryption_protocol_ and _encryption_key_.</li></ul>setSNMPAuthenticationAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/SNMPDomotzAuthenticationTrue<_204>

Device SNMP authentication update

Device<__agent__agent_id__device__device_id__snmp-community>Saves a snmp community (read, optionally write) on device. _Deprecated_, please use <a href='#setsnmpauthentication'> setSNMPAuthentication </a>.setSnmpCommunityAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/DeviceSnmpCommunityThe value that the snmp community entries will change toTrue<_204>

Device SNMP community update

Device<__agent__agent_id__device__device_id__uptime>Returns the uptime of the device.getDeviceUptimeAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/DeviceUptimeThe uptime of the device

Device uptime

Metrics<__agent__agent_id__device__device_id__variable>Returns the list of device variables.listDeviceVariablesAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe maximum number of items to return. Min value is 1. Max value is 1000. Default value is 100querypage_sizeFalse100int3210001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`querysort_byFalsepathidvaluelabelvalue_update_timecreation_timestringThe default is `asc`querysorting_directionFalseascdescstringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_200><__ref>#/components/schemas/DeviceVariablearrayThe list of device variables

Device variables list

MetricsReturns device variables count.countDeviceVariablesAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_204>The device variables countThe device variables countint32integer

Device variables count

Metrics<__agent__agent_id__device__device_id__variable__variable_id__history>Returns the device variable history.getVariableHistoryAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerVariable IDpathvariable_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/VariableHistorySamplearrayThe device variable's history, a list of dictionaries, each composed by the timestamp (a datetime) and the value (a string)

Device variable history

Metrics<__agent__agent_id__device__device_id__visibility>Hides a device (available only on DOWN devices).hideDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Hide a device

Device<__agent__agent_id__device__device_id___field_>Changes a proprety of the device.editDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerThe field to update - for the type and valid values see the description of the corresponding output parameter <a href="#tocSabstractdevice">here</a>pathfieldTrueimportanceuser_data/modeluser_data/typeuser_data/nameuser_data/vendordetails/roomdetails/zonedetails/serialdetails/notesstringstringThe value that the field will change toTrue<_204>

Device property change

Device<__agent__agent_id__eye-statistics>Returns information about Domotz Sensors usage and limits.eyesUsageInfoAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/DomotzEyesUsageInformationA data structure containing information about current Domotz Sensors usage and limits

Sensors usage and limits

Sensor<__agent__agent_id__history_network_event>Returns the time series of the state changes of the collector.getAgentStatusHistoryAgent IDpathagent_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/AgentHistoryarrayA time series

Collector state change history

Metrics<__agent__agent_id__history_network_speed>Returns the time series of the Internet Speed measurements taken from the collector, both in download and in upload.getSpeedTestHistoryAgent IDpathagent_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/NetworkSpeedSamplearrayA time series

Internet Speed Test time series

Metrics<__agent__agent_id__ip-conflict>Returns the list of active IP conflicts on a collector.getAgentIPConflictsAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentIpConflictarray

Active IP conflicts

Collector<__agent__agent_id__metric-statistics>Returns Domotz Sensors usage and limits.MetricUsageInfoAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/DomotzMetricUsageInformationCurrent Domotz Sensors usage and limits

Metrics usage and limits

Sensor<__agent__agent_id__network-topology>Returns the collector's network topology.getNetworkTopologyAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/NetworkTopology

Network topology

Topology<__agent__agent_id__network_dhcp-device-discovery>Enable/disable the collector DHCP Device Discovery.setDHCPDeviceDiscoveryAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/DHCPDeviceDiscoverySettingEnable/disable the DHCP Device Discovery on the collectorTrue<_204>

DHCP device discovery setting

Network Configuration<__agent__agent_id__network_excluded-device>Returns all the excluded devices of a collector, i.e., devices present in Device Blacklist section.listExcludedDevicesAgent IDpathagent_idTrueint32integer<_200>#/components/schemas/DummyDevice#/components/schemas/LocalIpDevice#/components/schemas/ExternalIpDevice#/components/schemas/SubnetIpDeviceprotocol<__ref>#/components/schemas/DummyDevice<__ref>#/components/schemas/LocalIpDevice<__ref>#/components/schemas/ExternalIpDevice<__ref>#/components/schemas/SubnetIpDevicearrayThe list of all devices excluded from collector monitoring

Excluded devices list

Device<__agent__agent_id__network_excluded-device__device_id_>Removes a device from the excluded devices list.deleteExcludedDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Device exclusion removal

DeviceExcludes a device from collector monitoring.addExcludedDeviceAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Device exclusion

Device<__agent__agent_id__network_external-host-scan-policy>Restore the external host scan policy to default.deleteAgentExternalHostScanPolicyAgent IDpathagent_idTrueint32integer<_204>

External host scan policy reset

Network ConfigurationReturns the current external host scan policy.getAgentExternalHostScanPolicyAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentExternalHostScanPolicyThe external host scan policy.

External host scan policy

Network ConfigurationUpdates the current external host scan policy. It is possible to enable/disable each one of the three available methods (ICMP, TCP-SYN, TCP-ACK). For TCP-SYN and TCP-ACK is mandatory to specify a set of TCP ports. If a method is not specified in the payload of the request, it will be configured as disabled.setAgentExternalHostScanPolicyAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/AgentExternalHostScanPolicyThe external host scan policy to be appliedTrue<_204>

External host scan policy update

Network Configuration<__agent__agent_id__network_interfaces>Returns the networks monitored by the collector.getAgentInterfacespathagent_idTrueinteger<_200><__ref>#/components/schemas/AgentInterfacesResponseModelSuccessful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Monitored networks

Network Configuration<__agent__agent_id__network_interfaces-policy>Resets the network interface filtering policy to the default value.deleteAgentInterfacesPolicyAgent IDpathagent_idTrueint32integer<_204>

Network interface policy reset

Network ConfigurationReturns the current network interface filtering policy. The interfaces policy defines the set of interfaces which will be ignored (`deny`) or scanned (`allow`) by the collector. The default behavior is to scan all available interfaces.getAgentInterfacesPolicyAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentInterfacesPolicyThe current network interface filtering policy

Network interface filtering policy

Network ConfigurationUpdates the current network interface filtering policy.setAgentInterfacesPolicyAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/AgentInterfacesPolicythe filtering policy to be appliedTrue<_204>

Network interface filtering policy update

Network Configuration<__agent__agent_id__network_ip-scan-policy>Resets the IP scan policy to the default value.deleteAgentIPScanPolicyAgent IDpathagent_idTrueint32integer<_204>

IP address scan policy reset

Network ConfigurationReturns the current IP addresses management policy. It is possible to specify a set of IP addresses in the `forced_ip_addresses` field array or a set of IP address ranges in the `forced_ip_ranges` field array to be always scanned.getAgentIPScanPolicyAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AgentIPScanPolicyThe IP scan policy.

IP address scan policy

Network ConfigurationUpdates the current IP address scan policy. The list of IP addresses provided in `forced_ip_addresses` and the list of IP address ranges provided in `forced_ip_ranges` will be scanned regardless of the automatic discovery settings of the collector.setAgentIPScanPolicyAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/AgentIPScanPolicythe IP scan policy to be appliedTrue<_204>

IP address scan policy update

Network Configuration<__agent__agent_id__network_routed>Creates a routed network.createRoutedNetworkAgent IDpathagent_idTrueint32integer<__ref>#/components/schemas/RoutedNetworkTrue<_201>

Routed network creation

Network Configuration<__agent__agent_id__ownership_team__team_id_>Moves a collector under the control of a different team. Note: This API is restricted to users on the Enterprise Plan. Please contact <a href="mailto:sales@domotz.com">sales@domotz.com</a> to learn more.moveAgentAgent IDpathagent_idTrueint32integerTeam IDpathteam_idTrueint32integer<_204>

Collector team reassignment

Enterprise<__agent__agent_id__uptime>Returns the uptime of the collector.getAgentUptimeAgent IDpathagent_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/AgentUptimeThe uptime of the collector

Collector uptime

Metrics<__agent__agent_id__variable>Returns the list of all collector variables of the collector.listAgentVariablesAgent IDpathagent_idTrueint32integerThe maximum number of items to return. Min value is 1. Max value is 1000. Default value is 100querypage_sizeFalse100int3210001integerThe requested page number, 0-indexed. Default value is 0querypage_numberFalse0int320integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`querysort_byFalsepathidvaluelabelvalue_update_timecreation_timestringThe default is `asc`querysorting_directionFalseascdescstringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_200><__ref>#/components/schemas/AgentVariablearrayThe list of all collector variables of the collector

Collector variables list

MetricsReturns the collector variables count of the collector.countAgentVariablesAgent IDpathagent_idTrueint32integerAllows filtering by `value`queryvalueFalsestringAllows filtering by `path`querypathFalsestringAllows filtering by `has_history` fieldqueryhas_historyFalsebooleanAllows filtering by `metric`querymetricFalsestring<_204>The collector variables countThe collector variables countint32integer

Collector variables count

Metrics<__agent__agent_id__variable__variable_id__history>Returns the collector variable history.getAgentVariableHistoryAgent IDpathagent_idTrueint32integerVariable IDpathvariable_idTrueint32integerThe start time of the time series. Default value is one weekqueryfromFalsedate-timestringThe end time of the time series. Default value is nowquerytoFalsedate-timestring<_200><__ref>#/components/schemas/VariableHistorySamplearrayThe collector variable's history, a list of dictionaries, each composed by the timestamp (a datetime) and the value (a string)

Collector variable history

Metrics<__alert-profile>Returns the list of configured alert profiles. You can configure alert profiles on the Domotz Portal. Alert profiles define the association between a list of events and a notification channel (email, webhook or slack).getAlertProfiles2<_200><__ref>#/components/schemas/AlertProfilearrayThe list of configured alert profiles

Alert profiles list

Alerts<__alert-profile_binding_agent__agent_id_>Returns the alert profile bindings of a collector.getAgentAlertProfileAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AlertProfileAgentBindingarrayThe alert profile bindings of an collector

Collector alert profile bindings

Alerts<__alert-profile_binding_agent__agent_id__device>Returns the alert profile bindings of the devices of a collector.getDevicesAlertProfileAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/AlertProfileDeviceBindingarrayThe alert profile bindings for all devices of the collector

Device alert profile bindings

Alerts<__alert-profile__alert_profile_id__binding_agent__agent_id_>Unbind an alert profile from a collector.unbindAlertProfileFromAgentAgent IDpathagent_idTrueint32integerProfile IDpathalert_profile_idTrueint32integer<_204>

Alert profile collector unbinding

Alerts<__ref>#/components/schemas/DeviceDiscoveryEventTrue<_201><__ref>#/components/schemas/FeatureDiscoveryEventTrue<_201><__ref>#/components/schemas/MibDiscoveryEventTrue<_201><__ref>#/components/schemas/AgentLANChangeEventTrue<_201><__ref>#/components/schemas/AgentSecurityIssueEventTrue<_201><__ref>#/components/schemas/AgentSpeedTestEventTrue<_201><__ref>#/components/schemas/AgentStatusEventTrue<_201><__ref>#/components/schemas/AgentStatusEventTrue<_201><__ref>#/components/schemas/AgentWANChangeEventTrue<_201>Bind an alert profile to a collector. After binding, a webhook will be sent to the configured service when one of the events associated to the profile occurs. You can configure the profile and the webhook endpoint on the Domotz PortalbindAlertProfileToAgentAgent IDpathagent_idTrueint32integerProfile IDpathalert_profile_idTrueint32integer<_204>

Alert profile collector binding

Alerts<__alert-profile__alert_profile_id__binding_agent__agent_id__device__device_id_>Unbind an alert profile from a device.unbindAlertProfileFromDeviceAgent IDpathagent_idTrueint32integerProfile IDpathalert_profile_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Alert profile device unbinding

Alerts<__ref>#/components/schemas/DeviceConfigurationChangeEventTrue<_201><__ref>#/components/schemas/DeviceConfigurationMisalignmentEventTrue<_201><__ref>#/components/schemas/DeviceHeartbeatLostEventTrue<_201><__ref>#/components/schemas/DeviceIPChangeEventTrue<_201><__ref>#/components/schemas/DeviceRTDIssueEventTrue<_201><__ref>#/components/schemas/DeviceSNMPEventTrue<_201><__ref>#/components/schemas/DeviceStatusChangeEventTrue<_201><__ref>#/components/schemas/DeviceStatusChangeEventTrue<_201><__ref>#/components/schemas/DeviceTCPEventTrue<_201><__ref>#/components/schemas/MonitoringProfileStateChangedTrue<_201>Bind an alert profile to a device. After binding, a webhook will be sent to the configured service when one of the events associated to the profile occurs. You can configure the profile and the webhook endpoint on the Domotz PortalbindAlertProfileToDeviceAgent IDpathagent_idTrueint32integerProfile IDpathalert_profile_idTrueint32integerDevice IDpathdevice_idTrueint32integer<_204>

Alert profile device binding

Alerts<__area>Returns all the areas of a Company. Note: This API is restricted to users on the Enterprise Plan. Please contact <a href="mailto:sales@domotz.com">sales@domotz.com</a> to learn more.listAreas<_200><__ref>#/components/schemas/AreaarrayThe list of all the areas in the User's Company

Company areas list

Enterprise<__area__area_id__team>Returns all the teams of an Area. Note: This API is restricted to users on the Enterprise Plan. Please contact <a href="mailto:sales@domotz.com">sales@domotz.com</a> to learn more.listTeamsArea IDpatharea_idTrueint32integer<_200><__ref>#/components/schemas/TeamarrayThe list of all the teams in a Company Area's

Return all the teams of an Area

EnterpriseCreates a new Team. Note: This API is restricted to users on the Enterprise Plan. Please contact <a href="mailto:sales@domotz.com">sales@domotz.com</a> to learn more.createTeamArea IDpatharea_idTrueint32integer<__ref>#/components/schemas/TeamCreationTrue<_201>

Create a new Team

Enterprise<__custom-driver>Retrieves the list of available Custom Drivers.listCustomDrivers<_200><__ref>#/components/schemas/CustomDriverarrayThe list of available Custom Drivers

Custom Drivers list

Custom Drivers<__custom-driver_agent__agent_id__association>Retrieves a list of all Custom Driver associations for a collector.listCustomDriverAssociationsAgent IDpathagent_idTrueint32integer<_200><__ref>#/components/schemas/CustomDriverAssociationarrayThe list of Custom Driver associations

Custom Driver device bindings list

Custom Drivers<__custom-driver_association_re-enable>Re-enable all disabled Custom Drivers for the current user.reEnableCustomDriverAssociationsIf true, will also re-enable associations that the system has determined unable to recover (e.g. due to missing credentials). Defaults to false.queryinclude_unrecoverableFalseboolean<_204>

Disabled Custom Drivers reactivation

Custom Drivers<__custom-driver__custom_driver_id_>Returns details of a Custom Driver.getCustomDriverCustom Driver IDpathcustom_driver_idTrueint32integer<_200><__ref>#/components/schemas/CustomDriverDetailsCustom Driver details

Custom Driver details

Custom Drivers<__custom-driver__custom_driver_id__agent__agent_id__device__device_id__association>Apply a Custom Driver to a device.createCustomDriverAssociationCustom Driver IDpathcustom_driver_idTrueint32integerAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integer<__ref>#/components/schemas/CustomDriverAssociationCreationFalse<_201><__ref>#/components/schemas/CustomDriverAssociationCreationResultThe outcome of the association

Custom Driver device binding

Custom Drivers<__custom-driver__custom_driver_id__agent__agent_id__device__device_id__execute__action_id_>Execute a Custom Driver action on an associated device. The collector variables limit for Custom Drivers must not be exceeded.executeCustomDriverActionCustom Driver IDpathcustom_driver_idTrueint32integerAgent IDpathagent_idTrueint32integerDevice IDpathdevice_idTrueint32integerCustom Driver Action id. Valid range 1-30 or get-statuspathaction_idTrue^([1-9]|[1-2][0-9]|30)|get-status$string<__ref>#/components/schemas/CustomDriverExecutionOptionsFalse<_200><__ref>#/components/schemas/CustomDriverExecutionResultThe outcome of the custom action execution

Custom Driver action trigger

Custom Drivers<__custom-driver__custom_driver_id__association__association_id_>Remove a Custom Driver from a device. This irreversibly deletes all variables created by the driver for that device.deleteCustomDriverAssociationCustom Driver IDpathcustom_driver_idTrueint32integerCustom Driver Association IDpathassociation_idTrueint32integer<_204>

Custom Driver device unbinding

Custom DriversUpdate the parameters for a Custom Driver association.updateCustomDriverAssociationParametersCustom Driver IDpathcustom_driver_idTrueint32integerCustom Driver Association IDpathassociation_idTrueint32integer<__ref>#/components/schemas/CustomDriverAssociationParameterCreationA list of parameters to updateTrue<_204>

Custom Driver device binding paramaters update

Custom Drivers<__custom-tag>Retrieves all the custom tags defined by the usergetCustomTags<_200><__ref>#/components/schemas/UserTagListResponseModelSuccessful Response

Tags list

Custom TagsCreates a custom tag defined by the usercreateCustomTag<__ref>#/components/schemas/CreateTagModelTrue<_204>Successful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag creation

Custom Tags<__custom-tag__custom_tag_id_>Deletes a custom tag defined by the userdeleteCustomTagpathcustom_tag_idTrueinteger<_204>Successful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag deletion

Custom TagsEdits a custom tag defined by the usereditCustomTagpathcustom_tag_idTrueinteger<__ref>#/components/schemas/CreateTagModelTrue<_204>Successful Response<_422><__ref>#/components/schemas/HTTPValidationErrorValidation Error

Tag update

Custom Tags<__device-profile>Returns the list of the available device profiles.listDeviceProfiles<_200><__ref>#/components/schemas/DeviceProfilearrayThe list of the available device profiles

Device profiles list

Device<__device-profile__device_profile_id__apply>Applies a device profile to a set of devices.applyDeviceProfileDevice Profile IDpathdevice_profile_idTrueint32integer<__ref>#/components/schemas/DeviceProfileApplyRequestTrue<_204>

Device profile application

Device<__inventory>Clears the inventory.deleteInventory<_204>

Inventory deletion

Inventory FieldsEnumerates all the Inventory fields.getInventory<_200><__ref>#/components/schemas/InventoryFieldarrayThe inventory fields, sorted by creation time

Inventory fields list

Inventory Fields<__inventory__inventory_field_>Deletes the Inventory Field.deleteInventoryFieldField identifier, unique within the Inventorypathinventory_fieldTrue^[a-z][a-z0-9_-]{0,24}$string<_204>

Inventory field deletion

Inventory FieldsCreates a new Inventory Field - the user will be able to set key-values pairs on every device.createInventoryFieldField identifier, unique within the Inventorypathinventory_fieldTrue^[a-z][a-z0-9_-]{0,24}$string<__ref>#/components/schemas/WriteInventoryFieldTrue<_201>The inventory field will be referenced to with its name

Inventory field creation

Inventory FieldsUpdates the Inventory Field.updateInventoryFieldField identifier, unique within the Inventorypathinventory_fieldTrue^[a-z][a-z0-9_-]{0,24}$string<__ref>#/components/schemas/WriteInventoryFieldTrue<_204>

Inventory field update

Inventory Fields<__meta_usage>Returns information about API usage and limits.apiUsageInfo<_200><__ref>#/components/schemas/APIUsageInformationA data structure containing information about current API usage and usage limits

API usage and limits

Metadata<__type_device_base>Returns the device types list.listDeviceBaseTypes<_200><__ref>#/components/schemas/DeviceBaseTypearrayThe types list

Device types list

Metadata<__type_device_detected>Returns the detected device types list.listDeviceDetectedTypes<_200><__ref>#/components/schemas/DetectedDeviceTypearrayThe types list

Detected device types list

Metadata<__user>Returns the account information.getUser<_200><__ref>#/components/schemas/UserThe user

Account details

Account<__user__user_id__alert-profile>Returns the list of configured alert profiles. You can configure alert profiles on the Domotz Portal. Alert profiles define the association between a list of events and a notification channel (email, webhook or slack).getAlertProfiles _Deprecated_ (please use getAlertProfiles2)User IDpathuser_idTrueint32integer<_200><__ref>#/components/schemas/AlertProfilearrayThe list of configured alert profiles

Alert profiles list

Alertshttps://api-us-east-1-cell-1.domotz.com/public-api/v1/