Generate key pair REST API

Use this REST API to generate a key pair for encrypting your backup data. You must specify the backup location, and the password (twice, the second time for verification), and indicate whether or not to use the existing private key and certificate.

If you prefer to control the encryption keys and not have the system generate the keys for you, use the Upload Key Pair REST API.

To use this REST API, you must have all of the following user roles and permissions:
  • Workload resources administration with Manage workload resources (Full permission)
  • Cloud group administration with Manage cloud resources (Full permission)
  • Hardware administration with Manage hardware resources (Full permission)
  • Security administration role with permission to Manage security (Full permission)

Generate the key pair

Resource Value
URI /admin/resources/generateKeypair
Method PUT
Returns 200 The key pair was generated successfully.
400 Either the specified backup location does not have any records, or the password specified is not valid.
500 Platform System Manager encountered an internal error while processing the request.

Request body

This REST API call takes JSON input and generates the key pair for the specified backup location and password. The request format is similar to the following example.

{
   "backup_location":"9bfed29d-c5e0-4807-999c-3719a0da71b8",
   "password":"passw0rd",
   "password_verification":"passw0rd",
   "useExistingPkey":false
}

A check is performed to see if a backup operation is currently running. If so, a warning message is issued.

This REST API call returns the following message:

Keypair has been generated successfully.
Attributes list
backup_location
The ID of the backup location configuration, for example:
fc856906-85ea-48db-97b3-853fc5510757
password
A valid password used for generating the key pair.
password_verification
The same valid password, entered a second time for verification.
useExistingPkey
A boolean value indicating whether or not to use the existing private key. Valid values are true (only the certificate is generated) or false( both the certificate and private key are generated).