Skip to main content
Tools Reference

Domotz Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Domotz Tools

domotz_ · 159 tools · Free 80 · Pro 79 Network monitoring and remote access for managed sites. The credential is an API key, and the base address is your account's regional cell host, so every tenant has its own. The US and EU definitions are otherwise identical. Three paging families: page size with a zero-based page number, capped at 1000 by the vendor on the variable and application lists and at 1000 here as a safety limit on the collector and alert lists, and a from, to and limit time window on the driver execution logs. All date-times must be UTC. Two quotas apply, per minute and per 24 hours, with no published numbers and no documented 429 shape - read your real ceilings from the API usage tool. Domotz calls its on-premises agents Collectors and its sensors Eyes; tool names say collector and sensor while path parameters keep the vendor's agent id. Write endpoints answer with no body, and the camera snapshot and VPN configuration return a link to a stored file.

All connector tools · Domotz setup guide

Domotz tool groups

Account & Metadata

ToolPlanAccessSummary
domotz_get_accountFreeRead-onlyReturns the Domotz account the configured API key belongs to — account name, plan, and owner details.
domotz_get_api_usageFreeRead-onlyReturns this account's real API quotas and current consumption: daily_limit (calls allowed per 24 hours), concurrent_allowed (calls allowed per minute), daily_usage, plus breakdowns by API key, source…
domotz_list_device_base_typesFreeRead-onlyReturns Domotz's full device-type vocabulary (the canonical list of types a device can be classified as).
domotz_list_device_detected_typesFreeRead-onlyReturns only the device types actually detected across this account's monitored networks — a much shorter list than domotz_list_device_base_types.

[Domotz] Returns the Domotz account the configured API key belongs to — account name, plan, and owner details. Use this first to confirm which Domotz account StackJack is connected to.

[Domotz] Returns this account's real API quotas and current consumption: daily_limit (calls allowed per 24 hours), concurrent_allowed (calls allowed per minute), daily_usage, plus breakdowns by API key, source IP, and resource. Domotz publishes no default quota numbers — this is the only way to see them. Check this first when calls start being throttled, or before running a large sweep.

[Domotz] Returns Domotz's full device-type vocabulary (the canonical list of types a device can be classified as). Use this to resolve valid values before setting a device's type with domotz_update_device_property.

[Domotz] Returns only the device types actually detected across this account's monitored networks — a much shorter list than domotz_list_device_base_types. Use this to understand what kinds of hardware the customer actually has.

Collectors

ToolPlanAccessSummary
domotz_create_teamProWriteCreates a new Team.
domotz_delete_collectorProDestructiveDeletes a Collector and everything recorded through it — its devices, their history, sensors, and configuration.
domotz_get_collectorFreeRead-onlyReturns the details of a collector.
domotz_get_collector_activity_logFreeRead-onlyReturns the activity log of a collector.
domotz_get_collector_ip_conflictsFreeRead-onlyReturns the list of active IP conflicts on a collector.
domotz_get_network_topologyFreeRead-onlyReturns the collector's network topology.
domotz_list_areasFreeRead-onlyReturns all the areas of a Company.
domotz_list_collectorsFreeRead-onlyReturns the list of collectors accessible by the user.
domotz_list_teamsFreeRead-onlyReturns all the teams of an Area.
domotz_move_collector_to_teamProWriteMoves a collector under the control of a different team.

[Domotz] Creates a new Team. Note: This API is restricted to users on the Enterprise Plan. Please contact sales@domotz.com to learn more. Body fields: leader* (object{details,name,password}), name* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
areaIdintegeryesArea ID.
bodyJsonstringyesJSON object (as a string). Body fields: leader* (object{details,name,password}), name* (string). Fields marked * are required.

[Domotz] Deletes a Collector and everything recorded through it — its devices, their history, sensors, and configuration. There is no undo, and re-enrolling the Collector on site does not restore the history. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the details of a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the activity log of a collector. agentId is the Collector id — get it from domotz_list_collectors. type: note, agent_alert_level_set, agent_alert_resume, rtd_session_start, cresnet_node_reboot, device_reboot, firmware_update_start, applications_terminate, configuration_restore, factory_reset, network_configuration_change, custom_driver_execute, remote_session_start, remote_session_terminate, remote_session_limit_reached, vpn_session_start, vpn_session_terminate, chat_started, chat_resolved, operator_joined, operator_left, power_on, power_off, power_cycle, camera_snapshot, camera_streaming_start, configuration_management_status_change. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.
typestringnonullIf present, only the specified type(s) will be fetched. One of: note, agent_alert_level_set, agent_alert_resume, rtd_session_start, cresnet_node_reboot, device_reboot, firmware_update_start, applications_terminate, configuration_restore, factory_reset, network_configuration_change, custom_driver_execute, remote_session_start, remote_session_terminate, remote_session_limit_reached, vpn_session_start, vpn_session_terminate, chat_started, chat_resolved, operator_joined, operator_left, power_on, power_off, power_cycle, camera_snapshot, camera_streaming_start, configuration_management_status_change.

[Domotz] Returns the list of active IP conflicts on a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the collector's network topology. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns all the areas of a Company. Note: This API is restricted to users on the Enterprise Plan. Please contact sales@domotz.com to learn more.

[Domotz] Returns the list of collectors accessible by the user. Paged: pageNumber is ZERO-BASED, pageSize defaults to 10 (no documented vendor maximum; capped at 1000).

ParamTypeRequiredDefaultDescription
displayNamestringnonulldisplay name.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno10Page size. Default 10, max 1000.
teamNamestringnonullteam name.

[Domotz] Returns all the teams of an Area. Note: This API is restricted to users on the Enterprise Plan. Please contact sales@domotz.com to learn more.

ParamTypeRequiredDefaultDescription
areaIdintegeryesArea ID.

[Domotz] Moves a collector under the control of a different team. Note: This API is restricted to users on the Enterprise Plan. Please contact sales@domotz.com to learn more. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
teamIdintegeryesTeam ID.

Devices

