Ransomware attackers specifically target and attempt to destroy backup systems to increase the probability of payment. Hardening your system is critical. Please ensure you have reviewed your platform security using the Security Hardening Checklist
Cohesity

COHESITY Documentation

Explore our documentation to get started, discover products & new features, access troubleshooting guides, register sources, platforms support.

Products
Data Security Alliance
Visit Cohesity.com
Demos
Support
Blogs
Developers
Partner Portals
Cohesity Community
© 2026 Cohesity, Inc. All Rights Reserved.
Terms of Use|
Privacy Policy|
Legal|
  1. Home
  2. NetBackup™ Security and Encryption Guide
  3. Section I. Identity and access management
  4. API keys
  5. Using an API key
NetBackup™ Security and Encryption Guide

Using an API key

Once an API key is created, you can use it while you access RESTful APIs or run commands:

See Creating API keys.

Using an API key while accessing NetBackup RESTful APIs

  • Pass the API key in the API request header to access other NetBackup APIs.

Using an API key while you run NetBackup commands

  1. Do one of the following:
    • Run the following command:

      bpnbat -Login -LoginType APIKEY

      You can run NetBackup commands that require authentication for the next 24 hours without requiring to run bpnbat -Login.

    • Set a new environment variable called NETBACKUP_APIKEY for the API key.

      See Setting an API key environment variable to run NetBackup commands.

      You can run NetBackup commands that require authentication until the API key is valid and the environment variable is set.

  2. Run a command such as nbcertcmd -createToken.

    For more details on NetBackup commands, refer to the NetBackup Commands Reference Guide.

Feedback

Was this page helpful?
Previous

Managing an API key

Next

Setting an API key environment variable to run NetBackup commands

Feedback

Was this page helpful?