PowerProtect Data Manager (v19.2) REST API
Introduction to PowerProtect Data Manager REST API
Dell EMC PowerProtect Data Manager provides software defined data protection, deduplication, operational agility, self-service and IT governance for physical, virtual and cloud environments.
In addition to the HTML-based UI, PowerProtect Data Manager provides a REST API to enable customers to support their own business cases based on the platform.
Basic Concepts
REST API Endpoint
The PowerProtect Data Manager REST API endpoint:
https://<PPDM-IP/FQDN>:8443/api/<API-VERSION>/<RESOURCE>
Current API version is “v2”.
The supported payload of request/response is JSON format unless otherwise specified.
Concepts
| Concept | Description |
|---|---|
| Inventory Source | Represents external servers that can act as either the source of protection or the target of protection. Contains necessary information about network and login credentials. Examples: vCenters, Data Domains. |
| Storage System | Storage representatives, linked to inventory source. Contains more information about the storage system. For example: storage type, capacity, usage. Can be set as the target storage for protection. |
| Asset | Objects to protect. Examples: Virtual Machines, File Systems, Databases. |
| Protection Policy | Defines everything that is required for the complete protection life cycle. Can define the protection stages (Backup, Replication, Cloud Tier, Cloud DR) and the assets that you want to protect. |
| Activity | Represents asynchronous work that PowerProtect Data Manager handles. Examples: Protection Jobs, Restore Jobs. |
| Alert | Named as is. Anything that needs your attention. |
| Audit Log | Records critical operations and changes being done to the system. |
| Compliance | Defines a Service Level Agreement (SLA) when creating a protection policy. PowerProtect Data Manager checks SLAs against the protection results and generates Compliance reports. |
Best Practices
Backward and forward compatibility
As additional features are added to the product, APIs may change. Observe these common practices when dealing with API changes:
- Deprecated APIs and fields: Do not use them. Deprecated APIs and fields are removed when the infrastructure no longer supports them.
- Handling requests and responses in JSON: Exercise flexibility and tolerance with unrecognized fields and enumerations. New fields and enumerations might be added in support of new features such as a new asset type or new protection type. If you do not use them, ignore these fields and enumerations when they are not recognized.