ToolPlanAccessSummary
domotz_add_excluded_deviceProWriteExcludes a device from monitoring on this Collector, which removes it from the monitored device list and stops its alerts.
domotz_apply_device_profileProDestructiveApplies a device profile to a set of devices, re-configuring EVERY device you list in one call.
domotz_delete_deviceProDestructiveDeletes a device, whether ONLINE, OFFLINE or DOWN.
domotz_delete_excluded_deviceProDestructiveRemoves a device's EXCLUSION, which RESTORES monitoring for it — this is the opposite of a deletion despite the underlying delete operation.
domotz_delete_offline_devicesProDestructiveDeletes ALL currently-offline devices from a Collector in one call — not one device, every offline one.
domotz_get_deviceFreeRead-onlyReturns the details of a device.
domotz_get_snmp_authenticationFreeRead-onlyReturns the SNMP authentication info.
domotz_hide_deviceProDestructiveHides a device from the Collector's views.
domotz_list_collector_device_applicationsFreeRead-onlyReturns the list of applications of all the devices belonging to the collector.
domotz_list_device_applicationsFreeRead-onlyReturns the list of applications of the device.
domotz_list_device_profilesFreeRead-onlyReturns the list of the available device profiles.
domotz_list_devicesFreeRead-onlyReturns all the devices of a collector.
domotz_list_excluded_devicesFreeRead-onlyReturns all the excluded devices of a collector, i.e., devices present in Device Blacklist section.
domotz_list_unmanaged_devicesFreeRead-onlyReturns the list of unmanaged Devices for a specific Collector.
domotz_set_credentialsProWriteSets the device credentials to perform extended discovery.
domotz_set_snmp_authenticationProWriteSets the SNMP authentication info.
domotz_set_snmp_communityProWriteSaves a snmp community (read, optionally write) on device.
domotz_update_device_monitoring_stateProWriteChanges a device's monitoring state.
domotz_update_device_propertyProWriteChanges a property of the device.

[Domotz] Excludes a device from monitoring on this Collector, which removes it from the monitored device list and stops its alerts. This is reversible with domotz_delete_excluded_device, but while excluded the device is effectively invisible — an outage on it will not be reported. Get agentId from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Applies a device profile to a set of devices, re-configuring EVERY device you list in one call. List profiles with domotz_list_device_profiles and confirm what the profile changes before applying it. Body fields: device_ids* (array of integer — the devices to apply the profile to). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: device_ids* (array of integer). Fields marked * are required.
deviceProfileIdintegeryesDevice Profile ID.

[Domotz] Deletes a device, whether ONLINE, OFFLINE or DOWN. If a device is deleted while online, it may reappear when rediscovered automatically. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.

[Domotz] Removes a device's EXCLUSION, which RESTORES monitoring for it — this is the opposite of a deletion despite the underlying delete operation. Use domotz_list_excluded_devices to see what is currently excluded. Get agentId from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Deletes ALL currently-offline devices from a Collector in one call — not one device, every offline one. A device that is merely powered down or temporarily unreachable counts as offline and will be removed along with its history. List the Collector's devices first to see what would go. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the details of a device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.

[Domotz] Returns the SNMP authentication info. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Hides a device from the Collector's views. Despite using a delete operation upstream, this does NOT delete the device or its history — it stops showing it. Use domotz_delete_device to actually remove a device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Returns the list of applications of all the devices belonging to the collector. The feature is only available on collectors under the Enterprise Plan. agentId is the Collector id — get it from domotz_list_collectors. Paged: pageNumber is ZERO-BASED, pageSize defaults to 100 (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdsstringnonullAllows filtering by `device_ids`.
namestringnonullAllows filtering by `name`.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno100Page size. Default 100, max 1000.

