Backup Get Restore Progress REST Service
Use the Backup Get Restore Progress REST Service to determine the current phase of a restore task that is running.
Note: Some phases of a restore task are brief. You
might
not observe their return.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/ckms/backupRestore/progress
By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this default port.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port | Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
Header name | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
Authorization | SKLMAuth userAuthId=<authIdValue> |
Accept-Language | Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or de. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
code | Returns the value that is specified by the status property. |
status | Returns any of the following status messages to determine the current phase of
a restore task that is running:
|
Error Response Body
JSON object with the following specification.
JSON property name | Description |
---|---|
code | Returns the application error code. |
message | Returns a message that describes the error. |
Examples
- Service request to determine the current phase of a restore task
GET https://localhost:port/SKLM/rest/v1/ckms/restore/progress Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en
- Success response
Status Code : 200 OK Content-Language: en {"code":"7","status":"COMPLETED"}
- Invalid service request where the user has not authenticated
-
GET https://localhost:port/SKLM/rest/v1/ckms/restore/progress Content-Type: application/json Accept : application/json Accept-Language : en
- Error response
Status Code : 400 Bad Request Content-Language: en {"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."}