API Explorer
API Explorer
Introduction
What's New
Appliance Management
Application Data Management
Asset Management
Asset Metadata
Authentication and Authorization
Cloud Disaster Recovery
Compliance
Copy Management
Credentials Management
Discovery
File Level Restore
Installation
Inventory Source Management
Kubernetes Data Management
Licenses Management
Location Management
Log Management
Monitoring
Protection Policies
Recovery and Reuse Management
Remote Service
Search Clusters
Secrets Manager
Server Disaster Recovery
Storage Management
Telemetry Setting
Upgrade
User Security Management
Virtual Machine Data Management
Whitelist Management

PowerProtect Data Manager (v19.8) REST API changes

Introduction

This section contains information about differences between version 19.7 and 19.8 of the REST API in PowerProtect Data Manager. The changes include:

  • Several new APIs
  • New API specifications (including new property values, new models, and name changes to some models)

These changes are described below.

Summary of API changes

  • The following API is added for deleting multiple assets in batch.
POST /api/v2/assets-deletion-batch
  • The following API is added for retrieving the consumer count value to determine how many consumers are using the specified credential.
GET /api/v2/credentials/{id}/usage
  • The following API is added for deleting multiple credentials in batch.
POST /api/v2/credentials-deletion-batch
  • The following API is added for retrieving the protection storage metrics.
GET /api/v2/protection-storage-metrics
  • The following API is added for submitting multiple file level restore requests in a single batch API call.
POST /api/v2/flr-sessions-batch
  • The following API is added for resetting the OS user password.
POST /api/v2/os-user-password-reset

Summary of API specification changes

  • You can get a summary for each SLA by using the new parameter includingSummary and setting it to “true”. The default value is “false”. It is used in following API calls:
GET /api/v2/service-level-agreements
GET /api/v2/service-level-agreements/{id}
  • To support the forced deletion of copies, a new parameter forceDelete is added. When you want to force delete copies, set it to “true”. It is used in following API call:
POST /api/v2/copies-deletion-batch
  • To support AIX Oracle assets, a new object operatingSystem is added. The object looks like this:
operatingSystem: {
  "name": String
  "version": String
}

It is used in following API calls:

GET /api/v2/assets
GET /api/v2/assets/{id}
  • To support NAS share, enhancements are added for model Inventory sources and Assets:

    • A new option GENERICNASMANAGEMENTSERVER is added for “Type” in REST model “inventory-sources”
    • A new property nas is added in REST model “InventorySourceDetails”
    • The model is exposed for inventory-sources REST model
    • The vendor and subtype are exposed for assets REST model

    They are used in following API calls.

GET /api/v2/inventory-sources
GET /api/v2/inventory-sources/{id}
POST /api/v2/inventory-sources
PUT /api/v2/inventory-sources/{id}
GET /api/v2/assets
GET /api/v2/assets/<id>
  • A new option noMount is added to allow batch FLR callers to browse the target filesystem without mounting a copy. It is used in following API call.
POST /api/v2/flr-sessions
  • Updated the response code of API call DELETE /api/v2/exported-copies/{id} from 204 (No Content) to 202 (Accepted). Also, the taskId is added in the response body. The new response looks like this:
Status: 202
{
  "taskId": "d1a022b8-5516-4d8b-84a6-241d4050b854"
}
  • A new field consumersCount is added to list how many consumers are using a given credential. When you get the consumer count, use it to determine if you can delete the credential. Only unused credentials can be deleted. This field is used in following API calls:
GET /api/v2/credentials
GET /api/v2/credentials/{id} 
  • Two new fields datacenterName and supportedAssetType are added to enable “StorageSystemRestModel” to display the name of the system pool datacenter and the asset type. They are used in following API calls:
GET /api/v2/storage-systems
GET /api/v2/storage-systems/{id}
  • The data structure of index_asset_rule is updated to support compound expression and multiple AND/OR operations in a single protection rule. Now the protection rule can be divided into two categories:

    • Primitive Protection Rule: The protection rule contains several conditions.
    • Compound Protection Rule: The protection rule contains several sub-protection rules.

    New attributes are added to support these new categories.

Name Type Description
category Integer Category of the protection rule. Enum: PRIMITIVE/COMPOUND.
rules Object/Array List of all the sub-protection rules.
conditions Object/Array List of the values
logicalOperator String Enum: AND/OR

New condition operators are added.

Condition Operator Asset Attribute Name
IN userTags
NOT_IN userTags
MATCH_REGEX asset attributes which support CONTAINS and DOES_NOT_CONTAIN operators
DOES_NOT_MATCH_REGEX asset attributes which support CONTAINS and DOES_NOT_CONTAIN operators

They are used in following API calls.

GET /api/v2/protection-rules
GET /api/v2/protection-rules/<id>
PUT /api/v2/protection-rules/<id>
POST /api/v2/protection-rules
  • New fields are added for SdrConfiguration to set the BoostFS lockbox and mount a DD Boost storage unit.
Property Type Required Description
repositoryFilesystem String No PowerProtect DD filesystem: NETWORK_FILE_SYSTEM or BOOST_FILE_SYSTEM.
credentialId String No DD Boost credential ID (only for saving DR backups using BoostFS)
credentialUsername String No DD Boost credential username (only for DR restore using BoostFS)
credentialPassword String No DD Boost credential password (only for DR restore using BoostFS)
  • A new field Certificate is added in the Status structure of Proxy sessions to display the PEM encoded public certificate of the external vProxy. It is used in following API call.
GET /api/v2/protection-engines/{id}/proxies/{proxyId}
  • A new model ActivityStep is added to provide information about the steps that are performed in an activity. It includes following attributes:
Attribute Type Description
name String Name of the step
description String Additional description
startTime date Start time of the step
endTime date End time of the step
durationInMillis long Time taken to complete the step.
status String Status of the step. Enum values: Queued, Running, Success, Failed, Canceled.

It is used in following API calls.

GET /api/v2/activities/{activityId}
GET /api/v2/activities