How to get a Domotz Public API key and endpoint

At a glance

Copy the Public API key and account-specific connection address from the Domotz developer area, then add both values to RMMBackup. The steps below help you choose the correct values and validate access.

Configure the Domotz account-specific API Key Endpoint and Public API key, then troubleshoot authentication, permissions, and endpoint errors.

Published Updated

On this page

Obtain the Public API values

Open the Domotz developer area and obtain both values shown for your account:

  1. Copy the API Key Endpoint exactly as supplied by Domotz.
  2. Create or copy a Public API key intended for the integration.
  3. Store the key in an approved secret manager and do not place it in URLs, screenshots, tickets, or documentation.
  4. Record the intended account, plan, organizations, and collectors separately.

Do not substitute a Collector Activation Key. It is used for collector activation, which RMMBackup never performs.

Enter the endpoint safely

In Settings > Integrations, select Domotz and enter the account-specific endpoint plus API key. The endpoint must use HTTPS on port 443. RMMBackup accepts either the supplied origin or an endpoint ending in /public-api/v1 and normalizes it to one API root.

Do not replace the host with an example region or a host from another account. Redirects are rejected so the key cannot be forwarded to a different destination.

Validate the connection

The connection test performs documented read-only requests, verifies the authenticated account, checks current API usage information, and lists collectors. It reports sanitized counts and does not return the key to the browser or logs.

Confirm the collector count against the intended account before enabling the connection. A valid key with restricted permissions can authenticate while still hiding optional resources.

Troubleshoot connection problems

  • Authentication failed: confirm the value is a Public API key, copy it again without surrounding whitespace, and check whether it was revoked.
  • Permission denied: the key authenticated but lacks access to the requested resource or feature.
  • Endpoint rejected: use the account-specific HTTPS endpoint supplied by Domotz; private, loopback, credential-bearing, redirected, or nonstandard-port destinations are blocked.
  • No collectors returned: verify the account and permission scope before treating the response as an empty environment.
  • Throttled or temporarily unavailable: wait for the bounded retry window, then review the account usage and concurrency information.

Protect the credential

RMMBackup encrypts the saved key and uses it only for your MSP's Domotz connection. Continue with Domotz backup setup and the Domotz export guide.

Frequently asked questions

Which header does the Domotz Public API use?

The documented authentication header is X-Api-Key. RMMBackup sends it only to the validated configured host.

Can I use a Collector Activation Key?

No. Collector activation and Public API authentication are separate. Use a Public API key from the Domotz developer area.

Official source

Domotz Public API developer portal

Official Domotz source for Public API access, the API Key Endpoint, and X-Api-Key authentication.

Related Domotz integration

Review current Domotz backup coverage and availability.