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

Change DD Boost password

This tutorial describes how to change the DD Boost password on both PowerProtect Data Manager and PowerProtect DD for a given protection policy stage. The following APIs are used:

REST API Description
POST /api/v2/login Log in to the system
GET /api/v2/protection-policies?filter=name eq {protection-policy-name} Get a protection policy by name
GET /api/v2/datadomain-mtrees/{id} Get a DD Boost storage unit by ID
PUT /api/v2/credentials/{id} Update password for a credential by ID

When a protection policy stage is created in PowerProtect Data Manager, a corresponding DD Boost storage unit is also created in PowerProtect DD. The user name and password for the storage unit is generated automatically and stored in both PowerProtect Data Manager and PowerProtect DD. Here is an example to update the DD Boost password for a given protection policy stage on both sides.

Login

Use the login API to retrieve the access token. See the tutorial for authentication and authorization.

Get the ID of a protection policy stage

Given a protection policy name, retrieve the dataTargetId for a specific protection policy stage.

GET /api/v2/protection-policies?filter=name eq {protection-policy-name}

Sample response:

OK (200)

{
    ...
    "stages": [
        {
            "target": {
                "storageSystemId": "eac0f7d0-3099-456e-a46e-e69f1c754d0c",
                "dataTargetId": "da6087e1-2036-4996-94d0-b8ac138e0fe0",
                "preferredInterface": "10.98.148.195"
            }
        }
    ]
    ...
}
  • The dataTargetId identifies a specific protection policy stage.

Get the credential ID for a specific protection stage

Each protection policy stage corresponds to a DD Boost storage unit in PowerProtect DD. A credential is generated for each stage.

GET /api/v2/datadomain-mtrees/{id}
  • The id is the dataTargetId that is retrieved from the last step.

Sample response:

OK (200)

{
    ...
    "credential": {
        "id": "268c8c2c-5936-4b6b-b895-2437787cced5"
    },
    ...
}

Change DD Boost password for a specific credential

Change the DD Boost password for the given credential ID.

PUT /api/v2/credentials/{id}
  • The id is the credential ID that is retrieved from the last step.

Sample request body:

{
    "id": "268c8c2c-5936-4b6b-b895-2437787cced5",
    "name": "PLC1-dhvm-vmqa-166-d65f1",
    "username": "PLC1-dhvm-vmqa-166-d65f1",
    "password": "Changeme@1",
    "type": "DATADOMAIN",
    "method": null,
    "secretId": "6a367bb2-9079-4302-87b9-0b904b205aa7",
    "internal": true
}
  • The password is the new password to be updated to PowerProtect Data Manager and PowerProtect DD. Sample response:
OK (200)

{
    "id": "268c8c2c-5936-4b6b-b895-2437787cced5",
    "name": "PLC1-dhvm-vmqa-166-d65f1",
    "username": "PLC1-dhvm-vmqa-166-d65f1",
    "password": null,
    "type": "DATADOMAIN",
    "method": null,
    "secretId": "6a367bb2-9079-4302-87b9-0b904b205aa7",
    "internal": true
}