Archive Served Data List REST Service

Use the Archive Served Data List REST Service to move or archive the records in the database table that contains transaction details of the cryptographic objects that IBM Security Guardium Key Lifecycle Manager serves the clients.

The records are deleted from the database table and moved to a file that is stored in the SKLM_DATA/data/ServedDataListArchives/ServedData_date_time_stamp.jar file, where date_time_stamp is the date and time stamp when the REST service is run.

Operation
POST
URL
https://host:port/SKLM/rest/v1/archive/servedData

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
201 Created
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
message Returns a message to indicate the success of the operation.
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.

Example

Archive the database table that includes key serving transactional data
POST https://localhost:port/SKLM/rest/v1/archive/servedData
Success response
{"message":"CTGKM3437I Served data has been archived successfully."}
Error response

{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user 
authentication ID or invalid request format."}