Skip to main content

How to enable API?

How to create API users?

Before enabling the API, you will first need to create an API key. On the Web

  1. Visit

  2. The org admin navigates to the API page and clicks " Create an API user " to enter the editing page.

  3. In the pop-up window, fill in the following fields:

    • Name: Enter a unique name to identify the API user. Note that the name must be unique within the same organization and cannot be repeated.

    • Permission: Depending on your needs, select the vaults that the API users will have access to set the permission level for the API users.

    • IP Whitelist: Complete this field to restrict API user access to only specific IP address ranges. You can enter up to 3 IP addresses. Please separate multiple addresses with commas.

  4. After filling in the information, click the " Create " button to finalize the creation of the API user.

  5. Save the API token. After you've created the API user, the system will display a pop-up window with your API token. Copy and save the API token in a secure place for future use.

    Docusaurus Plushie


You will not be able to retrieve the full API token from the system again. If you lose this token, you will need to generate a new one.

With the API tokens, you will be able to interact with our systems. Here are some examples: GitHub repository

Detailed API setup guide

A more detailed setup guide can be found here: