Skip to main content
Druva Documentation

Create and Manage API Credentials

Overview

Third-party applications and tools can access Druva REST APIs only if the third-party applications and tools are successfully authenticated using API credentials. The API credential is a combination of Client ID and Secret Key and is equivalent to that of a user name and password.

As a Druva Cloud Administrator, you can create and manage API credentials from the Druva Cloud Platform Console. As a Druva Cloud administrator, you can also provide these API credentials to the developers within your organization to integrate various applications, tools, services, scripts with Druva products. 

This article provides instructions to create and manage API credentials. 

  • Only Druva Cloud administrators can create and manage API credentials. 
  • If the API integration feature is not enabled for your account, contact Druva Support

Manage API Credentials

Click the Druva logo DruvaIcon.png to access the Global Navigation Panel > Druva Cloud Settings > API Credentials. 
You see the following page when you access the API Credentials

BRDR.png

You can perform the following actions over the API Credentials page

  • Create new credentials
  • Generate new secret key
  • Rename existing credentials 
  • Delete credentials 

Create new credentials 

On the API Credentials page, perform the following steps to create new credentials: 

  1. Click New Credential. The New Credentials window appears. 
  2. Provide a name for the credential and click Submit. The Credential Details window appears. 

    For ease of recognizing the credential name, it is recommended to name the credential so as it matches with the name of the application or tool which you intend to integrate with Druva products. 

  3. Click Copy_Button.png icon to copy the auto-generated Client ID and Secret Key to the clipboard.

    Client ID and Secret Key are equivalent to user name and password. One can access all the Druva APIs and in turn, access your data stored within Druva products. Client ID and Secret Key must not be shared with unauthorized sources.

    • Secret Key is required to authenticate third-party applications to generate the access token.
    • You need to generate a new Secret Key for the associated credential if you do not copy the Secret Key as per step 3.
    • API usage and activities can be tracked through audit trails. The audit trails display the API credential details, target APIs, and user details along with the time of usage. 
  4. Refer API integration workflow, to learn more about the workflow.

Generate new secret key

In case the Secret Key is lost, stolen, or you failed to copy at the time of generating New Credential, you must generate a new Secret Key.  

  • If you generate a new Secret Key for the API credential which is currently in use, all the active tokens associated with the old Secret Key along with the old Secret Key will be revoked.
  • Any subsequent call request for authentication using the old Secret Key will not authenticate and will receive an unauthorized exception as a response.   Integrations using the old API credentials will start failing unless they are updated with the new Secret Key.

On the API Credentials page, perform the following steps to generate new Secret Key:

  1.  Click more options More_Button.png button and select Generate New secret Key
  2. Click Generate to generate new Secret Key.
  3. Click Copy_Button.png icon to copy the auto-generated Client ID and Secret Key to the clipboard.

Rename existing credentials

 On the API Credentials page, perform the following steps to rename existing credentials: 

  1. Select the credential from the list which you intend to rename. 
  2. Click the Edit button to modify the name of the credential and click Submit

Delete existing credentials

Deleting the credential will result in immediate termination of all the active tokens made through that credential. All subsequent calls using this credential will receive an unauthorized exception as the response. 

On the API Credentials page, perform the following steps to delete credentials: 

  1. Select the credential from the list which you intend to delete. 
  2. Click more options More_Button.png button and select Delete Credential
  3. Click Delete to delete the credential. 
  • Was this article helpful?