Domotz API

The Domotz Public API (RESTful) provides developers with an easy and comprehensive way to integrate third party applications.

API Keys

An application programming interface key (API Key) is the code required in your own application to execute RESTful API calls against the Domotz Cloud, allowing you to retrieve and manage your own account and your Domotz Agents.

There are two base roles for the API Key:

  • Full Access API Key with full access to all the Public API as documented in the Domotz Pro Public API.
  • Agent Activation only API Key which can only be used for the Activation of New Agents under your account.

You will need at least one API Key to access to your data through the Domotz Pro Public API.

Create the API Key:

  • If you are planning to use the API Key to connect to the Domotz Public API, create API Key.
  • If you are planning to use the API Key for the Activation of New Agents from Command Line, create an Agent Activation Key.

Note: an Agent Activation API Key can be securely distributed to colleagues (or included in scripts). It is only valid to activate new Agents under your master account. With this type of API Key it is not possible to retrieve information about the Agents or Devices configured under your account.
Please refer to section Windows OS with example on the usage of the Agent Activation API Key.

To create API Key you need to visit the Portal, under Settings section select the API Key tab: click on create a API Key, fill the password of your account to unlock the service, give a name to a new API Key. 

Unlock the API key:

Unlock the API Key

Name the API Key:

Name the API key

Now new API key is created! You can see its code and Endpoint.

Don’t forget to copy the API Key code and save it in a safe place, clicking on Copy. Please, note that after closing the popup you will not be able to do see the key anymore.

Copy the API Key

You will see the created API key and control the number of calls made during the last 24 hours.

For more details, visit the Portal under Settings and API Key section.

You can create multiple API keys if you need to.

Updated on December 7, 2020

Was this article helpful?