Important Update: Cohesity Products Knowledge Base Articles
All Cohesity Knowledge Base Articles are now managed via the Cohesity Support Portal: https://support.cohesity.com/. The Knowledge Base articles available here will not reflect the latest information or may no longer be accessible.
Description
The NetBackup API provides a web-service based interface to configure and administer NetBackup, the industry leader in data protection for enterprise environments.
NetBackup API is RESTful
The NetBackup API is built on the Representational State Transfer (REST) architecture, which is the most widely used style for building APIs. The NetBackup API uses the HTTP protocol to communicate with NetBackup. The NetBackup API is therefore easy to use in cloud-based applications, as well as across multiple platforms and programming languages.
JSON message format
The NetBackup API uses JavaScript Object Notation (JSON) as the message format for request and response messages.
The client-server relationship
The NetBackup API employs client-server communication in the form of HTTP requests and responses.
- The API client (your program) uses the HTTP protocol to make an API request to the NetBackup server.
- The NetBackup server processes the request. The server responds to the client with an appropriate HTTP status code indicating either success or failure. The client then extracts the required information from the server's response.
NBU APIs offered with NetBackup 8.1.1
Name of API |
API functionality |
Image API |
|
Jobs API |
|
Recovery API (VMware) |
|
Policy API |
|
Security API |
|
Notification API |
|
Support Fundamentals:
Documentation:
- https://sort.veritas.com/public/documents/nbu/8.1.1/windowsandunix/productguides/html/index/
- https://www.veritas.com/content/support/en_US/doc/NBU_811_API_REF
API Code Samples
To hit the ground running with the NetBackup API, you can refer to the API code samples in different programming languages. The API code samples are located on github: https://github.com/VeritasOS/netbackup-api-code-samples. This is a community-supported, open source project available under the MIT license.
Disclaimer
- The API code samples are not officially supported by Veritas and should not be used in a production environment.
- The purpose of these code samples is only to serve as a reference, to help you write your own applications using the NetBackup API.
What is supported (In-scope):
The following examples reflect what Veritas Support Services supports:
- Issues with the provided VERITAS web interface.
- Assistance providing VERITAS documentation, to include technical articles, white papers, and guides.
What isn't supported (Out of Scope):
While not every situation may be covered, the following examples provide insight into what Veritas Support Services does not support:
- Troubleshooting customer / third party applications, including syntax errors.
- Explaining coding and design methodologies outside VERITAS API set.
- The implementation of VERITAS API set outside VERITAS provided web interface.
- Customization made by a customer / third party to the provided VERITAS API set.
- Answer software development questions outside of the VERITAS API set.
The APIs that come with NetBackup can be adapted to provide an added service to the NetBackup program, however, these modifications will not be supported. Veritas does not support any APIs implemented outside the NetBackup web interface. For assistance with custom implementations with the NetBackup API set, please contact Veritas consulting or a third-party vendor.