Upload License to Server REST Service

Use the Upload License to Server REST Service to upload a license to the IBM® Security Guardium® Key Lifecycle Manager server. Only a valid license can be uploaded. For example, sklm.license.zip.

Operation
POST
URL
https://host:port​/SKLM​/rest​/v1​/filetransfer​/upload​/license

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.
Form parameters
Property name Description
fileToUpload Required. Select the license file that you want to upload to the IBM Security Guardium Key Lifecycle Manager server.
Request Headers
Header name Value
Content-Type application/octet-stream
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
code Returns the application success code.
messageId Returns the status message identifier.
status Returns a success message.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
messageId Returns the status message identifier.
status Returns a message that describes the error.

Example

Upload a license
POST https://localhost:port​/SKLM​/rest​/v1​/filetransfer​/upload​/license
  
Success response
{
  "code": "0",
  "status": "CTGKM3465I File sklm.license.zip is uploaded.",
  "messageId": "CTGKM3465I"
}
Error response
{
  "code": "1",
  "messageId": "CTGKM3463E",
  "status": "CTGKM3463E Cannot upload file because the file type is invalid."
}