Domotz

Overview

Authorization with Domotz requires an API key and API endpoint URL, the API key should have a scope to cover all devices to be monitored.


API Access Requirements

To use the Domotz cloud API with Xyte, make sure you have:

  • Required account / tenant: Domotz account
  • Required access: Agent deployed
  • Required plan / license: At least an advanced tier; basic/lite does not support the required API access
  • Where to verify: Domotz pricing page

How to Retrieve Your Domotz API Key and Endpoint

API Key

  1. Log in to your Domotz Account
  2. Once logged in, go to the Settings menu (found in the top-right corner or side navigation).
  3. Generate or Copy Your API Key
    1. If you already have an API key, you will see it listed here.
    2. If not, click Generate API Key and follow the prompts.

Locate the API Endpoint URL

The API Endpoint URL is typically displayed in the same section as the API key. Copy the URL.
Example: https://api.domotz.com/v1/.


Please be aware that in order for the devices to be monitored, they must be added to Managed Devices by clicking “Add to Managed Devices.”


Additional information

Connector root space name: Domotz

If deleted and re-added:

⚠️

Deleting this connector will remove all imported devices and their data. This action cannot be undone.

  • A new connector will be created upon re-adding.
  • If the name Domotz already exists, the new connector will be named Domotz 1.
  • The device tree will be re-imported under the new connector.
  • The tree hierarchy will not be deleted.