PowerProtect Data Manager Appliance 5.15.0.0 Security Configuration Guide for DM5500

Import security certificates for external components through the REST API

Where communication with an external component requires a security certificate, you can use the REST API to import that security certificate to PowerProtect Data Manager Appliance. You must have the public certificate chain for the external component in either PEM or Base64 format.

1. Log in to the PowerProtect Data Manager Appliance REST API as a user with the Administrator or Security Administrator role.
   Record the access token.
2. (Optional) Import the security certificate in PEM format:

   POST https://{{server}}:{{port}}/api/v2/certificates

   Headers:
     Content-Type: application/json
     Authorization: Bearer {{access-token}}

   {
       "host": "{{external-component}}",
       "port": "{{remote-port}}",
       "type": "{{cert-type}}",
       "certificateChain": "{{PEM-cert}}"
   }

   Replace {{PEM-cert}} with a \n-delimited single-line string that represents the contents of the certificate chain. For example:

   -----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgI\nUzERMA8GA1UEChMIU2l\nMDkyMjE4MDEzNFoXDTI\nBAoTC1BQRE0gU2VydmV\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nEHD0fXjANBgkqhkiG9w\nd3cuc2lnbi5jb20gYz1\nZ24gUm9vdCBDQTAeFw0\nBgNVBAYTAlVTMREwDwY\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDSTCCAjGgAwIBAgI\nd3cuc2lnbi5jb20gYz1\nZ24gUm9vdCBDQTAeFw0\nBgNVBAsTEXd3dy5zaWd\n-----END CERTIFICATE-----\n

   The REST API service returns a status code.
3. (Optional) Import the security certificate in Base64 format:

   POST https://{{server}}:{{port}}/api/v2/certificates

   Headers:
     Content-Type: application/json
     Authorization: Bearer {{access-token}}

   {
       "host": "{{external-component}}",
       "port": "{{remote-port}}",
       "type": "{{cert-type}}",
       "certificateChain": "{{Base64-cert}}"
   }

   Replace {{Base64-cert}} with a Base64-encoded single-line string that represents the contents of the certificate chain. For example:

       "certificateChain": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSU9rRENDRF"

   The REST API service returns a status code.