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 the Client ID and Secret Key and is equivalent to that of a username 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, and scripts with Druva products.
This article provides instructions to create and manage API credentials.
❗ Important
Only Druva Cloud Administrators can create and manage API credentials.
Manage API Credentials
Go to Druva Cloud Platform Console Global Navigation > Druva Cloud Settings > API Credentials
You can perform the following actions over the API Credentials page :
Create new credentials
❗ Important
If you want to integrate with inSync APIs, you must be a Druva Cloud Administrator.
If you want to integrate with inSync or Realize APIs, both, the Druva Cloud Administrator and Product Administrator can perform the integration.
On the API Credentials page, perform the following steps to create new credentials:
Click New Credentials. The New Credentials window appears.
Provide a name for the credential.
💡 Tip
For ease of recognizing the credential name, it is recommended to name the credential so that it matches the name of the application or tool that you intend to integrate with Druva products.
To apply network restrictions, perform the steps provided in Apply network restrictions.
To apply authorization restrictions, perform the steps provided in Apply authorization restrictions.
Click Save. The Credential Details window appears.
Click the Newcopy icon to copy the auto-generated Client ID and Secret Key to the clipboard.
💡 Tip
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.
❗ Important
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.
Refer API integration workflow, to learn more about the workflow.
Apply network restrictions
With the Network Restriction feature, you have an option to secure the usage of API credentials and access to your data via APIs. The Network Restriction feature restricts the API usage from a particular IP address or a range of IP addresses.
On the API Credentials page, perform the following steps to apply network restrictions:
Click on the credential name for which you intend to apply network restrictions.
Click Edit. The Edit Credentials window appears.
Select the Enable Restrictions checkbox.
In the IPs box, type the public IPs of your corporate network.
You can specify the IP addresses in the following formats.
IP Address | Example |
Single IP address |
|
Range of IP address, separated by a hyphen (-). |
|
Multiple ranges of IP address, separated by comma (,). |
|
Apply authorization restrictions
With the Authorization Restriction feature, you have an option to apply role-based restrictions to API credential authorization.
As a result, administrators configuring applications with these API Credentials can only view the information based on the role assigned to these API Credentials.
On the API Credentials page, perform the following steps to apply the restriction to API credential authorization across inSync and Phoenix.
Click on the credential name for which you intend to apply network restrictions.
Click Edit. The Edit Credentials window appears.
Select Druva Cloud Administrator, if you want only Druva Cloud Administrators to authorize the API credentials.
Select Product Administrator to choose the applicable product administrator from inSync and Phoenix.
Click Save.
Generate a new secret key
In case the Secret Key is lost, or stolen, or you failed to copy at the time of generating a New Credential, you must generate a new Secret Key.
❗ Important
If you generate a new Secret Key for the API credential that 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 a new Secret Key
Click on the credential name for which you intend to generate a new secret key.
Click the More options button and select Generate New Secret Key.
On the confirmation window, click Continue to generate a new Secret Key.
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:
Click on the credential name that you intend to rename.
Click the Edit button. The Edit Credentials window appears.
Type a new name for the selected credential.
Click Save.
Delete existing credentials
❗ Important
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:
Click on the credential name that you intend to delete.
Click the More options button and click Delete Credential.
On the confirmation window, click Delete to delete the credential.
Filters for API credentials list
API credentials filters help you to monitor role-specific API credentials and audit the Last access using the API credentials for the Role to uncover any security risks.
Considerations for Filters
API credentials accessed before December 29, 2022, will be shown as Not available. Consider the following when you use the filters for the first time.
Date | Result |
December 29th, 2022 | Not available for all. |
January 4th, 2023 | API credentials accessed 7 days ago are displayed. |
February 3rd, 2023 | API credentials accessed 30 days ago are displayed. |
March 6th , 2023 | API credentials accessed 60 days ago are displayed. |
Created new credentials after December 29, 2022 | The new API credentials are listed as Never Accessed. |
Applying Filters
Filters | Description |
Role | Select the Role to filter the associated API credentials. For example, if you select Druva Cloud Administrator, all the API credentials associated with Druva Cloud Role are listed. |
Modified By | The administrator who last modified the API credentials.
For example, if you select administrator A, all the API credentials modified by administrator A are listed. |
Last Accessed Before | All the API credentials that were not accessed from the last specified days are listed.
For example, if you select 7 days, all the API credentials logins for the role that didn’t access in the last 7 days are listed.
You can select the duration:
Note: API credentials accessed before December 29, 2022, will be shown as Not available |