Solved

Use API Key for REST API authentication?

  • 4 October 2022
  • 4 replies
  • 796 views

Userlevel 1
Badge +6

We have a custom application that was developed in-house for automation, and we are trying to integrate Commvault into it, as we have for other backup applications used here.

We wanted to know if it was possible for Commvault to use an “API Key” (which Veritas NetBackup has) in order to authenticate, rather than having to use the normal authentication token which expires after 30 minutes of inactivity?

For more info on the API Key in Netbackup, see: getting-started (veritas.com)

A NetBackup API key is a pre-authenticated token that lets a NetBackup user run NetBackup commands
(such as nbcertcmd -createToken or nbcertcmd -revokeCertificate) or access NetBackup RESTful APIs.
Unlike a password, an API key can exist for a long time and you can configure its expiration.
Therefore, once an API key is configured, operations like automation can run for a long time using the API key.

icon

Best answer by MaheshPrakash 4 October 2022, 21:48

View original

4 replies

Badge +2

Hi Rob, we are working on a similar functionality where we would be providing ability to create an access token with an option to set TTL from the Command center and have an option to have never expiring token too.

 

For now, we already have a timeout field in the current login API where you can send a really large number as inactivity timeout (in minutes) so that you wouldnt hit it and the automation doesnt run into expiry due to inactivity. Sample below

/Login

{

    "username": "abc",

    "password": "base64pass",

    "timeout": 2323123123

}

 

 

Userlevel 1
Badge +6

Excellent!  Thank you for the quick reply.  We will keep an eye out for when the new features you mentioned are released and will try with the suggested long timeout for now.

Badge +2

Hi Rob, we are working on a similar functionality where we would be providing ability to create an access token with an option to set TTL from the Command center and have an option to have never expiring token too.

 

For now, we already have a timeout field in the current login API where you can send a really large number as inactivity timeout (in minutes) so that you wouldnt hit it and the automation doesnt run into expiry due to inactivity. Sample below

/Login

{

    "username": "abc",

    "password": "base64pass",

    "timeout": 2323123123

}

 

 

 @MaheshPrakash has this feature been released?

Badge +2

Yes, please find the documentation here. https://documentation.commvault.com/2023/essential/153488_access_tokens_for_rest_apis.html

Reply