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.4

  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.html

  The 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.4 includes these new and enhanced APIs:

• Robots:

  • Delete robots.

  • Update a robot.

  • Get robot details by robot name.

  • Retrieve list of unique device hosts for configured robots.

• Robot Inventory:

  • Get robot contents.

  • Fetch the list of bar code rules.

  • Create a new bar code rule on the media manager server.

  • Update the specified bar code rule.

  • Delete the specified bar code rule.

  • Fetch the list of media server's media ID generation rules.

  • Set the list of media server's media ID generation rules.

  • Fetch the list of media server's media ID prefixes.

  • Set the list of the media server's media ID prefixes.

  • Manage robot volume configuration.

  • Get media type mappings for a specified robot type.

• Tape media volumes:

  • Retrieve list of tape media volumes.

  • Create tape media volumes.

  • Retrieve details for a tape media volume.

  • Perform quick erase or long erase on a volume.

  • Perform label operation on a volume.

  • Retrieve list of external media types.

  • Rescan and update bar codes for one or more tape volumes.

  • Move volumes between robots.

  • Update one or more tape volumes.

  • Delete one or more tape volumes.

  • Eject one or more tape media volumes from a robot.

• Tape media volume groups:

  • Retrieve list of tape volume groups.

  • Retrieve details of a tape volume group.

  • Update a tape volume group.

  • Delete a tape volume group.

• Volume pools:

  • Create a new tape volume pool.

  • Retrieve details of a volume pool by ID.

  • Update a volume pool.

  • Delete one or more volume pools.

• Tape Media Owners:

  • Retrieve a list of media owner names.

• Media Settings:

  • Retrieve associated EMM server settings.

  • Update associated EMM server setting.

• Storage devices:

  • Retrieve tape robots and standalone drives used for storage unit configuration.

• Malware:

  • Delete failed/canceled scan result with specified ID.

  • Validate configuration for malware scan.

• Anomaly:

  • Update the feedback parameters of a policy and client.

• File Hash Search:

  • Search files by file hash.

• Multifactor Authentication:

  • The existing multifactor authentication infrastructure is enhanced to be adaptive.

• Get tape-volume-pools API:

  GET /storage/tape-volume-pools` no longer supports filtering on `policyType`.

• Establish trust with a primary server API:

  `POST /config/servers/trusted-master-servers`

  Request Payload for credential based trust will require one additional 'remotePrimaryAuthMode' field from version 11.0 onwards.

  API v10.0 example:

  "trustedMasterServerName": "String",
  "authenticationType": "CREDENTIAL",
  "userName": "String",
  "password": "String",
  "fingerprint": "String"

  API v11.0 example:

  "trustedMasterServerName": "String",
  "authenticationType": "CREDENTIAL",
  "userName": "String",
  "password": "String",
  "fingerprint": "String",
  "remotePrimaryAuthMode":"String"

• Add scan host API:

  `POST /malware/scan-hosts` new mandatory parameter. `mediaServerName` has been added to the payload, which is used for validating the scan host before adding it.

  API v10.0 example:

  {
    "data": {
      "type": "createScanHost",
      "attributes": {
        "hostName": "scanhost.example.com",
        "maxNoOfParallelScans": 0,
        "state": "ACTIVE",
        "scanHostCredentialName": "sample_creds"
      },
      "relationships": {
        "malwareTool": {
          "data": {
            "type": "malwareTool",
            "id": "1"
          }
        },
        "scanHostPool": {
          "data": {
            "type": "scanHostPool",
            "id": "2"
          }
        }
      }
    }
  }

  API v11.0 example:

  {
    "data": {
      "type": "createScanHost",
      "attributes": {
        "hostName": "scanhost.example.com",
        "maxNoOfParallelScans": 0,
        "state": "ACTIVE",
        "scanHostCredentialName": "sample_creds",
        "mediaServerName": "mediaserver.example.com"
      },
      "relationships": {
        "malwareTool": {
          "data": {
            "type": "malwareTool",
            "id": "1"
          }
        },
        "scanHostPool": {
          "data": {
            "type": "scanHostPool",
            "id": "2"
          }
        }
      }
    }
  }