Skip to main content
Connector guides

Connect Domotz

Domotz is a network monitoring platform for MSPs and AV/IT integrators. A Collector — an on-site agent you run as an appliance, a VM, or a software install — discovers every device on a customer…

Written By Christopher Scaminaci

Last updated 6 days ago

Domotz is a network monitoring platform for MSPs and AV/IT integrators. A Collector — an on-site agent you run as an appliance, a VM, or a software install — discovers every device on a customer network and watches it continuously: whether it is up, how fast it responds, what its SNMP and TCP sensors report, how the network is wired together, and which PDU outlet each device is plugged into. Connecting Domotz to StackJack lets your AI assistant read all of that and act on it.

Connecting Domotz gives your AI a broad set of domotz_ MCP tools — MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

  • Inventory your Collectors and every device behind them, including installed applications, SNMP details, and detected device types
  • Investigate uptime, response-time (round-trip delay) history, status-change history, internet speed-test results, and per-device monitored variables
  • Triage alerts — list them over a time window, filter by severity or status, and resolve them
  • Manage alert rules end to end (create, update, delete) and bind them to Collectors, devices, and contact channels
  • Configure monitoring — sensors (Domotz calls them Eyes), IP-scan and network-interface policies, DHCP discovery, routed networks, and external hosts
  • Control power — read a device's available power actions and its PDU outlets, then power on, off, cycle, or software-reboot
  • Back up device configurations and read the backup history
  • Open remote access — create a VPN session to a customer network, connect to a specific device, and take a snapshot from an ONVIF camera
  • Organize with custom tags, inventory fields, teams and areas, and manage who has access to your Domotz account

How StackJack authenticates to Domotz

Domotz uses a static API key sent on every request. You create the key in the Domotz Portal and paste it into StackJack. There is no OAuth and no refresh flow. Domotz's public setup guide does not publish an automatic lifetime for these keys, so treat the key as a long-lived credential, rotate it on your own schedule, and revoke it in Domotz when it is no longer needed.

Your API base URL matters as much as the key

This is the one thing to get right. Domotz hosts accounts on regional cells, and the cell name is part of the hostname:

RegionExample API base URL
United Stateshttps://api-us-east-1-cell-1.domotz.com/public-api/v1
Europehttps://api-eu-west-1-cell-1.domotz.com/public-api/v1

The cell is not something you can work out from your region alone — the number at the end is an index, and Domotz adds cells as it grows. Domotz shows the exact URL for your account on the same page as the API key, so copy both from that one screen. A perfectly valid key sent to the wrong cell will not authenticate.

Before you begin

  • In StackJack: you need a role that can manage connectors (tenant Owner, a co-owner, or an Administrator).
  • In Domotz: you need an account that can open Settings → API Key, plus that account's password to unlock key creation.
  • Both values to hand: the API key and the API base URL shown next to it.

Step 1 — Create an API key in Domotz

  1. Sign in to the Domotz Portal with an account that can manage API keys.
  2. Go to Settings → API Key.
  3. Choose Full Access API Key. Do not choose Agent Activation: that key type can enroll Collectors but cannot read or manage Public API resources.
  4. Choose Create API Key, enter your account password to unlock key creation, and give the key a descriptive name (for example, "StackJack Integration").
  5. Copy the key immediately and store it securely — Domotz does not show it again after you close the popup.
  6. In the same popup, note the Endpoint shown for your account. This is the API base URL you need in the next step.