[Domotz] Returns the list of applications of the device. The feature is only available on collectors under the Enterprise Plan. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Paged: pageNumber is ZERO-BASED, pageSize defaults to 100 (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
deviceIdsstringnonullAllows filtering by `device_ids`.
namestringnonullAllows filtering by `name`.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno100Page size. Default 100, max 1000.

[Domotz] Returns all the devices of a collector. On per-device licensing collectors, only the managed devices are included. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
showExcludedbooleannonullWhether to include excluded devices in the returned list. Default is True.
showHiddenbooleannonullWhether to include hidden devices in the returned list. Default is False.

[Domotz] Returns all the excluded devices of a collector, i.e., devices present in Device Blacklist section. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] 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. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Sets the device credentials to perform extended discovery. This operation will affect the authentication_status of the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: password* (string), scope (string; one of: CUSTOM_DRIVER_MANAGEMENT, CONFIGURATION_MANAGEMENT, DEVICE_MANAGEMENT, OS_MANAGEMENT), username* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: password* (string), scope (string; one of: CUSTOM_DRIVER_MANAGEMENT, CONFIGURATION_MANAGEMENT, DEVICE_MANAGEMENT, OS_MANAGEMENT), username* (string). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Sets the SNMP authentication info. snmp_read_community and snmp_write_community are relevant only for V1 and V2. V3_NO_AUTH requires a valid username. V3_AUTH_NO_PRIV requires username, authentication_protocol and authentication_key. V3_AUTH_PRIV requires username, authentication_protocol, authentication_key, encryption_protocol and encryption_key. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: authentication_key (string), authentication_protocol (string; one of: MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512), encryption_key (string), encryption_protocol (string; one of: DES, AES, AES-256B, AES-256R), snmp_read_community (string), snmp_write_community (string), username (string), version* (string; one of: V2, V1, V3_AUTH_PRIV, V3_NO_AUTH, V3_AUTH_NO_PRIV). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: authentication_key (string), authentication_protocol (string; one of: MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512), encryption_key (string), encryption_protocol (string; one of: DES, AES, AES-256B, AES-256R), snmp_read_community (string), snmp_write_community (string), username (string), version* (string; one of: V2, V1, V3_AUTH_PRIV, V3_NO_AUTH, V3_AUTH_NO_PRIV). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Saves a snmp community (read, optionally write) on device. Deprecated, please use setSNMPAuthentication . Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: read* (string), write (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: read* (string), write (string). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Changes a device's monitoring state. Turning monitoring OFF stops Domotz collecting data for that device and stops its alerts firing — the device goes quiet rather than healthy, so a real outage on it will no longer page anyone. Confirm that is the intent before disabling on a live customer device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: monitoring_state* (string; one of: MANAGED, UNMANAGED). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Changes a property of the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. field must be one of: importance, user_data/model, user_data/type, user_data/name, user_data/vendor, details/room, details/zone, details/serial, details/notes.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fieldstringyesThe field to update - for the type and valid values see the description of the corresponding output parameter here. One of: importance, user_data/model, user_data/type, user_data/name, user_data/vendor, details/room, details/zone, details/serial, details/notes.
valuestringyesThe new value for the chosen field. A plain string, sent as a bare JSON string rather than an object.

Alerts & Alert Rules

ToolPlanAccessSummary
domotz_apply_alert_rule_to_collectorProWriteApplies an Alert Rule to a Collector so it monitors every Device on the Collector.
domotz_apply_alert_rule_to_deviceProWriteApplies an Alert Rule to a single Device.
domotz_apply_contact_channel_to_alert_ruleProWriteApplies a Contact Channel to an Alert Rule so notifications for incidents matching the rule are routed to that channel.
domotz_create_alert_ruleProWriteCreates a new Alert Rule with a datapoint, condition, severity, operands.
domotz_get_alert_ruleFreeRead-onlyReturns the complete configuration details for a specific Alert Rule.
domotz_list_alert_rulesFreeRead-onlyReturns all Alert Rules configured in the account, including severity, datapoint, condition, Contact Channels, status.
domotz_list_alertsFreeRead-onlyReturns alert events generated by Alert Rules, including active and resolved alerts.
domotz_list_collector_alert_rulesFreeRead-onlyReturns the Alert Rules currently applied to a Collector.
domotz_list_contact_channelsFreeRead-onlyReturns the Contact Channels available for alert notifications within the account.
domotz_list_device_alert_rulesFreeRead-onlyReturns the Alert Rules currently applied to a Device.
domotz_remove_alert_rule_from_collectorProDestructiveRemoves an Alert Rule from a Collector.
domotz_remove_alert_rule_from_deviceProDestructiveRemoves an Alert Rule from a Device.
domotz_remove_contact_channel_from_alert_ruleProDestructiveRemoves a Contact Channel from an Alert Rule.
domotz_resolve_alertProWriteManually resolves an active alert and records the authenticated user as the resolver.
domotz_update_alert_ruleProWriteUpdates one or more fields of an existing Alert Rule, such as name, severity, condition, operands, or status.

[Domotz] Applies an Alert Rule to a Collector so it monitors every Device on the Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertRuleIdintegeryesalert rule id.

[Domotz] Applies an Alert Rule to a single Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertRuleIdintegeryesalert rule id.
deviceIdintegeryesDevice id.
ParamTypeRequiredDefaultDescription
alertRuleIdintegeryesalert rule id.
channelIdintegeryeschannel id.

[Domotz] Creates a new Alert Rule with a datapoint, condition, severity, operands. Body fields: condition_id* (integer), datapoint_id* (integer), name* (string), operands (array of string), operands_unit (value), severity (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: condition_id* (integer), datapoint_id* (integer), name* (string), operands (array of string), operands_unit (value), severity (string). Fields marked * are required.
ParamTypeRequiredDefaultDescription
alertRuleIdintegeryesalert rule id.

[Domotz] Returns alert events generated by Alert Rules, including active and resolved alerts. Results are sorted by `triggered_at` descending. The `from`/`to` time window is mandatory and is matched against the Alert event triggered timestamp. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone. Both are required. Paged: pageNumber is ZERO-BASED, pageSize defaults to 50 (no documented vendor maximum; capped at 1000).

ParamTypeRequiredDefaultDescription
alertRuleIdintegernonullFilter to Alert events produced by a specific Alert Rule.
collectorIdintegernonullFilter to Alert events on a specific Collector.
deviceIdintegernonullFilter to Alert events on a specific Device.
fromstringyesWindow start as ISO-8601 UTC; matched against the Alert event triggered timestamp (e.g. 2026-06-03T11:22:00Z).
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno50Page size. Default 50, max 1000.
severitystringnonullFilter by severity (Critical, High, Warning, Info).
statusstringnonullFilter by status (Open, Resolved).
tostringyesWindow end as ISO-8601 UTC; matched against the Alert event triggered timestamp (e.g. 2026-06-03T11:22:00Z).

[Domotz] Returns the Alert Rules currently applied to a Collector. Returns the same response schema as List Alert Rules. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the Alert Rules currently applied to a Device. Returns the same response schema as List Alert Rules. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.

[Domotz] Removes an Alert Rule from a Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertRuleIdintegeryesalert rule id.

[Domotz] Removes an Alert Rule from a Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertRuleIdintegeryesalert rule id.
deviceIdintegeryesDevice id.
ParamTypeRequiredDefaultDescription
alertRuleIdintegeryesalert rule id.
channelIdintegeryeschannel id.
ParamTypeRequiredDefaultDescription
alertIdstringyesalert id.

[Domotz] Updates one or more fields of an existing Alert Rule, such as name, severity, condition, operands, or status. Body fields: condition_id (integer), name (string), operands (array of ), operands_unit (value), severity (string), status (string). No field is documented as required.

ParamTypeRequiredDefaultDescription
alertRuleIdintegeryesalert rule id.
bodyJsonstringyesJSON object (as a string). Body fields: condition_id (integer), name (string), operands (array of ), operands_unit (value), severity (string), status (string). No field is documented as required.

Alert Profiles

ToolPlanAccessSummary
domotz_bind_alert_profile_to_collectorProWriteBind an alert profile to a collector.
domotz_bind_alert_profile_to_deviceProWriteBind an alert profile to a device.
domotz_get_collector_alert_profile_bindingsFreeRead-onlyReturns the alert profile bindings of a collector.
domotz_get_device_alert_profile_bindingsFreeRead-onlyReturns the alert profile bindings of the devices of a collector.
domotz_list_alert_profilesFreeRead-onlyReturns the list of configured alert profiles.
domotz_list_user_alert_profiles_deprecatedFreeRead-onlyReturns the list of configured alert profiles.
domotz_unbind_alert_profile_from_collectorProDestructiveUnbind an alert profile from a collector.
domotz_unbind_alert_profile_from_deviceProDestructiveUnbind an alert profile from a device.

[Domotz] 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 Portal. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertProfileIdintegeryesProfile ID.

[Domotz] 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 Portal. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertProfileIdintegeryesProfile ID.
deviceIdintegeryesDevice ID.

[Domotz] Returns the alert profile bindings of a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the alert profile bindings of the devices of a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] 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).

