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

How to add a PowerProtect DD

Trust the server certificate

  1. Get the certificates detail as shown in this example:
curl --request GET \
  --url 'https://<your-ppdm-server>:8443/api/v2/certificates?host=<host>&port=<port>&type=Host' \
  --header 'authorization: Bearer <access-token>'

The <host> is the PowerProtect DD FQDN or IP address. The <port> is the port number, usually 3009.

The response is similar to this example:

OK (200)

{
    "id": "MTAuMTEwLjQuMzk6MzAwOTpIT1NU",
    "host": "<host>",
    "port": "<port>",
    "notValidBefore": "Tue Apr 24 02:26:22 CST 2019",
    "notValidAfter": "Sat Apr 23 09:26:22 CST 2023",
    "fingerprint": "70832CF8AF7B957BE9EC25EB611804B0B80203E3",
    "subjectName": "CN=ddve, ...",
    "issuerName": "CN=ddve, ...",
    "state": "UNKNOWN",
    "type": "HOST"
}
  1. Trust the certificate
PUT /api/v2/certificates/{certId}

The {certId} is that you obtained from the previous get the certificates detail call. In the PUT body, update the "state": "UNKNOWN" to "state": "ACCEPTED".

The request as shown here:

curl --request PUT \
  --url https://<your-ppdm-server>:8443/api/v2/certificates/MTAuMTEwLjQuMzk6MzAwOTpIT1NU \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <access-token>' \
  --data '<the-json-response-from-previous-request-with-state-set-to-ACCEPTED>'

You receive a response similar to this example:

OK (200)

{
    "id": "MTAuMTEwLjQuMzk6MzAwOTpIT1NU",
    ...
    "state": "ACCEPTED",
    ...
}

Determine if PowerProtect DD system is supported

To determine if the PowerProtect DD system is supported, your request should be similar to this one:

curl --request POST \
  --url https://<your-ppdm-server>:8443/api/v2/datadomain-system-validation \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <access-token>' \
  --data '{ "hostname": "<host>", "port": "<port>", "username": "<usr>", "password": "<pwd>"}'

The response can appear like this example:

OK (200)

{
  "isSupported": true
}

This response indicates that the PowerProtect DD system is supported.

Create credentials for PowerProtect DD system

To create credentials for the PowerProtect DD system, your request should be similar to this example:

curl --request POST \
  --url https://<your-ppdm-server>:8443/api/v2/credentials \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <access-token>' \
  --data '{"type": "DATADOMAIN", "name": "<display-name>", "username": "<usr>", "password": "<pwd>" }'

The <display-name> is the display name in PowerProtect Data Manager. The <usr> and <pwd> are the username and password for the PowerProtect DD server.

The credentials ID appears in the response body:

Created (201)

{
  "id": "0c1d2b0e-b317-4ace-bbc1-ac1f46b7c51f",
  ...
}

Add PowerProtect DD server

To add the PowerProtect DD server, make a request that is similar to this example:

curl --request POST \
  --url https://<your-ppdm-server>:8443/api/v2/inventory-sources \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <access-token>' \
  --data '{
    "name": "<display-name>",
    "type": "EXTERNALDATADOMAIN",
    "address": "<FQDN-or-IP-Address>",
    "port": "<port>",
    "credentials": {
        "id": "<credentials-id-from-previous-call>"
    }
}'

The response looks like this:

Created (201)

{
  "id": "e0f4a598-2065-4f27-aaad-45a475af71e6",
  ...
}