Last Backup Info REST Service

Use Last Backup Info REST Service to request for the last backup information of IBM Security Guardium Key Lifecycle Manager data.

Operation
GET
URL
http://host:port/SKLM/rest/v1/backupInfo

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
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
IsBackupBeforeServing Indicates whether the keys are released after the backup operation.
IsLastBackupDateAvailable Indicates whether the last backup date for IBM Security Guardium Key Lifecycle Manager data is available.
lastBackupDate Returns the last backup date of IBM Security Guardium Key Lifecycle Manager data.
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 backup information
GET http://host:port/SKLM/rest/v1/backupInfo
Content-Type: application/json
Accept : application/json
Authorization : SKLMAuth userAuthId=37ea1939-1374-4db7-84cd-14e399be2d20
Accept-Language : en
Success response
Status Code : 200 OK
Content-Language: en
{"IsBackupBeforeServing" : "true",
"IsLastBackupDate" : "true",
"lastBackupDate" : "27497358095"}
Backup does not exist and the IsBackupBeforeServing property is set to false
Status Code : 200 OK
Content-Language: en
{"IsBackupBeforeServing" : "false",
"IsLastBackupDate" : "false"}
Error response
Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "message":"CTGKM6002E Bad Request: 
Invalid user authentication ID or invalid request format."}