Endpoint (Device Group) Export File Summary REST Service

Use the Endpoint (Device Group) Export File Summary REST Service to view the summary of a endpoint (device group) export file.

Operation
POST
URL
https://host:port/GKLM/rest/v1/ckms/deviceGroupsExport/viewSummaryOfExportFileInADirectory

By default, IBM® Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM 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 Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, en or de.
Request body

JSON object with the following specification:

Property name Description
exportFilePath Specifies the export file name and location where the endpoint (device group) export file is stored.
password Specifies the password for the export file that you need to decrypt the endpoint (device group) data.

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
code Returns the value that is specified by the status property.
status Returns the status to indicate whether the export file summary is displayed with an appropriate message.
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 view the export file summary
POST https://localhost:port/GKLM/rest/v1/ckms/deviceGroupsExport
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
{"exportFilePath": "C:\\Program
  Files\\IBM\\WebSphere\\Liberty\\products\\sklm\\data\\sklm_v3.0.0.0_20171019184520-1200_export.exp",
  "password": "sklmadmin"}
Success response
Status Code : 200 OK
{ "items": 
[ { "SOURCE-MACHINE-IP": "9.118.42.182",
      "EXPORT_TIMESTAMP": "2016-10-25T21:11:13.928-12:00", "ALGORITHM": "AES",
      "EXPORT-VERSION": "1.0", "KEYGROUP_BASEFAMILY_ID": "2",
      "KEYGROUP_KEYS_LIST": "[uuid=KEY-ddd2652-e72bf689-b6fb-4d20-bfb4-6f54014d224e,
      alias=abc00ddd2652000000000]", "KEYGROUP_REF_ID": "2", "Manifest-Version":
      "1.0", "PRODUCT-HOME": "C:/Program
      Files/IBM/WebSphere/Liberty/products/sklm", "KEYGROUP_NAME": "LTO",
      "CREATED-BY": "SKLMAdmin", "DESCRIPTION": "GKLM EXPORT", "FILE-PATH":
      "C:\Program Files\IBM\WebSphere\Liberty\products\sklm\data\sklm_v2.7.0.0_20161025211113-1200_export.exp",
      "SOURCE-OS-TYPE": "WINDOWS", "PRODUCT-VERSION": "2.7.0.0 201610250651",
      "KEYGROUP_DESCRIPTION": "LTO Key Group", "SOURCE-OS-DESCRIPTION": "Windows Server
      2012 R2:amd64:6.3", "files": [ { "FILE-DATE": "2016.10.25
      19:21:16+0000", "ROLLFORWARD_STOPTIME": null, "EXTRA_ATTR":
      "INTERNAL", "FILE-SIZE": "7280", "TIMESTAMP": null, "EXPORT-TYPE":
      "FILE", "ORIGINAL-FILE-PATH": "C:/Program
      Files/IBM/WebSphere/Liberty/products/sklm\keystore\tklmTruststore.jceks",
      "ITEM-TYPE": "KEYSTORE" }, { "FILE-DATE": "2016.10.26
      09:11:16+0000", "ROLLFORWARD_STOPTIME": null, "EXTRA_ATTR":
      "INTERNAL", "FILE-SIZE": "407", "TIMESTAMP": null, "EXPORT-TYPE":
      "FILE", "ORIGINAL-FILE-PATH": "C:\Program Files\IBM\WebSphere\Liberty\products\sklm\data\
      878626f7-c778-4e17-81a3-06b7001fac1a_sklm_v2.7.0.0_20161025211113-1200_export\exportKeyStore.jceks",
      "ITEM-TYPE": "KEYSTORE" }, { "FILE-DATE": "2016.10.26
      09:11:59+0000", "ROLLFORWARD_STOPTIME": null, "FILE-SIZE": "4649",
      "TIMESTAMP": null, "EXPORT-TYPE": "DATABASE", "ORIGINAL-FILE-PATH":
      "C:\Program Files\IBM\WebSphere\Liberty\products\sklm\data\
      55fccb68-ed4f-4283-849c-6be3fd326561_sklm_v2.7.0.0_20161025211113-1200_export\tklmExportDbArchive.jar",
      "ITEM-TYPE": "META_DATA" } ], "KEYGROUP_TYPE": "0", "UUID":
      "EXPORT-ddd2652-4e43ac04-087d-44e1-8860-67d04a466388", "KEYGROUP_LTOKEYGROUP_LIST":
      "[uuid=KEYGROUP-ddd2652-810673f4-0b6a-41fe-a8d0-ce4b3ded3862, name=LTO_Keygroup]",
      "Content-Type": "GKLM EXPORT" } ] 
   }
Error response
Error 500: javax.servlet.ServletException: com.ibm.tklm.common.exception.KLMException:
      CTGKM0631E Missing required parameter &quot; password &quot;.