The CloudRadial AutomationAI Domotz extension lets a workflow or agent work with your Domotz network monitoring: list your Collectors and the devices they monitor, check device uptime, state changes, and latency, review alerts, and, with approval, add a note to a device, resolve an alert, or open a secure remote connection to a device. This article covers what the extension can do, the API key and secrets it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API Key
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Domotz Data
What the Extension Covers
The extension calls the Domotz Public API and provides 14 tools across these areas:
| Area | What you can automate |
| Collectors | List the Collectors on your account, filtered by display name or team name, read one Collector's status, software version, and location, and list the networks and interfaces it monitors |
| Devices | List the devices a Collector monitors, with each device's status and importance, read one device's IP and MAC addresses, vendor, type, protocol, and discovered ports, and add a note to a device |
| Device health | Read a device's uptime history, its up and down state-change events, and its round-trip delay (latency) statistics |
| Alerts | List alerts across the account, filtered by time window, severity, status, alert rule, Collector, or device, and resolve an alert |
| Remote connections | Open a secure remote connection (HTTPS, RDP, Telnet, SSH, or TCP tunnel) to a device, list a Collector's active VPN sessions, and report a Collector's remote-connection data consumption |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Creating the API Key
The extension signs in to Domotz with a Full Access API Key, sent on every request.
- In the Domotz Portal, go to Account and open the API Key tab.
- Authenticate with your account password, name the key, and create it as a Full Access API Key. An Agent Activation only key does not work with this extension.
- Copy the key right away. Domotz shows it only once.
Confirm your account's cell on the same tab. You need it for the API base URL in the next step.
Providing the Credentials to Your Runner
Store two secrets in your runner's Key Vault with these exact names:
| Secret | Value |
Domotz-ApiUrl |
The full regional API base URL for your account, ending in /public-api/v1, for example https://api-us-east-1-cell-1.domotz.com/public-api/v1. The host depends on the cell your account lives in, for example api-eu-west-1-cell-1.domotz.com. |
Domotz-ApiKey |
The Full Access API Key you created in the Domotz Portal |
For how to add secrets, see Accessing and updating your runner's Key Vault.
Reads and Approval-Gated Changes
Of the 14 tools, 11 only read data and run without approval. The other three change data in Domotz or open access to a device, so they pause the run for approval. The request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Set a device's note; resolve an alert; open a secure remote connection to a device |
| Read-only | List and read Collectors; list a Collector's networks and interfaces; list and read devices; read device uptime, network events, and latency; list alerts; list VPN sessions; read remote-connection consumption |
When an agent opens a remote connection, it is instructed to report only the non-secret session details and to redact any password or token the connection returns.
Skills
The extension ships four skills that guide an agent through common Domotz tasks:
| Skill | Use it to |
| Inventory Sites and Devices | List your Collectors and the devices they monitor, for example "what devices does the Acme office Collector see," or find the ids other steps need. Read-only. |
| Investigate Device Health | Diagnose a device's availability, uptime, or latency, for example whether a firewall is down or why a device is slow. Read-only. |
| Review and Resolve Alerts | List active alerts, filter them by site, device, or severity, annotate the affected device, or mark an alert resolved. Notes and resolving are approval-gated. |
| Manage Remote Connections | Open a secure remote connection to a device, list a Collector's active sessions, or report remote-connection data consumption. Opening a connection is approval-gated. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With Domotz Data
- The Domotz API refers to a Collector as an "agent," so you may see that term in run output. Almost every device call sits under its Collector, so an agent run finds the Collector first and then the device.
- Uptime, network event, and latency reads accept a from and to time. If you give no window, uptime covers the prior week.
- The note tool changes only a device's note. It does not change the device's name, room, zone, or importance.
- When you ask for a remote connection, name the connection type and the target port
- Domotz has no list of remote connections per device. To see open sessions, ask for the Collector's active VPN sessions.
- If every call fails, check that
Domotz-ApiUrlmatches your account's cell and that the key is a Full Access API Key
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.