Step 2 — Add the credentials in StackJack

  1. In the StackJack portal, open Connectors.
  2. Find the Domotz card. Click How To Connect for these steps inline, or Configure to enter the credentials.
  3. Paste your Domotz API base URL (it must start with https:// and include the /public-api/v1 path).
  4. Paste your API key.
  5. Click Save.

What happens when you save

  • The API key is stored encrypted in Azure Key Vault — never in the StackJack database, and never shown back to you.
  • If this is the first time you configure Domotz, a Free-tier subscription for the connector is created automatically so its Free tools work right away.
  • StackJack immediately live-validates the credentials by reading your Domotz account details. Validation never blocks the save: you will either see a success confirmation or a "saved but validation failed" warning with the reason.
  • The connector card shows the current connection and validity status from then on.

The validation read is the cheapest authenticated account call StackJack uses and every Full Access key can make it, so a success here proves both that your key is good and that your API base URL points at the right cell. That is exactly the pair of things worth confirming before your AI starts working.

Plans and available tools

  • Free includes Collector and device inventory, applications and device types, alerts and alert rules, alert-profile bindings, uptime and response-time history, speed-test results, monitored variables and datapoints, sensors, network-configuration policies, power-action and outlet listings, drivers and their execution logs, inventory fields, configuration-backup history, VPN session listings, network topology, access management, and your account's API usage and limits.
  • Pro adds actions for alert rules and profile bindings, device and credential changes, sensor lifecycle, network-configuration policies, power and outlet control, drivers, custom tags and inventory fields, configuration backups, remote connections and VPN sessions, camera snapshots, and access management.
  • Business offers the same tools as Pro with a higher usage allowance.

See the generated Domotz tool reference for the current inventory, plan assignment, input schemas, and destructive-action labels.

Domotz has no per-user sign-in for its API, so all AI traffic authenticates as the single API key — there is no per-user attribution. Current pricing and quotas are shown in the portal's Billing page and at checkout.

Two things to know about the tiers

Taking a camera snapshot is a read, but it is a Pro tool. It is the one exception to "reads are Free". Fetching a snapshot opens a real connection into the customer network — the same metered remote-connection budget a VPN session draws from — and returns an image of the customer's premises. Both of those make it worth putting behind the paid tier even though it changes nothing.

Know which actions are disruptive before you grant them. StackJack marks these as destructive: deletes (Collectors, devices, sensors, tags, users, alert rules, inventory fields), power and PDU outlet actions, custom-driver execution on a device, and bulk device-profile application. A few of these read more alarmingly than they behave — hiding a device and removing a device exclusion both use a delete operation in Domotz but neither destroys data — so each tool's description spells out what it actually does. Whether your AI application asks you to confirm before running one depends on that application's own settings — see Destructive tools and confirmation. Review those settings, and grant only the actions you want an AI to take.

Rate limits

Domotz enforces two limits: a maximum number of calls per minute and a maximum per rolling 24 hours. The actual ceilings depend on your Domotz plan, and Domotz does not publish default numbers.

StackJack paces requests conservatively per organization and backs off automatically if Domotz pushes back, so a long inventory read is usually just slower. Pacing is not a guarantee: retries are bounded, so a wide enough read can still come back throttled or time out. Narrow the read, honour any retry delay the vendor sends, and check whether a write landed before repeating it — see Retrying a failed or timed-out write.

Because the daily allowance is the one you can genuinely exhaust, the Get API Usage And Limits tool is available on every tier. Ask your AI to check it and you will see your account's real per-minute and per-day ceilings, how much of the daily allowance is already spent, and a breakdown by API key, source IP, and resource. That is the first thing to look at if calls start slowing down or failing.

Rotating or replacing the credentials

The API key is the recovery secret. If you regenerate or revoke it in Domotz, the stored credential becomes invalid. To restore access, open Connectors → Domotz → Configure in StackJack, paste the new key, and Save.

If you only need to correct the API base URL, you can leave the API key field blank and save — StackJack keeps the key it already has. This is the quickest fix for the most common Domotz setup mistake.

What the Domotz public API does not expose

Worth knowing up front, so you do not go looking for tools that cannot exist:

  • Alert profiles and webhooks are configured in the Domotz Portal, not the API. StackJack can list your Shared Alert Profiles and bind them to Collectors and devices, but it cannot create or edit a profile. The newer alert rules are fully API-managed, so use those when you want your AI to build alerting itself.
  • You cannot create a Collector through the API. Collectors are enrolled on-site.
  • Teams, areas, and moving a Collector between teams require the Domotz Enterprise plan. Those tools return an error on other plans.
  • One older tool is deprecated by Domotz — listing alert profiles for a specific user. Its replacement is included, and the deprecated tool's description says so.

Troubleshooting

SymptomLikely causeWhat to do
"Saved but validation failed" right after savingWrong cell in the API base URL, a mis-pasted key, or an Agent Activation keyRe-copy both values from Domotz Settings → API Key and confirm the key type is Full Access API Key. The URL is account-specific — do not infer it from your region
Every tool returns "not found"The API base URL is missing the /public-api/v1 pathRe-enter the full URL including that path, for example https://api-us-east-1-cell-1.domotz.com/public-api/v1
Tools worked, then all started failingThe API key was regenerated or revoked in DomotzPaste the current key in Connectors → Domotz → Configure and save
One tool returns a permission error while others succeedYour Domotz plan does not include that capabilityDomotz keys are not scoped per endpoint, so this is a plan limit rather than a key problem. Team and area tools need the Enterprise plan
Calls slow down during a large readStackJack is pacing requests towards Domotz's limitsExpected. Narrow the read if it does not finish.
Calls start failing after heavy use, then recover laterThe account's 24-hour call allowance was exhaustedAsk your AI for Get API Usage And Limits to confirm. The allowance refills on a rolling 24-hour basis; reduce how often you poll, or ask Domotz to raise the limit
A camera snapshot or VPN session tool is missingThe connector is on the Free tierBoth are Pro tools. Upgrade the Domotz connector plan, then check your tool selections on the MCP Setup page
A snapshot or VPN config download link stops workingThe link is deliberately short-livedThese tools return a download link valid for a few minutes rather than embedding the file. Run the tool again to get a fresh link
Your AI cannot create an alert profileThe public API has no create/edit for alert profilesExpected — create the profile in the Domotz Portal, then have your AI bind it, or use alert rules instead

Domotz tools

domotz_ · 159 tools · Free 80 · Pro 79

Account & Metadata

ToolWhat it does
domotz_get_account
Free · Read-only
Returns the Domotz account the configured API key belongs to — account name, plan, and owner details.
domotz_get_api_usage
Free · Read-only
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_list_device_base_types
Free · Read-only
Returns Domotz's full device-type vocabulary (the canonical list of types a device can be classified as).
domotz_list_device_detected_types
Free · Read-only
Returns only the device types actually detected across this account's monitored networks — a much shorter list than domotz_list_device_base_types.

Collectors

ToolWhat it does
domotz_create_team
Pro · Write
Creates a new Team.
domotz_delete_collector
Pro · Destructive
Deletes a Collector and everything recorded through it — its devices, their history, sensors, and configuration.
domotz_get_collector
Free · Read-only
Returns the details of a collector.
domotz_get_collector_activity_log
Free · Read-only
Returns the activity log of a collector.
domotz_get_collector_ip_conflicts
Free · Read-only
Returns the list of active IP conflicts on a collector.
domotz_get_network_topology
Free · Read-only
Returns the collector's network topology.
domotz_list_areas
Free · Read-only
Returns all the areas of a Company.
domotz_list_collectors
Free · Read-only
Returns the list of collectors accessible by the user.
domotz_list_teams
Free · Read-only
Returns all the teams of an Area.
domotz_move_collector_to_team
Pro · Write
Moves a collector under the control of a different team.

Devices

ToolWhat it does
domotz_add_excluded_device
Pro · Write
Excludes a device from monitoring on this Collector, which removes it from the monitored device list and stops its alerts.
domotz_apply_device_profile
Pro · Destructive
Applies a device profile to a set of devices, re-configuring EVERY device you list in one call.
domotz_delete_device
Pro · Destructive
Deletes a device, whether ONLINE, OFFLINE or DOWN.
domotz_delete_excluded_device
Pro · Destructive
Removes a device's EXCLUSION, which RESTORES monitoring for it — this is the opposite of a deletion despite the underlying delete operation.
domotz_delete_offline_devices
Pro · Destructive
Deletes ALL currently-offline devices from a Collector in one call — not one device, every offline one.
domotz_get_device
Free · Read-only
Returns the details of a device.
domotz_get_snmp_authentication
Free · Read-only
Returns the SNMP authentication info.
domotz_hide_device
Pro · Destructive
Hides a device from the Collector's views.
domotz_list_collector_device_applications
Free · Read-only
Returns the list of applications of all the devices belonging to the collector.
domotz_list_device_applications
Free · Read-only
Returns the list of applications of the device.
domotz_list_device_profiles
Free · Read-only
Returns the list of the available device profiles.
domotz_list_devices
Free · Read-only
Returns all the devices of a collector.
domotz_list_excluded_devices
Free · Read-only
Returns all the excluded devices of a collector, i.e., devices present in Device Blacklist section.
domotz_list_unmanaged_devices
Free · Read-only
Returns the list of unmanaged Devices for a specific Collector.
domotz_set_credentials
Pro · Write
Sets the device credentials to perform extended discovery.
domotz_set_snmp_authentication
Pro · Write
Sets the SNMP authentication info.
domotz_set_snmp_community
Pro · Write
Saves a snmp community (read, optionally write) on device.
domotz_update_device_monitoring_state
Pro · Write
Changes a device's monitoring state.
domotz_update_device_property
Pro · Write
Changes a property of the device.

Alerts & Alert Rules

ToolWhat it does
domotz_apply_alert_rule_to_collector
Pro · Write
Applies an Alert Rule to a Collector so it monitors every Device on the Collector.
domotz_apply_alert_rule_to_device
Pro · Write
Applies an Alert Rule to a single Device.
domotz_apply_contact_channel_to_alert_rule
Pro · Write
Applies a Contact Channel to an Alert Rule so notifications for incidents matching the rule are routed to that channel.
domotz_create_alert_rule
Pro · Write
Creates a new Alert Rule with a datapoint, condition, severity, operands.
domotz_get_alert_rule
Free · Read-only
Returns the complete configuration details for a specific Alert Rule.
domotz_list_alert_rules
Free · Read-only
Returns all Alert Rules configured in the account, including severity, datapoint, condition, Contact Channels, status.
domotz_list_alerts
Free · Read-only
Returns alert events generated by Alert Rules, including active and resolved alerts.
domotz_list_collector_alert_rules
Free · Read-only
Returns the Alert Rules currently applied to a Collector.
domotz_list_contact_channels
Free · Read-only
Returns the Contact Channels available for alert notifications within the account.
domotz_list_device_alert_rules
Free · Read-only
Returns the Alert Rules currently applied to a Device.
domotz_remove_alert_rule_from_collector
Pro · Destructive
Removes an Alert Rule from a Collector.
domotz_remove_alert_rule_from_device
Pro · Destructive
Removes an Alert Rule from a Device.
domotz_remove_contact_channel_from_alert_rule
Pro · Destructive
Removes a Contact Channel from an Alert Rule.
domotz_resolve_alert
Pro · Write
Manually resolves an active alert and records the authenticated user as the resolver.
domotz_update_alert_rule
Pro · Write
Updates one or more fields of an existing Alert Rule, such as name, severity, condition, operands, or status.

Alert Profiles

ToolWhat it does
domotz_bind_alert_profile_to_collector
Pro · Write
Bind an alert profile to a collector.
domotz_bind_alert_profile_to_device
Pro · Write
Bind an alert profile to a device.
domotz_get_collector_alert_profile_bindings
Free · Read-only
Returns the alert profile bindings of a collector.
domotz_get_device_alert_profile_bindings
Free · Read-only
Returns the alert profile bindings of the devices of a collector.
domotz_list_alert_profiles
Free · Read-only
Returns the list of configured alert profiles.
domotz_list_user_alert_profiles_deprecated
Free · Read-only
Returns the list of configured alert profiles.
domotz_unbind_alert_profile_from_collector
Pro · Destructive
Unbind an alert profile from a collector.
domotz_unbind_alert_profile_from_device
Pro · Destructive
Unbind an alert profile from a device.

Access Management

ToolWhat it does
domotz_create_user
Pro · Write
Create a new RBAC User.
domotz_create_user_group
Pro · Write
Create a new RBAC User group.
domotz_delete_user
Pro · Destructive
Delete an RBAC User by user ID.
domotz_delete_user_group
Pro · Destructive
Delete an RBAC User group by user group ID.
domotz_edit_user
Pro · Write
Update an RBAC User by user ID.
domotz_edit_user_group
Pro · Write
Update an RBAC User group by user group ID.
domotz_get_role
Free · Read-only
Retrieve a Role and its Permissions.
domotz_get_user
Free · Read-only
Retrieve RBAC User details by User ID.
domotz_get_user_group
Free · Read-only
Retrieve RBAC User group details by user group ID.
domotz_list_roles
Free · Read-only
List all RBAC roles and associated user groups.
domotz_list_user_groups
Free · Read-only
List all RBAC User groups with their details.
domotz_list_users
Free · Read-only
List all RBAC Users with their details.

Custom Tags

ToolWhat it does
domotz_create_collector_custom_tag_binding
Pro · Write
Assigns a Tag to a Collector.
domotz_create_custom_tag
Pro · Write
Creates a new Tag.
domotz_create_device_custom_tag_binding
Pro · Write
Assigns a Tag to a Device.
domotz_delete_collector_custom_tag_binding
Pro · Destructive
Removes a Tag from a Collector.
domotz_delete_custom_tag
Pro · Destructive
Deletes a Tag and removes it from Collectors and Devices.
domotz_delete_device_custom_tag_binding
Pro · Destructive
Removes a Tag from a Device.
domotz_edit_custom_tag
Pro · Write
Updates one or more properties of an existing Tag.
domotz_get_collector_custom_tag_bindings
Free · Read-only
Retrieves all Tags assigned to a specific Collector.
domotz_get_device_custom_tag_bindings
Free · Read-only
Retrieves all Tags assigned to a specific Device.
domotz_list_custom_tags
Free · Read-only
Retrieves all Tags available in the account, including their metadata and usage counts.

Metrics & Datapoints

ToolWhat it does
domotz_get_all_collectors_uptime
Free · Read-only
Returns the uptime of all collectors.
domotz_get_collector_rtd_stats
Free · Read-only
Returns the Round Trip Delay statistics for all devices monitored by the collector.
domotz_get_collector_status_history
Free · Read-only
Returns the time series of the state changes of the collector.
domotz_get_collector_uptime
Free · Read-only
Returns the uptime of the collector.
domotz_get_collector_variable_history
Free · Read-only
Returns the collector variable history.
domotz_get_datapoint_details
Free · Read-only
Returns 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_history
Free · Read-only
Returns the Round Trip Delay history for the device.
domotz_get_device_status_history
Free · Read-only
Returns the time series of the state changes of the device.
domotz_get_device_uptime
Free · Read-only
Returns the uptime of the device.
domotz_get_device_variable_history
Free · Read-only
Returns the device variable history.
domotz_get_speed_test_history
Free · Read-only
Returns the time series of the Internet Speed measurements taken from the collector, both in download and in upload.
domotz_list_collector_datapoints
Free · Read-only
Returns the datapoints available for Alert Rules on a Collector.
domotz_list_collector_device_variables
Free · Read-only
Returns the list of all device variables of the collector.
domotz_list_collector_variables
Free · Read-only
Returns the list of all collector variables of the collector.
domotz_list_device_datapoints
Free · Read-only
Returns the datapoints available for Alert Rules on Device.
domotz_list_device_variables
Free · Read-only
Returns the list of device variables.

Sensors (Eyes)

ToolWhat it does
domotz_create_device_snmp_sensor
Pro · Write
Creates a new SNMP sensors.
domotz_create_device_tcp_sensor
Pro · Write
Creates a new TCP sensors.
domotz_create_snmp_sensor_trigger
Pro · Write
Creates a new SNMP Trigger for the sensor.
domotz_create_snmp_trigger_alert
Pro · Write
SNMP sensor trigger alert creation.
domotz_delete_device_snmp_sensor
Pro · Destructive
Deletes the SNMP sensor.
domotz_delete_device_tcp_sensor
Pro · Destructive
Deletes the TCP sensor.
domotz_delete_snmp_sensor_trigger
Pro · Destructive
Deletes the SNMP Trigger for the sensor.
domotz_delete_snmp_trigger_alert
Pro · Destructive
Deletes the alert for thee SNMP Trigger.
domotz_get_metric_usage_info
Free · Read-only
Returns Domotz Sensors usage and limits.
domotz_get_sensor_usage_info
Free · Read-only
Returns information about Domotz Sensors usage and limits.
domotz_get_snmp_sensor_history
Free · Read-only
Returns the time series of the SNMP sensor collected samples.
domotz_list_collector_snmp_sensors
Free · Read-only
Returns the list of configured SNMP sensors on the collector.
domotz_list_collector_tcp_sensors
Free · Read-only
Returns the list of configured TCP sensors on the collector.
domotz_list_device_snmp_sensors
Free · Read-only
Returns the list of configured SNMP sensors.
domotz_list_device_tcp_sensors
Free · Read-only
Returns the list of configured TCP sensors.
domotz_list_snmp_sensor_trigger_functions
Free · Read-only
Returns the list of functions for the SNMP sensor trigger.
domotz_list_snmp_sensor_triggers
Free · Read-only
Returns the list of triggers for the SNMP Sensor.

Network Configuration

ToolWhat it does
domotz_create_external_host
Pro · Write
Creates an external host.
domotz_create_routed_network
Pro · Write
Creates a routed network.
domotz_get_collector_ext_host_scan_policy
Free · Read-only
Returns the current external host scan policy.
domotz_get_collector_interfaces
Free · Read-only
Returns the networks monitored by the collector.
domotz_get_collector_interfaces_policy
Free · Read-only
Returns the current network interface filtering policy.
domotz_get_collector_ip_scan_policy
Free · Read-only
Returns the current IP addresses management policy.
domotz_reset_collector_ext_host_scan_policy
Pro · Destructive
Resets the Collector's external-host scan policy back to the Domotz default, discarding any custom policy you set.
domotz_reset_collector_interfaces_policy
Pro · Destructive
Resets the Collector's network-interface filtering policy back to the Domotz default, discarding any custom policy you set.
domotz_reset_collector_ip_scan_policy
Pro · Destructive
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.
domotz_set_collector_ext_host_scan_policy
Pro · Write
Updates the current external host scan policy.
domotz_set_collector_interfaces_policy
Pro · Write
Updates the current network interface filtering policy.
domotz_set_collector_ip_scan_policy
Pro · Write
Updates the current IP address scan policy.
domotz_set_dhcp_device_discovery
Pro · Write
Enable/disable the collector DHCP Device Discovery.

Power Management

ToolWhat it does
domotz_attach_device_to_power_outlet
Pro · Write
Attach a device to a power outlet.
domotz_detach_device_from_power_outlet
Pro · Destructive
Detach a device from a power outlet.
domotz_list_device_power_actions
Free · Read-only
Returns the power management actions available on the device at the current moment.
domotz_list_device_power_outlets
Free · Read-only
Returns a list of the power outlets discovered on the device.
domotz_rename_device_power_outlet
Pro · Write
Update the power outlet with the specified custom name.
domotz_run_device_power_action
Pro · Destructive
Physically powers a device on, off, through a full power cycle, or issues a software reboot.
domotz_run_power_outlet_action
Pro · Destructive
Physically switches a PDU outlet on, off, or through a power cycle.

Custom Drivers

ToolWhat it does
domotz_create_driver_association
Pro · Write
Apply a Driver to a device.
domotz_delete_driver_association
Pro · Destructive
Remove a Driver from a device.
domotz_execute_driver_action
Pro · Destructive
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.
domotz_get_driver
Free · Read-only
Returns details of a Driver.
domotz_list_collector_driver_associations
Free · Read-only
Retrieves a list of all Driver associations for a collector.
domotz_list_collector_driver_execution_logs
Free · Read-only
Returns recent drivers execution logs for the given collector's devices, newest first.
domotz_list_device_driver_execution_logs
Free · Read-only
Returns recent drivers execution logs for the given devices, newest first.
domotz_list_drivers
Free · Read-only
Retrieves the list of available Drivers.
domotz_reenable_driver_associations
Pro · Write
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_update_driver_association
Pro · Write
Update the parameters for a Driver association.

Inventory Fields

ToolWhat it does
domotz_create_inventory_field
Pro · Write
Creates a new Inventory Field - the user will be able to set key-values pairs on every device.
domotz_delete_all_inventory_fields
Pro · Destructive
Deletes 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_field
Pro · Destructive
Deletes the Inventory field for the device.
domotz_delete_inventory_field
Pro · Destructive
Deletes the Inventory Field.
domotz_get_device_inventory
Free · Read-only
Returns the device's inventory data.
domotz_list_inventory_fields
Free · Read-only
Enumerates all the Inventory fields.
domotz_set_device_inventory_field
Pro · Write
Sets the value of an Inventory field for the device, a value can't be set to `null`.
domotz_update_inventory_field
Pro · Write
Updates the Inventory Field.

Configuration Backups

ToolWhat it does
domotz_backup_device_configuration
Pro · Write
Sends a command to backup a device configuration.
domotz_create_device_configuration
Pro · Write
Creates a device configuration backup in the configuration history.
domotz_get_device_configuration
Free · Read-only
Returns the details of a device configuration entry.
domotz_list_device_configurations
Free · Read-only
Returns the list of available device configurations.

Remote Connections & Multimedia

ToolWhat it does
domotz_connect_to_device
Pro · Write
Establishes a direct secure connection to the `device`.
domotz_create_collector_vpn_session
Pro · Write
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.
domotz_delete_collector_vpn_session
Pro · Destructive
Closes an active VPN connection session for the collector.
domotz_get_connection_consumption
Free · Read-only
Returns the remote connection consumption on the given collector.
domotz_list_collector_vpn_sessions
Free · Read-only
Returns the active VPN connections for the collector.
domotz_take_camera_snapshot
Pro · Read-only
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.