Manage API keys
NetBackup security administrators or NetBackup users with permissions to manage API keys can use the NetBackup web UI to add, edit, delete, or view the keys that are associated with all NetBackup users. A NetBackup-authenticated user can view and manage their own API key using the NetBackup APIs, if that user does not have RBAC permissions.
See Add access for a user through access rules.
You can create API keys for authenticated NetBackup users (groups are not supported). A specific API key is only created one time and cannot be recreated. Each API key has a unique key value and API key tag.
Only one API key can be associated with a specific user at a time. If a user requires a new API key, you must delete any active or any expired key for that user.
To add an API key
- On the left, select Security > API keys.
- In the upper-right corner, click Add.
- Enter a User name for which you want to create the API key.
- Indicate how long you want the API key to be valid, from today's date.
NetBackup calculates the expiration date and displays it below.
- Click Add.
- To copy the API key, click Copy to clipboard.
Store this key in a safe place until you can deliver the key to the user. After you click Close, the key cannot be retrieved again. If this API key replaces a previous key for the user, the user must update any scripts, etc. to reflect the new API key.
- Click Close.
You can change the expiration date for an active API key. After an API key expires, a user's old key must be deleted and a new key created.
To edit an API key
- On the left, select Security > API keys.
- Select the API key and click Edit.
- Note the current expiration date for the key and extend the date as wanted.
- Click Save.
You can delete an API key if you do not want a user to have access to the key or when it is no longer used. When you delete an API key, that key is permanently deleted. The associated user can no longer use that key for authentication or with the NetBackup APIs.
To delete an API key
- On the left, select Security > API keys.
- Select the API key and click Delete > Delete.