Skip to main content
Generate API Key

How to generate a new API key for your workspace.

Updated over a week ago

API Key generation is a Pro feature. Reach out to your CSM or contact Support@Epsilon3.io to learn more.

The Epsilon3 API supports starting runs, serving data from external sources, streaming telemetry for real-time display, sending commands, and listening for notifications. These features are supported using a combination of REST API endpoints and websockets.

Configuring external data fields, telemetry parameters, and commands is supported using REST endpoints, as is starting a run. External data searches, serving real-time telemetry, handling commands, and listening for notifications are handled using Socket.IO.

Check out our API Docs to learn more about what you can do with our API!

To generate an API Key, navigate to your Epsilon3 workspace and click into Settings from the left navigation pane.

Only Admins are able to perform this action!

Click into the API section.

Here you can view your Active and Deactivate API keys with their creation dates.

Click + Generate New API Key to generate a new one.


A window will pop up which will display your API ID and Key.

Save this key. It cannot be retrieved after dismissing the dialog box.

Once you have saved the key, click the Dismiss button.

Our API uses Basic Auth with the username being your generated API Key and the password left blank.

Did this answer your question?