[Domotz] 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).

ParamTypeRequiredDefaultDescription
userIdintegeryesUser ID.

[Domotz] Unbind an alert profile from a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertProfileIdintegeryesProfile ID.

[Domotz] Unbind an alert profile from a device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
alertProfileIdintegeryesProfile ID.
deviceIdintegeryesDevice ID.

Access Management

ToolPlanAccessSummary
domotz_create_userProWriteCreate a new RBAC User.
domotz_create_user_groupProWriteCreate a new RBAC User group.
domotz_delete_userProDestructiveDelete an RBAC User by user ID.
domotz_delete_user_groupProDestructiveDelete an RBAC User group by user group ID.
domotz_edit_userProWriteUpdate an RBAC User by user ID.
domotz_edit_user_groupProWriteUpdate an RBAC User group by user group ID.
domotz_get_roleFreeRead-onlyRetrieve a Role and its Permissions.
domotz_get_userFreeRead-onlyRetrieve RBAC User details by User ID.
domotz_get_user_groupFreeRead-onlyRetrieve RBAC User group details by user group ID.
domotz_list_rolesFreeRead-onlyList all RBAC roles and associated user groups.
domotz_list_user_groupsFreeRead-onlyList all RBAC User groups with their details.
domotz_list_usersFreeRead-onlyList all RBAC Users with their details.

[Domotz] Create a new RBAC User. Body fields: email* (string), is_external (boolean), name (string), phone (string), required_authentication_type (value), user_group_ids* (array of integer). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: email* (string), is_external (boolean), name (string), phone (string), required_authentication_type (value), user_group_ids* (array of integer). Fields marked * are required.

[Domotz] Create a new RBAC User group. Body fields: name* (string), role_ids* (array of integer), user_ids* (array of integer). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: name* (string), role_ids* (array of integer), user_ids* (array of integer). Fields marked * are required.
ParamTypeRequiredDefaultDescription
memberIdintegeryesmember id.
ParamTypeRequiredDefaultDescription
userGroupIdintegeryesuser group id.

[Domotz] Update an RBAC User by user ID. Note: User groups are replaced by those provided in the request; omit required_authentication_type to reset the User's required authentication type. Body fields: is_external (boolean), name (string), phone (string), required_authentication_type (value), user_group_ids (array of ). No field is documented as required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: is_external (boolean), name (string), phone (string), required_authentication_type (value), user_group_ids (array of ). No field is documented as required.
memberIdintegeryesmember id.

[Domotz] Update an RBAC User group by user group ID. Note: Users and roles are replaced by those provided in the request. Body fields: name (string), role_ids (array of ), user_ids (array of ). No field is documented as required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: name (string), role_ids (array of ), user_ids (array of ). No field is documented as required.
userGroupIdintegeryesuser group id.

[Domotz] Retrieve a Role and its Permissions. Note: When 'is_applied_to_all_entities' is true, 'entity_ids' is omitted.

ParamTypeRequiredDefaultDescription
roleIdintegeryesrole id.
ParamTypeRequiredDefaultDescription
memberIdintegeryesmember id.
ParamTypeRequiredDefaultDescription
userGroupIdintegeryesuser group id.

Custom Tags

ToolPlanAccessSummary
domotz_create_collector_custom_tag_bindingProWriteAssigns a Tag to a Collector.
domotz_create_custom_tagProWriteCreates a new Tag.
domotz_create_device_custom_tag_bindingProWriteAssigns a Tag to a Device.
domotz_delete_collector_custom_tag_bindingProDestructiveRemoves a Tag from a Collector.
domotz_delete_custom_tagProDestructiveDeletes a Tag and removes it from Collectors and Devices.
domotz_delete_device_custom_tag_bindingProDestructiveRemoves a Tag from a Device.
domotz_edit_custom_tagProWriteUpdates one or more properties of an existing Tag.
domotz_get_collector_custom_tag_bindingsFreeRead-onlyRetrieves all Tags assigned to a specific Collector.
domotz_get_device_custom_tag_bindingsFreeRead-onlyRetrieves all Tags assigned to a specific Device.
domotz_list_custom_tagsFreeRead-onlyRetrieves all Tags available in the account, including their metadata and usage counts.

[Domotz] Assigns a Tag to a Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
customTagIdintegeryescustom tag id.

[Domotz] Creates a new Tag. Body fields: color* (string), name* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: color* (string), name* (string). Fields marked * are required.

[Domotz] Assigns a Tag to a Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
customTagIdintegeryescustom tag id.
deviceIdintegeryesDevice id.

[Domotz] Removes a Tag from a Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
customTagIdintegeryescustom tag id.
ParamTypeRequiredDefaultDescription
customTagIdintegeryescustom tag id.

[Domotz] Removes a Tag from a Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
customTagIdintegeryescustom tag id.
deviceIdintegeryesDevice id.

[Domotz] Updates one or more properties of an existing Tag. Body fields: color (string), name (string). No field is documented as required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: color (string), name (string). No field is documented as required.
customTagIdintegeryescustom tag id.

[Domotz] Retrieves all Tags assigned to a specific Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Retrieves all Tags assigned to a specific Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.

Metrics & Datapoints

