Getting Started
Vdisk Devices
Auth
Alerts Notifylists
Cloud Profiles
Cloud Unit
Data Movement Policy
Data Movement
Data Movement Stats Files
Data Movement Stats Mtrees
Data Movement Stats Recall
Managed Files
Licenses
Mdtags
Mtrees
Mtrees Id Rlfiles
Mtrees Id Stats
Mtrees Id Stats Capacity
Mtree Id Stats Compressions
Networks
Network
Network Nic
Cifs Shares
Ddboost
Ddboost Clients
Ddboost Storage Units
Ddboost Users
Nfs Exports
Nfs Exports Id Clients
Nfs Exports Id Referrals
Vdisk Devgrps
Alerts
Vdisk Pools
Vdisk Stimgs
Services
Services Asup
Services Asup Reset
Services License Server
Services Log
Mdtags Services
Services Ntp
Snmp
Settings
Tenant Units
Tenants
Stats
Stats Capacity
Comp Measurements Support Check
Comp Measurements
Stats File Replications
Filesys Stats
Stats Performances Mtrees
Stats Systems File Replications
Support Bundles
System
System Repl
System Space
Users
Users Id Pre Check
Sso Registration
Trust

Make your first call

In this tutorial, you will learn how to do authentication by using the PowerProtect DD system username and password. Then you will use the authenticated token to make your first call to retrieve basic information from the PowerProtect DD system.

Log in to PowerProtect DD system

With the UI username and password, you can use the Auth API to get the authentication token.

curl --request POST \
     --header 'content-type: application/json' \
     --url https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/auth \
     --data '{"username":"<your-user-name>","password":"<your-password>"}'

Sample response:

Response code: Created(201)
X-DD-AUTH-TOKEN: f3b68e6f2fd35870f3fd188b737028a78

{
    "service_status": {
        "details": "success",
        "code": 0,
        "link": [
            {
                "rel": "related",
                "href": "/rest/v1.0/system"
            }
        ]
    }
}

The authentication token is used in subsequent calls.

Get basic system information

Now that you have the authentication token, you can access all APIs that the authenticated user has the privilege to use. The following example uses the system API to fetch basic information about the PowerProtect DD system. Set the authentication token in the header:

curl --request GET \
     --header 'Accept: application/json' \
     --header 'X-DD-AUTH-TOKEN:<your-auth-token>
     --url https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/system

Sample response:

Response status code: OK(200) 

{
    "uptime": "10:56:16 up 2 days, 23:17",
    "name": "ddve-213216205.brs.lab.emc.com",
    "license": [
        {
            "feature": "REPLICATION"
        },
        {
            "feature": "DDBOOST"
        },
        {
            "feature": "RETENTION-LOCK-GOVERNANCE"
        },
        {
            "feature": "ENCRYPTION"
        },
        {
            "feature": "CAPACITY"
        },
        {
            "feature": "CLOUDTIER-CAPACITY"
        }
    ],
    "logical_capacity": {
        "available": 130530410496,
        "total": 130530410496,
        "used": 0
    },
    "serialno": "AUDV3ZU7Z6SB7R",
    "physical_capacity": {
        "available": 130398289920,
        "total": 130530410496,
        "used": 132120576
    },
    "time_zone": "US/Pacific",
    "uptime_secs": 256674,
    "compression_factor": 0,
    "version": "Data Domain OS 7.2.0.5-652788",
    "capacity_usage_details": [
        {
            "tier": "active",
            "logical_capacity": {
                "available": 130530410496,
                "total": 130530410496,
                "used": 0
            },
            "compression_factor": 0,
            "physical_capacity": {
                "available": 130398289920,
                "total": 130530410496,
                "used": 132120576
            }
        }
    ],
    "mem_size": 8375345152,
    "uuid": "2887d777b0a7d485:877c8a7e95a67d4d",
    "model": "DD VE Version 5.0",
    "type": "standalone",
		"link": [
        {
            "href": "/rest/v1.0/system",
            "rel": "self"
        },
        {
            "href": "/rest/v1.0",
            "rel": "parent"
        }
    ]
}

The response returns the detailed information of the PowerProtect DD system.

Log out

To log out of the current session, call the Auth API with the DELETE operation:

curl --request DELETE \
     --header 'X-DD-AUTH-TOKEN:<your-auth-token>' \
     --url 'https://<DD-SYSTEM-IP/FQDN>:3009/rest/v1.0/auth'