RESTful APIs included in NetBackup 9.0
NetBackup 9.0 includes both updated and new RESTful application programming interfaces (APIs). These APIs 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 these locations:
On your master server
APIs are stored in YAML files on the master server:
https://<master_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 master 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.
On SORT
NetBackup API documentation is also available on SORT:
HOME > KNOWLEDGE BASE > Documents > Product Version > 9.0
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.
NetBackup 9.0 includes these new and enhanced APIs:
Access Control: Lists roles for a principal, list effect ACLs for a managed object.
Diagnostics: Provides diagnostic information about the NetBackup Web Management Console.
External CA Certificates: Manage external CA certificates for smart card authentication.
Passphrase Constraints: Provides ability to configure passphrase constraints per workflow.
Recovery: Pre-recovery check for full VM restores with VMware.
See the New APIs topic in the What's New in NetBackup 9.0 section of the NetBackup 9.0 API Reference on SORT for more information.
The following APIs have been versioned in NetBackup 9.0. The previous version of these APIs is still supported if you specify the correct version.
Images:
GET Images /catalog/images and GET Image By Backup ID /catalog/images/{backupId} have renamed and changed data types for several fields.
RecoveryPoints:
GET RecoveryPoints /recovery-point-service/workloads/{workload}/recovery-points and GET RecoveryPoint By RecoveryPoint ID /recovery-point-service/workloads/{workload}/recovery-points/{recoveryPointId} have renamed and changed data types for several fields.
Configuration:
GET Configuration /security/properties is modified. The existing response fields in version 4.0 do not change, but the values may differ depending on whether authentication token is passed with the request or not.
See the Versioned APIs topic in the What's New in NetBackup 9.0 section of the NetBackup 9.0 API Reference on SORT for more information.
Note:
See the NetBackup 9.0 API Reference on SORT for more information. Make sure to review the Versioning topic and the What's New topic in the Getting Started section.