ToolPlanAccessSummary
domotz_get_all_collectors_uptimeFreeRead-onlyReturns the uptime of all collectors.
domotz_get_collector_rtd_statsFreeRead-onlyReturns the Round Trip Delay statistics for all devices monitored by the collector.
domotz_get_collector_status_historyFreeRead-onlyReturns the time series of the state changes of the collector.
domotz_get_collector_uptimeFreeRead-onlyReturns the uptime of the collector.
domotz_get_collector_variable_historyFreeRead-onlyReturns the collector variable history.
domotz_get_datapoint_detailsFreeRead-onlyReturns the details of a datapoint — including category, entity, data type, unit — along with the conditions/operators that can be applied to it when defining an Alert Rule.
domotz_get_device_rtd_historyFreeRead-onlyReturns the Round Trip Delay history for the device.
domotz_get_device_status_historyFreeRead-onlyReturns the time series of the state changes of the device.
domotz_get_device_uptimeFreeRead-onlyReturns the uptime of the device.
domotz_get_device_variable_historyFreeRead-onlyReturns the device variable history.
domotz_get_speed_test_historyFreeRead-onlyReturns the time series of the Internet Speed measurements taken from the collector, both in download and in upload.
domotz_list_collector_datapointsFreeRead-onlyReturns the datapoints available for Alert Rules on a Collector.
domotz_list_collector_device_variablesFreeRead-onlyReturns the list of all device variables of the collector.
domotz_list_collector_variablesFreeRead-onlyReturns the list of all collector variables of the collector.
domotz_list_device_datapointsFreeRead-onlyReturns the datapoints available for Alert Rules on Device.
domotz_list_device_variablesFreeRead-onlyReturns the list of device variables.

[Domotz] Returns the uptime of all collectors. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] 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. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the time series of the state changes of the collector. agentId is the Collector id — get it from domotz_list_collectors. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the uptime of the collector. agentId is the Collector id — get it from domotz_list_collectors. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the collector variable history. agentId is the Collector id — get it from domotz_list_collectors. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.
variableIdintegeryesVariable ID.
ParamTypeRequiredDefaultDescription
datapointIdintegeryesdatapoint id.

[Domotz] Returns the Round Trip Delay history for the device. Each item represents the statistical aggregate of a set of Round Trip Delay measurements. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the time series of the state changes of the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the uptime of the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the device variable history. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.
variableIdintegeryesVariable ID.

