Can't find NSS Documentation for the API

We have had a few queries for the following scenario when people are trying to find API documentation for NSS.............

The appendix F of Veritas NetBackup Self Service Configuration Guide says "Documentation for the API is found in the SDK folder in the installation directory.
The documentation for the API is also available online. The URL is included in the ReadMe.txt file in the SDK directory."

But Readme.txt in SDK folder says "Documentation
=============
Netbackup Self Service (NSS) exposes a REST Api to programmatically manipulate the system.

Full documentation of the REST Api is available at this link:
[SwaggerWebsite]

Machine readable Swagger json definition of the Api is available at:
[SwaggerJson]

This folder also contains some sample PowerShell scripts, which illustrate using various aspects of the Api."

Is there a specific set of  URLs that I should have them point to for  SwaggerWebsite and SwaggerJson.

 

6 Replies

Re: Can't find NSS Documentation for the API

The error is due to looking at the documents in their raw format. When NSS is installed, the readme.txt file is updated with the relevant URLs like the one below:

Documentation

=============

Netbackup Self Service (NSS) exposes a REST Api to programmatically manipulate the system.

Machine readable Swagger json definition of the Api is available at:

https://frontoffice.biomni.com/netbackupselfservicenetbackuppanels/api/help/index#/

Additionaly there is a VOX article on the NSS API - NSS-API-support-collateral

https://vox.veritas.com/t5/NetBackup-Self-Service/NSS-API-support-collateral/m-p/840282#M149

 

Highlighted

Re: Can't find NSS Documentation for the API

Hello,

It is our first time to configure a NSS and we are having a hard time on why we cannot access the NetBackupPanels/api. Team is encountering a error of http 404 as the resource you are looking for could have been removed, had its name changed, or is temporarliy unavailable.

Could it be that this error message is somehow related on the IIS configuration? Hope you can help us as this is our first time doing it and I tried checking for any documentation or KB article that could help us.

 

Thank you.

Re: Can't find NSS Documentation for the API

Hello,

It is our first time to configure a NSS and we are having a hard time on why we cannot access the NetBackupPanels/api. Team is encountering a error of http 404 as the resource you are looking for could have been removed, had its name changed, or is temporarliy unavailable.

Could it be that this error message is somehow related on the IIS configuration? Hope you can help us as this is our first time doing it and I tried checking for any documentation or KB article that could help us.

Just to add this also on trying to access NetBackupPanels/api/v6 same error which is server 404 - file or directory not found.

Re: Can't find NSS Documentation for the API

A 404 means the URL cannot reach the specified endpoint.

Depending on how IIS is configured, you may find that the URL is not accessible over the port you are attempting (relevant ports are specified in IIS bindings).  The default port for HTTP is 80, and for HTTPS it's 443.  However, any port can be specified in the IIS bindings.  Right click the 'website' node in IIS and select 'Edit bindings' to see what ports are being used.  The bindings are set up at website level, not application level.

If you would like assistance, please feel free to raise a support call with Veritas where we may be able to examine your actual configuration and advise on way forward.

 

Ben

 

Re: Can't find NSS Documentation for the API

Dear Ben,

Thank you for that information. Team already raised a case with Veritas team about the configuration and we asked them if there is  document that could guide us regarding the configuration of NSS and IIS? 

On our bindings, https and its port 443 is configured there and yes team would really appreciate if you guys can check our configuration.

Thanks.

Re: Can't find NSS Documentation for the API

We will be in touch