API keys

Under Settings → Project Settings → API Keys, you can create and manage API keys that allow external software to communicate with the Voltmasters API for this project.

What is an API key?

An API key is a secure access token that lets your own software, scripts or third-party tools, such as home automation systems, reporting tools or custom integrations, interact with the Voltmasters API for this specific project. Each key is scoped to this project and grants the permissions needed to read or write data via the API.

Creating an API key

1. Navigate to Settings → Project Settings → API Keys.

2. Click Create API key.

3. Enter a recognisable name for the key, for example home-automation or reporting-script.

4. The secret portion of the key is displayed only once, at the moment of creation. Copy it immediately and store it in a secure location. It cannot be retrieved again.

If you lose the secret, you will need to create a new API key and update any integrations that use the old one.

API documentation

Click the API Documentation button to open the full reference for all available API endpoints, parameters and usage examples. This documentation is hosted on the Voltmasters documentation portal.