RESTful APIs included in NetBackup 10.1.1
NetBackup 10.1.1 includes both updated and new RESTful application programming interfaces (APIs). These APIs are built on the Representational State Transfer (REST) architecture. They provide a web-service-based interface that lets you configure and administer NetBackup in your environments.
You can find documentation for the NetBackup APIs in on SORT and on your primary server. Make sure to review the Versioning topic and the What's New topic in the Getting Started section.
On SORT:
NetBackup API documentation is available on SORT:
HOME > KNOWLEDGE BASE > Documents > Product Version > 10.1.1
Look under . A Getting Started document provides background information about using NetBackup APIs. The API YAML files are also available for reference, however, they are not functional. You cannot test the APIs from the documents on SORT.
On your primary server:
APIs are stored in YAML files on the primary server:
https://<primary_server>/api-docs/index.htmlThe APIs are documented in Swagger format. This format lets you review the code and test the functionality by making actual calls with the APIs. You must have the appropriate security permissions to access the primary server and APIs to use the Swagger APIs.
Caution:
Veritas recommends that you test APIs only in a development environment. Because you can make actual API calls from the Swagger files, you should not test the APIs in a production environment.
NetBackup 10.1.1 includes these new and enhanced APIs:
Server Groups:
Asynchronously delete bulk server groups.
Bare Metal Restore:
Retrieve list of thin pools from BMR configuration.
Log Records:
Retrieve in-progress record count.
Create new log record.
Upload logs for a record ID.
Gather logs for a record ID.
Retrieve details of a record ID.
Delete collected logs for a record ID.
These APIs that have been versioned in NetBackup 10.1.1 due to breaking changes. The previous version of these APIs is still supported by specifying the correct version. See the Versioning section in the on SORT for examples and more details.
Get Jobs:
GET /admin/jobs has changed the properties of the object getJobsResponse to return the activeElapsedTime and elapsedTime attributes in ISO 8601 duration format.
Get Root Hierarchy Jobs:
GET /admin/root-hierarchy-jobs has changed the properties of the object getJobsResponse to return the activeElapsedTime and elapsedTime attributes in ISO 8601 duration format.
Get Job:
GET /admin/jobs/{jobId} has changed the properties of the object getJobByIdResponse to return the activeElapsedTime and elapsedTime attributes in ISO 8601 duration format.
Examples:
API v1.0-9.0
API v9.0
"activeElapsedTime": "01:02:03"
"activeElapsedTime": "PT1H2M3S"
"elapsedTime": "01:02:03"
"elapsedTime": "PT1H2M3S"