[Domotz] Returns the time series of the Internet Speed measurements taken from the collector, both in download and in upload. agentId is the Collector id — get it from domotz_list_collectors. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullThe start time of the time series. Default value is one week.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the datapoints available for Alert Rules on a Collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the list of all device variables of the collector. agentId is the Collector id — get it from domotz_list_collectors. sortBy: path, id, value, label, value_update_time, creation_time, device_id. sortingDirection: asc, desc. Paged: pageNumber is ZERO-BASED, pageSize defaults to 100 (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
hasHistorybooleannonullAllows filtering by `has_history` field.
metricstringnonullAllows filtering by `metric`.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno100Page size. Default 100, max 1000.
pathstringnonullAllows filtering by `path`.
sortBystringnonullAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`, `device_id`.
sortingDirectionstringnonullThe default is `asc`.
valuestringnonullAllows filtering by `value`.

[Domotz] Returns the list of all collector variables of the collector. agentId is the Collector id — get it from domotz_list_collectors. sortBy: path, id, value, label, value_update_time, creation_time. sortingDirection: asc, desc. Paged: pageNumber is ZERO-BASED, pageSize defaults to 100 (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
hasHistorybooleannonullAllows filtering by `has_history` field.
metricstringnonullAllows filtering by `metric`.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno100Page size. Default 100, max 1000.
pathstringnonullAllows filtering by `path`.
sortBystringnonullAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`.
sortingDirectionstringnonullThe default is `asc`.
valuestringnonullAllows filtering by `value`.

[Domotz] Returns the datapoints available for Alert Rules on Device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.

[Domotz] Returns the list of device variables. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. sortBy: path, id, value, label, value_update_time, creation_time. sortingDirection: asc, desc. Paged: pageNumber is ZERO-BASED, pageSize defaults to 100 (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
hasHistorybooleannonullAllows filtering by `has_history` field.
metricstringnonullAllows filtering by `metric`.
pageNumberintegerno0Zero-based page index. Default 0.
pageSizeintegerno100Page size. Default 100, max 1000.
pathstringnonullAllows filtering by `path`.
sortBystringnonullAllows ordering by `path`, `id`, `value`, `label`, `value_update_time`, `creation_time`.
sortingDirectionstringnonullThe default is `asc`.
valuestringnonullAllows filtering by `value`.

Sensors (Eyes)

ToolPlanAccessSummary
domotz_create_device_snmp_sensorProWriteCreates a new SNMP sensors.
domotz_create_device_tcp_sensorProWriteCreates a new TCP sensors.
domotz_create_snmp_sensor_triggerProWriteCreates a new SNMP Trigger for the sensor.
domotz_create_snmp_trigger_alertProWriteSNMP sensor trigger alert creation.
domotz_delete_device_snmp_sensorProDestructiveDeletes the SNMP sensor.
domotz_delete_device_tcp_sensorProDestructiveDeletes the TCP sensor.
domotz_delete_snmp_sensor_triggerProDestructiveDeletes the SNMP Trigger for the sensor.
domotz_delete_snmp_trigger_alertProDestructiveDeletes the alert for thee SNMP Trigger.
domotz_get_metric_usage_infoFreeRead-onlyReturns Domotz Sensors usage and limits.
domotz_get_sensor_usage_infoFreeRead-onlyReturns information about Domotz Sensors usage and limits.
domotz_get_snmp_sensor_historyFreeRead-onlyReturns the time series of the SNMP sensor collected samples.
domotz_list_collector_snmp_sensorsFreeRead-onlyReturns the list of configured SNMP sensors on the collector.
domotz_list_collector_tcp_sensorsFreeRead-onlyReturns the list of configured TCP sensors on the collector.
domotz_list_device_snmp_sensorsFreeRead-onlyReturns the list of configured SNMP sensors.
domotz_list_device_tcp_sensorsFreeRead-onlyReturns the list of configured TCP sensors.
domotz_list_snmp_sensor_trigger_functionsFreeRead-onlyReturns the list of functions for the SNMP sensor trigger.
domotz_list_snmp_sensor_triggersFreeRead-onlyReturns the list of triggers for the SNMP Sensor.

[Domotz] Creates a new SNMP sensors. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: category* (string; one of: OTHER, CONSUMABLE, CPU, DISK_SPACE, MEMORY, NETWORK_TRAFFIC, TEMPERATURE), name* (string), oid* (string), value_type* (string; one of: STRING, NUMERIC, ENUM). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: category* (string; one of: OTHER, CONSUMABLE, CPU, DISK_SPACE, MEMORY, NETWORK_TRAFFIC, TEMPERATURE), name* (string), oid* (string), value_type* (string; one of: STRING, NUMERIC, ENUM). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Creates a new TCP sensors. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: port* (integer). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: port* (integer). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Creates 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. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: function_id* (integer), name* (string), operands* (array of string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: function_id* (integer), name* (string), operands* (array of string). Fields marked * are required.
deviceIdintegeryesDevice ID.
sensorIdintegeryesSNMP Sensor ID.

[Domotz] SNMP sensor trigger alert creation. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. mediumName must be one of: email, mobile. The vendor documents NO body fields for this operation — send an empty JSON object .

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). The vendor documents NO body fields for this operation — send an empty JSON object .
deviceIdintegeryesDevice ID.
mediumNamestringyesthe name of the medium. One of: email, mobile.
sensorIdintegeryesSNMP Sensor ID.
triggerIdintegeryesSNMP Sensor Trigger ID.

[Domotz] Deletes the SNMP sensor. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
sensorIdintegeryesSNMP Sensor ID.

[Domotz] Deletes the TCP sensor. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
serviceIdintegeryesTCP Sensor ID.

[Domotz] Deletes the SNMP Trigger for the sensor. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
sensorIdintegeryesSNMP Sensor ID.
triggerIdintegeryesSNMP Sensor Trigger ID.

[Domotz] Deletes the alert for thee SNMP Trigger. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. mediumName must be one of: email, mobile.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
mediumNamestringyesthe name of the medium. One of: email, mobile.
sensorIdintegeryesSNMP Sensor ID.
triggerIdintegeryesSNMP Sensor Trigger ID.

[Domotz] Returns Domotz Sensors usage and limits. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns information about Domotz Sensors usage and limits. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the time series of the SNMP sensor collected samples. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fromstringnonullThe start time of the time series. Default value is one week.
sensorIdintegeryesSNMP Sensor ID.
tostringnonullThe end time of the time series. Default value is now.

[Domotz] Returns the list of configured SNMP sensors on the collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the list of configured TCP sensors on the collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the list of configured SNMP sensors. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Returns the list of configured TCP sensors. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Returns the list of functions for the SNMP sensor trigger. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
sensorIdintegeryesSNMP Sensor ID.

[Domotz] Returns the list of triggers for the SNMP Sensor. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
sensorIdintegeryesSNMP Sensor ID.

Network Configuration

ToolPlanAccessSummary
domotz_create_external_hostProWriteCreates an external host.
domotz_create_routed_networkProWriteCreates a routed network.
domotz_get_collector_ext_host_scan_policyFreeRead-onlyReturns the current external host scan policy.
domotz_get_collector_interfacesFreeRead-onlyReturns the networks monitored by the collector.
domotz_get_collector_interfaces_policyFreeRead-onlyReturns the current network interface filtering policy.
domotz_get_collector_ip_scan_policyFreeRead-onlyReturns the current IP addresses management policy.
domotz_reset_collector_ext_host_scan_policyProDestructiveResets the Collector's external-host scan policy back to the Domotz default, discarding any custom policy you set.
domotz_reset_collector_interfaces_policyProDestructiveResets the Collector's network-interface filtering policy back to the Domotz default, discarding any custom policy you set.
domotz_reset_collector_ip_scan_policyProDestructiveResets the Collector's IP-address scan policy back to the Domotz default, discarding any custom range you set — the Collector will resume scanning its default ranges, which may change what it…
domotz_set_collector_ext_host_scan_policyProWriteUpdates the current external host scan policy.
domotz_set_collector_interfaces_policyProWriteUpdates the current network interface filtering policy.
domotz_set_collector_ip_scan_policyProWriteUpdates the current IP address scan policy.
domotz_set_dhcp_device_discoveryProWriteEnable/disable the collector DHCP Device Discovery.

[Domotz] Creates an external host. agentId is the Collector id — get it from domotz_list_collectors. Body fields: host* (string), name* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: host* (string), name* (string). Fields marked * are required.

[Domotz] Creates a routed network. agentId is the Collector id — get it from domotz_list_collectors. Body fields: address* (string), name* (string), netmask* (integer). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: address* (string), name* (string), netmask* (integer). Fields marked * are required.

[Domotz] Returns the current external host scan policy. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the networks monitored by the collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns 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. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns 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. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Resets the Collector's external-host scan policy back to the Domotz default, discarding any custom policy you set. Read the current policy first with domotz_get_collector_ext_host_scan_policy. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Resets the Collector's network-interface filtering policy back to the Domotz default, discarding any custom policy you set. Nothing is deleted beyond the policy itself; read the current one first with domotz_get_collector_interfaces_policy. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Resets the Collector's IP-address scan policy back to the Domotz default, discarding any custom range you set — the Collector will resume scanning its default ranges, which may change what it discovers and monitors. Read the current policy first with domotz_get_collector_ip_scan_policy.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Updates 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. agentId is the Collector id — get it from domotz_list_collectors. Body fields: icmp (object), tcp_ack (object{enabled,ports}), tcp_syn (object{enabled,ports}). No field is documented as required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: icmp (object), tcp_ack (object{enabled,ports}), tcp_syn (object{enabled,ports}). No field is documented as required.

[Domotz] Updates the current network interface filtering policy. agentId is the Collector id — get it from domotz_list_collectors. Body fields: policy* (string; one of: allow, deny), rules* (array of string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: policy* (string; one of: allow, deny), rules* (array of string). Fields marked * are required.

[Domotz] Updates 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. agentId is the Collector id — get it from domotz_list_collectors. Body fields: forced_ip_addresses* (array of string), forced_ip_ranges* (array of object). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: forced_ip_addresses* (array of string), forced_ip_ranges* (array of object). Fields marked * are required.

[Domotz] Enable/disable the collector DHCP Device Discovery. agentId is the Collector id — get it from domotz_list_collectors. Body fields: dhcp_device_discovery* (boolean). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: dhcp_device_discovery* (boolean). Fields marked * are required.

Power Management

ToolPlanAccessSummary
domotz_attach_device_to_power_outletProWriteAttach a device to a power outlet.
domotz_detach_device_from_power_outletProDestructiveDetach a device from a power outlet.
domotz_list_device_power_actionsFreeRead-onlyReturns the power management actions available on the device at the current moment.
domotz_list_device_power_outletsFreeRead-onlyReturns a list of the power outlets discovered on the device.
domotz_rename_device_power_outletProWriteUpdate the power outlet with the specified custom name.
domotz_run_device_power_actionProDestructivePhysically powers a device on, off, through a full power cycle, or issues a software reboot.
domotz_run_power_outlet_actionProDestructivePhysically switches a PDU outlet on, off, or through a power cycle.

[Domotz] Attach a device to a power outlet. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
attachedDeviceIdintegeryesDevice ID.
deviceIdintegeryesDevice ID.
powerOutletIdstringyesOutlet ID.

[Domotz] Detach a device from a power outlet. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
attachedDeviceIdintegeryesDevice ID.
deviceIdintegeryesDevice ID.
powerOutletIdstringyesOutlet ID.

[Domotz] Returns the power management actions available on the device at the current moment. See DevicePowerAction schema for further details. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Returns a list of the power outlets discovered on the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Update the power outlet with the specified custom name. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: custom_name (string). No field is documented as required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: custom_name (string). No field is documented as required.
deviceIdintegeryesDevice ID.
powerOutletIdstringyesOutlet ID.

[Domotz] Physically powers a device on, off, through a full power cycle, or issues a software reboot. This CUTS REAL POWER to hardware and will take the device offline — confirm the blast radius first. Call domotz_list_device_power_actions to see which actions this device actually supports; an unsupported action fails. field must be one of: on, off, cycle, software-reboot.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
fieldstringyesSpecifies the power action to perform.

[Domotz] Physically switches a PDU outlet on, off, or through a power cycle. This cuts power to WHATEVER IS PLUGGED INTO THAT OUTLET, which may not be the device you think — call domotz_list_device_power_outlets first to see the outlet list and what is attached to each. action must be one of: on, off, cycle.

ParamTypeRequiredDefaultDescription
actionstringyesAction to perform on the outlet.
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
powerOutletIdstringyesOutlet ID.

Custom Drivers

ToolPlanAccessSummary
domotz_create_driver_associationProWriteApply a Driver to a device.
domotz_delete_driver_associationProDestructiveRemove a Driver from a device.
domotz_execute_driver_actionProDestructiveExecutes a custom-driver action against a device — this RUNS THE DRIVER'S CODE on the target, so its effect is whatever that driver's author wrote.
domotz_get_driverFreeRead-onlyReturns details of a Driver.
domotz_list_collector_driver_associationsFreeRead-onlyRetrieves a list of all Driver associations for a collector.
domotz_list_collector_driver_execution_logsFreeRead-onlyReturns recent drivers execution logs for the given collector's devices, newest first.
domotz_list_device_driver_execution_logsFreeRead-onlyReturns recent drivers execution logs for the given devices, newest first.
domotz_list_driversFreeRead-onlyRetrieves the list of available Drivers.
domotz_reenable_driver_associationsProWriteReactivates every custom-driver association Domotz had auto-disabled, across ALL devices at once — this resumes running that driver code on each of them, so the effect is bulk and not scoped to one…
domotz_update_driver_associationProWriteUpdate the parameters for a Driver association.

[Domotz] Apply a Driver to a device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: credentials (object{password,username}), parameters (array of object), sample_period (integer). No field is documented as required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: credentials (object{password,username}), parameters (array of object), sample_period (integer). No field is documented as required.
customDriverIdintegeryesDriver ID.
deviceIdintegeryesDevice ID.

[Domotz] Remove a Driver from a device. This irreversibly deletes all variables created by the driver for that device.

ParamTypeRequiredDefaultDescription
associationIdintegeryesDriver Association ID.
customDriverIdintegeryesDriver ID.

[Domotz] Executes a custom-driver action against a device — this RUNS THE DRIVER'S CODE on the target, so its effect is whatever that driver's author wrote. Use domotz_list_drivers and domotz_get_driver to see the driver and its available actions before running one.

ParamTypeRequiredDefaultDescription
actionIdstringyesaction id.
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: parameters (array of ), test (boolean). No field is documented as required.
customDriverIdintegeryescustom driver id.
deviceIdintegeryesDevice id.
ParamTypeRequiredDefaultDescription
customDriverIdintegeryesDriver ID.

[Domotz] Retrieves a list of all Driver associations for a collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns recent drivers execution logs for the given collector's devices, newest first. Optional `from`/`to` (ISO-8601) bound the time range; `limit` caps the number of rows; `outcome` filters by outcome (default failure). agentId is the Collector id — get it from domotz_list_collectors. outcome: failure, success, all. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone. limit caps the number of records returned (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
fromstringnonullfrom.
limitintegernonulllimit.
outcomestringnonulloutcome. One of: failure, success, all.
tostringnonullto.

[Domotz] Returns recent drivers execution logs for the given devices, newest first. Optional `from`/`to` (ISO-8601) bound the time range; `limit` caps the number of rows; `outcome` filters by outcome (default failure). Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. outcome: failure, success, all. Time window from/to uses yyyy-mm-ddThh:mm:ss and must be UTC — Domotz supports no other time zone. limit caps the number of records returned (max 1000).

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice id.
fromstringnonullfrom.
limitintegernonulllimit.
outcomestringnonulloutcome. One of: failure, success, all.
tostringnonullto.

[Domotz] Reactivates every custom-driver association Domotz had auto-disabled, across ALL devices at once — this resumes running that driver code on each of them, so the effect is bulk and not scoped to one device. Domotz disables associations because they were failing, so re-enabling without fixing the cause usually just re-fails. Set includeUnrecoverable only if you also want the associations Domotz marked permanently broken. Review domotz_list_collector_driver_associations and the execution logs first.

ParamTypeRequiredDefaultDescription
includeUnrecoverablebooleannonullIf true, will also re-enable associations that the system has determined unable to recover (e.g. due to missing credentials). Defaults to false.

[Domotz] Update the parameters for a Driver association. Body fields: parameters* (array of object). Fields marked * are required.

ParamTypeRequiredDefaultDescription
associationIdintegeryesDriver Association ID.
bodyJsonstringyesJSON object (as a string). Body fields: parameters* (array of object). Fields marked * are required.
customDriverIdintegeryesDriver ID.

Inventory Fields

ToolPlanAccessSummary
domotz_create_inventory_fieldProWriteCreates a new Inventory Field - the user will be able to set key-values pairs on every device.
domotz_delete_all_inventory_fieldsProDestructiveDeletes the ENTIRE account-wide set of inventory field definitions, and with it every value stored against those fields on every device.
domotz_delete_device_inventory_fieldProDestructiveDeletes the Inventory field for the device.
domotz_delete_inventory_fieldProDestructiveDeletes the Inventory Field.
domotz_get_device_inventoryFreeRead-onlyReturns the device's inventory data.
domotz_list_inventory_fieldsFreeRead-onlyEnumerates all the Inventory fields.
domotz_set_device_inventory_fieldProWriteSets the value of an Inventory field for the device, a value can't be set to `null`.
domotz_update_inventory_fieldProWriteUpdates the Inventory Field.

[Domotz] Creates a new Inventory Field - the user will be able to set key-values pairs on every device. Body fields: label* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: label* (string). Fields marked * are required.
inventoryFieldstringyesField identifier, unique within the Inventory.

[Domotz] Deletes the ENTIRE account-wide set of inventory field definitions, and with it every value stored against those fields on every device. This is the broadest destructive operation in the Domotz connector and there is no undo. To remove a single field instead, use domotz_delete_inventory_field.

[Domotz] Deletes the Inventory field for the device. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
inventoryFieldstringyesField identifier, unique within the Inventory.
ParamTypeRequiredDefaultDescription
inventoryFieldstringyesField identifier, unique within the Inventory.

[Domotz] Returns the device's inventory data. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Sets the value of an Inventory field for the device, a value can't be set to `null`. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.
inventoryFieldstringyesField identifier, unique within the Inventory.
valuestringyesThe value to store in this inventory field. A plain string, max 255 characters (sent as a bare JSON string, not an object).

[Domotz] Updates the Inventory Field. Body fields: label* (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object (as a string). Body fields: label* (string). Fields marked * are required.
inventoryFieldstringyesField identifier, unique within the Inventory.

Configuration Backups

ToolPlanAccessSummary
domotz_backup_device_configurationProWriteSends a command to backup a device configuration.
domotz_create_device_configurationProWriteCreates a device configuration backup in the configuration history.
domotz_get_device_configurationFreeRead-onlyReturns the details of a device configuration entry.
domotz_list_device_configurationsFreeRead-onlyReturns the list of available device configurations.

[Domotz] Sends a command to backup a device configuration. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

[Domotz] Creates a device configuration backup in the configuration history. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: label* (string), running* (string), startup (string). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: label* (string), running* (string), startup (string). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Returns the details of a device configuration entry. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
configurationTimestampstringyesConfiguration timestamp ("latest" or YYYY-MM-DDTHH:MM:SS+00:00).
deviceIdintegeryesDevice ID.

[Domotz] Returns the list of available device configurations. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.

Remote Connections & Multimedia

ToolPlanAccessSummary
domotz_connect_to_deviceProWriteEstablishes a direct secure connection to the `device`.
domotz_create_collector_vpn_sessionProWriteCreates a temporary VPN server on the Collector and returns a short-lived read-only download URL for the OpenVPN configuration file (valid a few minutes) rather than inlining it.
domotz_delete_collector_vpn_sessionProDestructiveCloses an active VPN connection session for the collector.
domotz_get_connection_consumptionFreeRead-onlyReturns the remote connection consumption on the given collector.
domotz_list_collector_vpn_sessionsFreeRead-onlyReturns the active VPN connections for the collector.
domotz_take_camera_snapshotProRead-onlyTakes a still snapshot from an ONVIF camera and returns a short-lived read-only download URL (valid a few minutes) plus its content type, size, and expiry — the image is never inlined in the response.

[Domotz] Establishes a direct secure connection to the `device`. Current consumption and consumption limits can be retrieved with a call to domotz_get_connection_consumption endpoint. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices. Body fields: allowed_ip* (string), port* (integer), protocol* (string; one of: http, https, tcp, ssh, rdp), ttl_hours (integer). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: allowed_ip* (string), port* (integer), protocol* (string; one of: http, https, tcp, ssh, rdp), ttl_hours (integer). Fields marked * are required.
deviceIdintegeryesDevice ID.

[Domotz] Creates a temporary VPN server on the Collector and returns a short-lived read-only download URL for the OpenVPN configuration file (valid a few minutes) rather than inlining it. THE FILE CARRIES VPN CREDENTIALS for the customer network — treat the URL as a secret and do not echo the file contents. Each session draws down the account's metered remote-connection budget; check it with domotz_get_connection_consumption and close sessions with domotz_delete_collector_vpn_session. Body fields: allowed_ip* (string — the ONLY public IPv4 address that may use the connection; the config is unusable from any other address, so this must be the caller's real public IP), routing_policy* (one of: global, local — global routes ALL traffic through Domotz and consumes far more of the budget; local routes only LAN traffic), ttl_hours (integer 1-24, default 1). Fields marked * are required.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
bodyJsonstringyesJSON object (as a string). Body fields: allowed_ip* (string), routing_policy* (string; one of: global, local), ttl_hours (integer). Fields marked * are required.

[Domotz] Closes an active VPN connection session for the collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
vpnSessionIdintegeryesSession ID.

[Domotz] Returns the remote connection consumption on the given collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Returns the active VPN connections for the collector. agentId is the Collector id — get it from domotz_list_collectors.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).

[Domotz] Takes a still snapshot from an ONVIF camera and returns a short-lived read-only download URL (valid a few minutes) plus its content type, size, and expiry — the image is never inlined in the response. This opens a real connection into the customer network and draws down the account's metered remote-connection budget, so it is a paid-tier tool even though it only reads; check the budget with domotz_get_connection_consumption. Get agentId from domotz_list_collectors and deviceId from domotz_list_devices.

ParamTypeRequiredDefaultDescription
agentIdintegeryesCollector id (the Domotz API calls this agent_id).
deviceIdintegeryesDevice ID.