Use the Backup Get Result REST Service to determine the success or
failure of the most recent backup task.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/ckms/backups/result
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 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 Headers
Header name |
Value and description |
Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
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 the status message to indicate the success or failure of the most
recent backup task:
- -1
- Status of the task cannot be determined. The task is not run since the last time the IBM Security Guardium Key Lifecycle Manager server started.
- 0
- The task succeeded.
- 1
- The task failed.
- 2
- Backup operation succeeded with a warning.
|
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 get the result of the most recent backup task
GET https://localhost:port/SKLM/rest/v1/ckms/backups/result
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
- Success
response
Status Code : 200 OK
Content-Language: en
{"code":"0","status":"Operation succeeded"}
- Invalid service request (when the user is not authenticated)
-
GET https://localhost:port/SKLM/rest/v1/ckms/backups/result
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."}