Restore locations REST API

Use this REST API to return the list of backup locations from which you can restore data. The size of the backup location configuration, in MB, is also obtained.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

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 with Manage security (Full permission)

List restore locations

Table 1. List restore locations
REST API information Value Description
URI /admin/resources/restore_locations  
Method GET  
Returns 200 The details for each restore location were retrieved successfully.
404 The restore locations were not found.
500 Platform System Manager encountered an internal error while processing the request.

This REST API call queries all backup location configurations and determines the amount of used space for each backup configuration, in MB. This information is returned with other details for each backup location. Note that for this REST API, backup locations are also referred to as restore locations.

Response body

This REST API call returns the following details for each backup location that was accessed successfully:

{
   "port": 22,
   "host": "9.3.47.170",
   "state": "available",
   "encrypt_all": "F",
   "backup_profiles": [
      "0e8e1e44-82f7-42c0-b44f-e30592021222"
      "591781e0-95c1-4572-9466-778546ebe2b5",
      "73501243-498a-4f50-868d-d42825079c1f"
   ],
   "location_configured": "F",
   "updated_time": 1392325854365,
   "password": "********",
   "size": 4431,
   "rackid": null,
   "id": "33ca0d49-fb58-4160-96c3-90580fcad489",
   "username": "ibm",
   "name": "OFFICIAL Linux",
   "path": "/mnt/xiv_storage/backups",
   "host_privatekey": "********",
   "created_time": 1392324882785,
   "connection_via_privatekey": "F"
},
Attributes list
backup_profiles
The list of ID's for the backup profiles that are associated with the backup location (note that both backup location and restore location refer to the same location where data is backed up and later retrieved).
connection_via_privatekey
A boolean value that indicates whether the user authentication to the remote backup system is by private key or by password. Valid values are T (private key) or F (password).
created_time
A timestamp indicating the date and time when the backup location configuration was created. The value is a date and time expressed in Coordinated Universal Time (UTC) format (example: Thu 13 Feb 2014 05:07:36.926 UTC).
encrypt_all
A boolean value that indicates whether or not encryption is enabled for the backup. Valid values are T (true) or F (false).
host
The IP address or fully qualified host name for the remote backup host system.
host_privatekey
If private key authentication is used to access the remote backup system, this attribute identifies the RSA private key value. For security, this value is obscured with asterisks.
id
The id of the backup location.
location_configured
A boolean value that indicates whether or not the location remote settings (host, path, user name, and password or private key) is configured. Valid values are T (true) or F (false).
name
The name of the backup location.
password
If password authentication is used to access the remote backup system, this attribute identifies the password value. For security, this value is obscured with asterisks.
path
The directory path on the remote backup system where backups are stored for this backup location configuration.
port
The port number for connecting to the remote backup host system.
rackid
The ID for the IBM® Cloud Pak System System, comprised of the model type (example: 8283) and the system serial number (example: 1000257), formatted as 82831000257.
size
The size of the backup configuration, in MB.
state
The state of the test connection. The following values are valid:
available
The remote backup system connection was made and the backup size was obtained successfully.
connections_error
A connection error was encountered while attempting to obtain the backup size. This error might occur if the connection to the backup system is not successful.
permissions_error
A permissions error was encountered while attempting to obtain the backup size. This error might occur if the user name and authentication credentials were not valid to access the remote backup system.
unavailable
An unexpected error was encountered while attempting to obtain the backup size.
updated_time
A timestamp indicating the date and time when the backup location configuration was last updated. The value is a date and time expressed in Coordinated Universal Time (UTC) format (example: Thu 13 Feb 2014 05:13:31.942 UTC).
username
The user name that is authorized to access the remote backup system.