Cloud Avenue Wiki
< All Topics

NSS Swagger APIs

Overview

The NSS Swagger is a service that allows you to prototype your API calls to the NSS portal. This service is only available in English.

Access

The Swagger is accessible from both sites:

Overview of the interface :

Interface API de NetBackup Self Service pour accéder aux différentes fonctionnalités et informations

Authentication

Click on Authorize.

Bouton pour autoriser l'accès à l'API NetBackup Self Service

Enter the provided login and password to connect to NSS.

Formulaire d'autorisation pour accéder à l'API NetBackup Self Service avec saisie du nom d'utilisateur et du mot de passe

Access has been granted.

Confirmation de l'autorisation d'accès à l'API NetBackup Self Service

Example: Backup Now

First, we will retrieve the VMID of the VM to be backed up.

Requête GET pour obtenir la liste des machines via l'API NetBackup Self Service

The VMID is listed in the response body, within the same block as the VMName.

{
  "data": [
    {
      "Id": <VmID>,
...
      "VMDisplayName": <VmName>,
...

You can then initiate a “Backup now” job.

Requête POST pour effectuer une sauvegarde d'une machine spécifique via l'API NetBackup Self Service

Using the configuration described below:

Name Description
Id <VmID>
backupData { 
 "ProtectionLevelId": 4,

 "RetentionLevel": 3,

 "StorageLifecyclePolicyName": "",

 "Paths": [ ]

}