API Key

The REST API of Timeplus Enterprise is secured by API key. Currently this is only enabled in Timeplus Enterprise SaaS edition and will be available for self-hosted deployment soon.

You need to create an API key to access the Timeplus REST API. Here’s how to create one:

1. Click on your avatar in the top right corner. In the dropdown, click Personal Settings.

2. In the API Keys section, click the Create API Key button.

3. Enter an optional description for the key, choose an expiration date if needed, and click Create.

4. The API key will only be shown to you once - make sure you securely save it right away. You won’t be able to retrieve the key again later in the console.