API Tokens

Create temporary and permanent API Tokens

DuploCloud supports two kinds of API tokens: temporary and permanent. For normal use cases, we recommend using a temporary API token. A permanent API token is warranted for CI/CD or other DevOps automation. Permanent API tokens expire after one year.

Temporary API Tokens

Retrieving a Temporary API token

Every time a user logs in to DuploCloud, a temporary API token is created for that user that only lasts for their session. Any user can retrieve their temporary API token from DuploCloud:

1. Click on the user icon () in the upper right, and select Profile.

2. Click the copy icon () in the Temporary API Token area.

3. Click on the person icon in the upper right, and select Profile.

4. Click the copy icon (

Profile page with Temporary API Token area

Permanent API Tokens

Permanent tokens can be created by Administrators from the Users page or the Profile page. These tokens are always associated with a specific DuploCloud user.

Note: Permanent API tokens expire after one year.

Creating a Permanent API Token from the Users Page

1. In the DuploCloud Portal, navigate to Administrator -> Users.

2. Select the user from the USERNAME list. The user's page displays.

   

   Users page with Tokens tab

3. Select the Tokens tab.

4. Click Add. The Create a new token pane displays.

   

   Create a new token pane

5. Create a meaningful Token Name.

6. Click Create. A window containing the token displays.

   

   Window with Token and Copy button

7. Click the Copy button to copy your token to the clipboard. Store it somewhere safe. You cannot retrieve it from DuploCloud.

Creating a Permanent API Token from the Profile Page

Only administrators can access this option.

1. Click the user icon () in the top-right corner, then select Profile.

2. Under Permanent API Token, click Add. The Add User Token screen displays.

   

   Add User Token screen
3. Enter a meaningful Token Name.

4. Click Create. A window containing the token displays.

5. Click Copy to copy your token to the clipboard. Store it somewhere safe. You cannot retrieve it from DuploCloud.

You will not be able to retrieve your token from DuploCloud after you have created it. However, if you lose your token, you can always create a new one.

Configuring Notifications for API Tokens Nearing Expiration

You can configure DuploCloud system settings to generate faults and send notification emails when API tokens are nearing expiration.

Generating a Fault When API Tokens are Near Expiration

1. From the DuploCloud portal, navigate to Administrator -> Systems Settings.

2. Select the Config tab, and click Add. The Add Config pane displays.

   

   Add Config pane
3. Complete the following fields:

Config Type	Select App Config
Key	Select Enable User Token Expiration Notifications
Value	Enter the number of days before token expiration when faults should appear

1. Click Submit. DuploCloud will generate a fault when an API token is the set number of days from expiration.

Sending Automatic Notifications when API Tokens Near Expiration

1. From the DuploCloud portal, navigate to Administrator -> Systems Settings.

2. Select the Config tab, and click Add. The Add Config pane displays.

   

   Add Config pane
3. Complete the following fields:

Config Type	Select App Config
Key	Select User Token Expiration Notification Emails
Value	Enter the user email addresses (separated by semicolons) to receive notifications

1. Click Submit. DuploCloud will email the listed email address(es) when an API token is set to expire in a set number of days.