The Domotz Public API (RESTful) provides developers with an easy and comprehensive way to integrate third party applications.
The OpenAPI definition can be found at this URL: https://api-us-east-1-cell-1.domotz.com/public-api/v1/meta/open-api-definition
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 Collectors.
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 Collectors 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 Collectors from Command Line, create an Agent Activation Key.
Managing API Keys in the Domotz Portal
1. Navigate to the "Settings" section of the Domotz portal.
2. Select the "API Keys" tab under the "Services" heading.
3. Use the "API Reference" button to access detailed API documentation.
4. To create a new API Key, click the "+ Create an API Key" button. For a Collector Activation Key, use the "+ Create a Collector Activation Key" button.
5. View existing API Keys and their details, including the API Key name, number of calls made in the last 24 hours, and the creation date. For instance, an API Key named "CLI" shows 0 calls and was created on December 15, 2025.
6. Similarly, check the details for existing Collector Activation Keys, such as "NewPTest," created on June 24, 2025.
Note: A Collector Activation Key can be securely distributed to colleagues (or included in scripts). It is only valid to activate new Collectors under your master account. With this type of API Key it is not possible to retrieve information about the Collectors or Devices configured under your account.
Please refer to Manage your Domotz Collector installation for an example of the usage of the Collector Activation 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 API Key Management Screen
1. To proceed with creating a Public API Key, enter your Domotz account password in the provided field labeled "Enter your Password."
2. Click the "Unlock" button to submit the password and gain access to API Key management.
3. If you wish to exit without making changes, select the "Cancel" button.
Name the API Key:
Prompt to provide an API Key friendly name.
1. Enter a name in the text field labeled "API Key Friendly Name." The example shown is "My Key."
2. To edit the name, click the pencil icon next to the text field.
3. Once the desired name is entered, click the "Create" button to proceed.
4. To cancel the process, click the "Cancel" button.
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.
API Key Creation Confirmation Dialog
1. A confirmation message states "The API Key is created."
2. Important note: "For security, the following information will not be available after closing this message."
3. The section labeled "API Key" displays the key "Z9ptKogLcYZbmI49vzmhchBfIBGgxeFhhhh," with a "Copy" button to the right for easy copying.
4. The "Endpoint" section provides the URL "https://api-eu-west-1-cell-1.domotz.com/public-api/v1/".
5. The "API Name" section shows "My Key".
6. To close the dialog, use the "Done" button at the bottom.
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.