Forum Discussion

JonHunt's avatar
JonHunt
Level 5
6 years ago

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.

 

  • JonHunt's avatar
    JonHunt
    Level 5
    6 years ago

    The best source of information on API is our Swagger test harness.  An API developer should be able to use this in conjunction with our example scripts to code some custom API scripts.

     

    The example scripts are in:

    …\Biomni\NetBackup Self Service Adapter x.x\SDK\v6

     

    And the Swagger test harness can be accessed by using the API URL shown in ‘About NetBackup Self Service’ dialog (accessed via the user icon in top right):

     

     

     

    Enter this URL in a browser and add ‘help/index’ to reach Swagger e.g:

    https://yoursever/NetBackupSelfServiceNetBackupPanels/Api/help/index

     

    Note how, in the example screenshot, the Panels application has a non-standard name (NSS82NetBackupPanels) as it is possible to define this in IIS.  Always use the URL from the About page to ensure you have the correct application name.

     

    In order to use Swagger, the panels must be set to use SSL (HTTPS).

     

    • MonMaala16's avatar
      MonMaala16
      Level 2
      6 years ago

      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.

      • MonMaala16's avatar
        MonMaala16
        Level 2
        6 years ago

        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.