RESTful APIs included in NetBackup 10.3
NetBackup 10.3 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.3
Look under API Reference. 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.3 includes these new and enhanced APIs:
Licensing:
Add entitlements.
Get entitlements.
Delete entitlements.
Multi-person Authorization:
Update MPA tickets by ID.
Obtain list of MPA tickets.
Obtain MPA ticket by ID.
Obtain list of MPA configurations.
Update MPA configure by ID.
Pre-Check:
Perform pre-check on workload asset.
Rate Limiter:
Create rate-limit configuration.
Update rate-limit configuration.
Delete rate-limit configuration.
Obtain list of rate-limit configurations.
Obtain rate-limit configuration by ID.
OpenStack Workload:
Create instant access mount for OpenStack recovery point.
Obtain instant access mount by ID.
Obtain list of instant access mounts.
Delete instant access mount by ID.
NetBackup OpenStack VM Servers:
Register NetBackup OpenStack VM.
Delete NetBackup OpenStack VM.
Media Servers:
Remove media servers.
Obtain media server directory information.
Update media server state.
Update media service daemon state.
Restore Logs:
Obtain details of restore log by ID.
Download restore log file by ID.
Delete restore log file by ID.
Snapshot Managers:
Register Snapshot Manager with NetBackup.
Anomaly Extension:
Obtain list of anomalies for extension.
Obtain anomaly for extension by ID.
Delete anomaly record for extension by ID.
Update anomaly status by ID.
Obtain template configuration by ID.
Create configuration by ID.
Update configuration by ID.
Obtain configuration by ID.
These APIs that have been versioned in NetBackup 10.3 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 more details.
Post snapshot-mgmt-servers:
`POST /config/servers/snapshot-mgmt-servers` has the following attribute changes:
`username`, `password`, `fingerprint` and `securityToken` removed from the request body payload of the object `snapshotMgmtServer`.
These attributes are not supported as TLS certificate based authentication mechanism is used for Snapshot Manager communication.