Set EKMF Web Host Connection Preference Order REST Service

Use the Set EKMF Web Host Connection Preference Order REST Service to set the preference order of EKMF Web hosts for IBM Security Guardium Key Lifecycle Manager requests, when multiple EKMF Web hosts are configured. If a configured EKMF Web host is not mentioned, it is given the last preference by default.

Operation
POST
URL
https://host:port/SKLM/rest/v1/ckms/masterKey/EKMFWeb/config/hostPreferenceSequence

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.
Request body

JSON Object with the following specification.

JSON property name Description
hostPreferenceSequence Specify the connection preference order of EKMF Web hosts for IBM Security Guardium Key Lifecycle Manager requests, when multiple EKMF Web hosts are configured.

Specify the hostnames or IP addresses of the EKMF Web hosts that you specified in the hosts parameter during EKMF Web configuration. For example,

{
  "hostPreferenceSequence": [
    "EKMFWeb_host1",
     "EKMFWeb_host2"
  ]
}

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 code that is specified by the status property.
status Returns the status message that indicates whether the backup was successful.
-1
State is unknown. The task is not run since the last time the IBM Security Guardium Key Lifecycle Manager server started.
0
The backup task succeeded.
1
The backup task failed.
2
Backup task 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

To set EKMF Web hosts preference order, send this HTTP request:

POST https://host:port/SKLM/rest/v1/ckms/masterKey/EKMFWeb/config/hostPreferenceSequence

{
  "hostPreferenceSequence": [

   "ekmf_host1",
    "ekmf_host2",
    "ekmf_host3"   
  ]
}
Success response
[
  {
    "property": "ekmfweb.hostPreferenceSequence",
    "status": "CTGKM0606I Update successful, change will take effect immediately"
  }
]
Invalid request example where the EKMF Web host name is incorrect:
POST https://host:port/SKLM/rest/v1/ckms/masterKey/EKMFWeb/config/hostPreferenceSequence

{
  "hostPreferenceSequence": [

   "abc",
    "ekmf_host2",
    "ekmf_host3"   
  ]
}
Error response
{
  "code": "CTGKM3608E",
  "message": "CTGKM3608E Value for configuration parameter hostPreferenceSequence=abc is not valid. It is not configured as valid host to connect."
}