EKM Server:Update Server

Search (SHIFT+S)

Update Server

PUT /ekm/server/{clusterId}/{serverId}

clusterId
serverId

Required Roles

SYSTEM_ADMIN

Request Payload

<ekmserver_update>
   <fqdn_ip></fqdn_ip>
   <cluster_id></cluster_id>
   <server_id></server_id>
   <server_hostname></server_hostname>
   <certificate_authority></certificate_authority>
   <certificate_revocation_list></certificate_revocation_list>
   <username></username>
   <password></password>
   <device_serial></device_serial>
   <device_id></device_id>
   <port></port>
   <identity_store></identity_store>
   <identity_store_password></identity_store_password>
</ekmserver_update>

{
  "fqdn_ip": "",
  "cluster_id": "",
  "server_id": "",
  "server_hostname": "",
  "certificate_authority": "",
  "certificate_revocation_list": "",
  "username": "",
  "password": "",
  "device_serial": "",
  "device_id": "",
  "port": "",
  "identity_store": "",
  "identity_store_password": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
ekmserver_update
fqdn_ip	FQDN/IP associated with the EKM Server	String
cluster_id	Id of the cluster associated with the EKM Server	String
server_id	Id of the the EKM Server	String
server_hostname	Proper server name to be used. Should match certificateAuthority.	String
certificate_authority	Certificate used for authentication with the EKM	String
certificate_revocation_list	Certificates that have revocation entries.	String
username	Username credential. Used with Gemalto Keysecure	String
password	Password credential. Used with Gemalto Keysecure	String
device_serial	Device Serial Number. Used with SKLM EKM Servers	String
device_id	Device Identifer. Used with SKLM EKM Servers	String
port	TCP/IP port on which EKM Server will be listening for key management requests	Integer
identity_store	Client identity store.	String
identity_store_password	Client identity store password.	String

Response Body

Field	Description	Type	Notes
ekmserver
server_id		String
cluster_id		String
fqdn_ip		String
server_hostname		String
certificate_authority		String
certificate_revocation_list		String
identity_store		String
identity_store_password		String
username		String
password		String
device_serial		String
device_id		String
type
port		Integer