Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Create Server

POST /ekm/server


Required Roles

  • SYSTEM_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
ekmserver_create
fqdn_ip FQDN/IP associated with the EKM Server String
cluster_id Name of the cluster associated with the EKM Server String
server_hostname Proper server name to be used. Should match certificate. 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. The value is expected to be a base64 encoding of a .p12 file representing the client. 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

Examples

Request
POST https://localhost:4443/ekm/server

Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<ekmserver_create>
<username>root</username>
<password>password</password>
<type>GEMALTO</GEMALTO>
<port>5696</port>
<server_id>urn:storageos:EKMServer:80552697-a715-3515-bcc3-aaf8607024f7</server_id>
<cluster_id>52ce6785-330b-306d-b902-413c3cfc8c11</cluster_id>
<fqdn_ip>server-2</fqdn_ip>
<server_hostname>server-2</server_hostname>
<certificate_authority>-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIJAJpaK/LOEFhaMA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\r\nBAYTAlVTMQswCQYDVQQIDAJXQTEQMA4GA1UEBwwHUmVkbW9uZDEhMB8GA1UECgwY\r\nSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMB4XDTE4MTEyNzIwMDI1MFoXDTE4MTIy\r\nODIwMDI1MFowTzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAldBMRAwDgYDVQQHDAdS\r\nZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoM4akzg6b/ixUlCVkhmClKGgePiPK\r\nOJRT1snwbnDMAQWVLoeKgg37SV5KrVRCaz+lXrUJYLYmRs4KoiEXxHCIS/uXZXt7\r\n3QvBbRrLLg9ibcBtpDrWLORe+8z0a9oE6EbpHqNZMsc121KjJaMApJiwcWYyaFW7\r\nW03ISMdyI1cHOn9Ab3DGFvXdb22pMPo9Bn1pYw76UwxEo1p4BHtFXo1c8ltyQ/xi\r\n+oILPJDy99B/YtMv4LnZfCbsch8PKw0O82bfGsImcWVMc6i/B1xY0Icilq9Q/xPS\r\nWxogOHGg/8JcvV8YZwSgzZormBgX+yWtcvkBweHf+FulwckZJ8xzvzXbAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBQJIyg2jpQ1CVEcUJniznxCgnN6mzAfBgNVHSMEGDAWgBQJ\r\nIyg2jpQ1CVEcUJniznxCgnN6mzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA\r\nA4IBAQAYkAONQY2sLHkHXdpJZ4lF8/JQlon+VWIcHNsVprRJ61GmPr5z791jgISs\r\nzerb1W6rp7NXg7O3REhictMJxDe6euEevknR7BcfaiahgiQRI8r2QiOs0V6msj/6\r\nyVDXKXlk+VNcxIqVHrO8j+CicnyGw7l5NT2+CU7bvAGg++VtWIS1l6a1EUZJY1mC\r\na/A6CMJOdwZ5rAZmDTr66awjAqKufpo+NUvIKk6mEYDsgFSEmNpFcDDksqdadtOO\r\ns1g01WflF2qcO6oVhB/wMvnfzgfgyPASa3INHD6AdNQbEkblomaNxJo2ZfhVL24N\r\nrR6OW/1Nmto3621EhWcf9/Ub2iNp\r\n-----END CERTIFICATE-----\r\n"</certificate_authority>
<certificate_revocation_list>-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIJAJpaK/LOEFhaMA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\r\nBAYTAlVTMQswCQYDVQQIDAJXQTEQMA4GA1UEBwwHUmVkbW9uZDEhMB8GA1UECgwY\r\nSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMB4XDTE4MTEyNzIwMDI1MFoXDTE4MTIy\r\nODIwMDI1MFowTzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAldBMRAwDgYDVQQHDAdS\r\nZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoM4akzg6b/ixUlCVkhmClKGgePiPK\r\nOJRT1snwbnDMAQWVLoeKgg37SV5KrVRCaz+lXrUJYLYmRs4KoiEXxHCIS/uXZXt7\r\n3QvBbRrLLg9ibcBtpDrWLORe+8z0a9oE6EbpHqNZMsc121KjJaMApJiwcWYyaFW7\r\nW03ISMdyI1cHOn9Ab3DGFvXdb22pMPo9Bn1pYw76UwxEo1p4BHtFXo1c8ltyQ/xi\r\n+oILPJDy99B/YtMv4LnZfCbsch8PKw0O82bfGsImcWVMc6i/B1xY0Icilq9Q/xPS\r\nWxogOHGg/8JcvV8YZwSgzZormBgX+yWtcvkBweHf+FulwckZJ8xzvzXbAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBQJIyg2jpQ1CVEcUJniznxCgnN6mzAfBgNVHSMEGDAWgBQJ\r\nIyg2jpQ1CVEcUJniznxCgnN6mzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA\r\nA4IBAQAYkAONQY2sLHkHXdpJZ4lF8/JQlon+VWIcHNsVprRJ61GmPr5z791jgISs\r\nzerb1W6rp7NXg7O3REhictMJxDe6euEevknR7BcfaiahgiQRI8r2QiOs0V6msj/6\r\nyVDXKXlk+VNcxIqVHrO8j+CicnyGw7l5NT2+CU7bvAGg++VtWIS1l6a1EUZJY1mC\r\na/A6CMJOdwZ5rAZmDTr66awjAqKufpo+NUvIKk6mEYDsgFSEmNpFcDDksqdadtOO\r\ns1g01WflF2qcO6oVhB/wMvnfzgfgyPASa3INHD6AdNQbEkblomaNxJo2ZfhVL24N\r\nrR6OW/1Nmto3621EhWcf9/Ub2iNp\r\n-----END CERTIFICATE-----\r\n"</certificate_revocation_list>
<identity_store>LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tDQpNSUlEY1RDQ0FsbWdBd0lCQWdJSkFKcGFLL0xPRUZoYU1BMEdDU3FHU0liM0RRRUJDd1VBTUU4eEN6QUpCZ05WDQpCQVlUQWxWVE1Rc3dDUVlEVlFRSURBSlhRVEVRTUE0R0ExVUVCd3dIVW1Wa2JXOXVaREVoTUI4R0ExVUVDZ3dZDQpTVzUwWlhKdVpYUWdWMmxrWjJsMGN5QlFkSGtnVEhSa01CNFhEVEU0TVRFeU56SXdNREkxTUZvWERURTRNVEl5DQpPREl3TURJMU1Gb3dUekVMTUFrR0ExVUVCaE1DVlZNeEN6QUpCZ05WQkFnTUFsZEJNUkF3RGdZRFZRUUhEQWRTDQpaV1J0YjI1a01TRXdId1lEVlFRS0RCaEpiblJsY201bGRDQlhhV1JuYVhSeklGQjBlU0JNZEdRd2dnRWlNQTBHDQpDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ29NNGFremc2Yi9peFVsQ1ZraG1DbEtHZ2VQaVBLDQpPSlJUMXNud2JuRE1BUVdWTG9lS2dnMzdTVjVLclZSQ2F6K2xYclVKWUxZbVJzNEtvaUVYeEhDSVMvdVhaWHQ3DQozUXZCYlJyTExnOWliY0J0cERyV0xPUmUrOHowYTlvRTZFYnBIcU5aTXNjMTIxS2pKYU1BcEppd2NXWXlhRlc3DQpXMDNJU01keUkxY0hPbjlBYjNER0Z2WGRiMjJwTVBvOUJuMXBZdzc2VXd4RW8xcDRCSHRGWG8xYzhsdHlRL3hpDQorb0lMUEpEeTk5Qi9ZdE12NExuWmZDYnNjaDhQS3cwTzgyYmZHc0ltY1dWTWM2aS9CMXhZMEljaWxxOVEveFBTDQpXeG9nT0hHZy84SmN2VjhZWndTZ3pab3JtQmdYK3lXdGN2a0J3ZUhmK0Z1bHdja1pKOHh6dnpYYkFnTUJBQUdqDQpVREJPTUIwR0ExVWREZ1FXQkJRSkl5ZzJqcFExQ1ZFY1VKbml6bnhDZ25ONm16QWZCZ05WSFNNRUdEQVdnQlFKDQpJeWcyanBRMUNWRWNVSm5pem54Q2duTjZtekFNQmdOVkhSTUVCVEFEQVFIL01BMEdDU3FHU0liM0RRRUJDd1VBDQpBNElCQVFBWWtBT05RWTJzTEhrSFhkcEpaNGxGOC9KUWxvbitWV0ljSE5zVnByUko2MUdtUHI1ejc5MWpnSVNzDQp6ZXJiMVc2cnA3TlhnN08zUkVoaWN0TUp4RGU2ZXVFZXZrblI3QmNmYWlhaGdpUVJJOHIyUWlPczBWNm1zai82DQp5VkRYS1hsaytWTmN4SXFWSHJPOGorQ2ljbnlHdzdsNU5UMitDVTdidkFHZysrVnRXSVMxbDZhMUVVWkpZMW1DDQphL0E2Q01KT2R3WjVyQVptRFRyNjZhd2pBcUt1ZnBvK05VdklLazZtRVlEc2dGU0VtTnBGY0REa3NxZGFkdE9PDQpzMWcwMVdmbEYycWNPNm9WaEIvd012bmZ6Z2ZneVBBU2EzSU5IRDZBZE5RYkVrYmxvbWFOeEpvMlpmaFZMMjRODQpyUjZPVy8xTm10bzM2MjFFaFdjZjkvVWIyaU5wDQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tDQo=</identity_store>
<identity_store_password>password</identity_store_password>
</ekmserver_create>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ekmserver>
<id>urn:storageos:EKMServer:80552697-a715-3515-bcc3-aaf8607024f7</id>
<tags/>
<username>root</username>
<password>***********</password>
<type>GEMALTO</GEMALTO>
<port>5696</port>
<server_id>urn:storageos:EKMServer:80552697-a715-3515-bcc3-aaf8607024f7</server_id>
<cluster_id>52ce6785-330b-306d-b902-413c3cfc8c11</cluster_id>
<fqdn_ip>server-2</fqdn_ip>
<server_hostname>server-2</server_hostname>
<certificate_authority>-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIJAJpaK/LOEFhaMA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\r\nBAYTAlVTMQswCQYDVQQIDAJXQTEQMA4GA1UEBwwHUmVkbW9uZDEhMB8GA1UECgwY\r\nSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMB4XDTE4MTEyNzIwMDI1MFoXDTE4MTIy\r\nODIwMDI1MFowTzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAldBMRAwDgYDVQQHDAdS\r\nZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoM4akzg6b/ixUlCVkhmClKGgePiPK\r\nOJRT1snwbnDMAQWVLoeKgg37SV5KrVRCaz+lXrUJYLYmRs4KoiEXxHCIS/uXZXt7\r\n3QvBbRrLLg9ibcBtpDrWLORe+8z0a9oE6EbpHqNZMsc121KjJaMApJiwcWYyaFW7\r\nW03ISMdyI1cHOn9Ab3DGFvXdb22pMPo9Bn1pYw76UwxEo1p4BHtFXo1c8ltyQ/xi\r\n+oILPJDy99B/YtMv4LnZfCbsch8PKw0O82bfGsImcWVMc6i/B1xY0Icilq9Q/xPS\r\nWxogOHGg/8JcvV8YZwSgzZormBgX+yWtcvkBweHf+FulwckZJ8xzvzXbAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBQJIyg2jpQ1CVEcUJniznxCgnN6mzAfBgNVHSMEGDAWgBQJ\r\nIyg2jpQ1CVEcUJniznxCgnN6mzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA\r\nA4IBAQAYkAONQY2sLHkHXdpJZ4lF8/JQlon+VWIcHNsVprRJ61GmPr5z791jgISs\r\nzerb1W6rp7NXg7O3REhictMJxDe6euEevknR7BcfaiahgiQRI8r2QiOs0V6msj/6\r\nyVDXKXlk+VNcxIqVHrO8j+CicnyGw7l5NT2+CU7bvAGg++VtWIS1l6a1EUZJY1mC\r\na/A6CMJOdwZ5rAZmDTr66awjAqKufpo+NUvIKk6mEYDsgFSEmNpFcDDksqdadtOO\r\ns1g01WflF2qcO6oVhB/wMvnfzgfgyPASa3INHD6AdNQbEkblomaNxJo2ZfhVL24N\r\nrR6OW/1Nmto3621EhWcf9/Ub2iNp\r\n-----END CERTIFICATE-----\r\n"</certificate_authority>
<certificate_revocation_list>-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIJAJpaK/LOEFhaMA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\r\nBAYTAlVTMQswCQYDVQQIDAJXQTEQMA4GA1UEBwwHUmVkbW9uZDEhMB8GA1UECgwY\r\nSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMB4XDTE4MTEyNzIwMDI1MFoXDTE4MTIy\r\nODIwMDI1MFowTzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAldBMRAwDgYDVQQHDAdS\r\nZWRtb25kMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCoM4akzg6b/ixUlCVkhmClKGgePiPK\r\nOJRT1snwbnDMAQWVLoeKgg37SV5KrVRCaz+lXrUJYLYmRs4KoiEXxHCIS/uXZXt7\r\n3QvBbRrLLg9ibcBtpDrWLORe+8z0a9oE6EbpHqNZMsc121KjJaMApJiwcWYyaFW7\r\nW03ISMdyI1cHOn9Ab3DGFvXdb22pMPo9Bn1pYw76UwxEo1p4BHtFXo1c8ltyQ/xi\r\n+oILPJDy99B/YtMv4LnZfCbsch8PKw0O82bfGsImcWVMc6i/B1xY0Icilq9Q/xPS\r\nWxogOHGg/8JcvV8YZwSgzZormBgX+yWtcvkBweHf+FulwckZJ8xzvzXbAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBQJIyg2jpQ1CVEcUJniznxCgnN6mzAfBgNVHSMEGDAWgBQJ\r\nIyg2jpQ1CVEcUJniznxCgnN6mzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA\r\nA4IBAQAYkAONQY2sLHkHXdpJZ4lF8/JQlon+VWIcHNsVprRJ61GmPr5z791jgISs\r\nzerb1W6rp7NXg7O3REhictMJxDe6euEevknR7BcfaiahgiQRI8r2QiOs0V6msj/6\r\nyVDXKXlk+VNcxIqVHrO8j+CicnyGw7l5NT2+CU7bvAGg++VtWIS1l6a1EUZJY1mC\r\na/A6CMJOdwZ5rAZmDTr66awjAqKufpo+NUvIKk6mEYDsgFSEmNpFcDDksqdadtOO\r\ns1g01WflF2qcO6oVhB/wMvnfzgfgyPASa3INHD6AdNQbEkblomaNxJo2ZfhVL24N\r\nrR6OW/1Nmto3621EhWcf9/Ub2iNp\r\n-----END CERTIFICATE-----\r\n"</certificate_revocation_list>
<identity_store>LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tDQpNSUlEY1RDQ0FsbWdBd0lCQWdJSkFKcGFLL0xPRUZoYU1BMEdDU3FHU0liM0RRRUJDd1VBTUU4eEN6QUpCZ05WDQpCQVlUQWxWVE1Rc3dDUVlEVlFRSURBSlhRVEVRTUE0R0ExVUVCd3dIVW1Wa2JXOXVaREVoTUI4R0ExVUVDZ3dZDQpTVzUwWlhKdVpYUWdWMmxrWjJsMGN5QlFkSGtnVEhSa01CNFhEVEU0TVRFeU56SXdNREkxTUZvWERURTRNVEl5DQpPREl3TURJMU1Gb3dUekVMTUFrR0ExVUVCaE1DVlZNeEN6QUpCZ05WQkFnTUFsZEJNUkF3RGdZRFZRUUhEQWRTDQpaV1J0YjI1a01TRXdId1lEVlFRS0RCaEpiblJsY201bGRDQlhhV1JuYVhSeklGQjBlU0JNZEdRd2dnRWlNQTBHDQpDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ29NNGFremc2Yi9peFVsQ1ZraG1DbEtHZ2VQaVBLDQpPSlJUMXNud2JuRE1BUVdWTG9lS2dnMzdTVjVLclZSQ2F6K2xYclVKWUxZbVJzNEtvaUVYeEhDSVMvdVhaWHQ3DQozUXZCYlJyTExnOWliY0J0cERyV0xPUmUrOHowYTlvRTZFYnBIcU5aTXNjMTIxS2pKYU1BcEppd2NXWXlhRlc3DQpXMDNJU01keUkxY0hPbjlBYjNER0Z2WGRiMjJwTVBvOUJuMXBZdzc2VXd4RW8xcDRCSHRGWG8xYzhsdHlRL3hpDQorb0lMUEpEeTk5Qi9ZdE12NExuWmZDYnNjaDhQS3cwTzgyYmZHc0ltY1dWTWM2aS9CMXhZMEljaWxxOVEveFBTDQpXeG9nT0hHZy84SmN2VjhZWndTZ3pab3JtQmdYK3lXdGN2a0J3ZUhmK0Z1bHdja1pKOHh6dnpYYkFnTUJBQUdqDQpVREJPTUIwR0ExVWREZ1FXQkJRSkl5ZzJqcFExQ1ZFY1VKbml6bnhDZ25ONm16QWZCZ05WSFNNRUdEQVdnQlFKDQpJeWcyanBRMUNWRWNVSm5pem54Q2duTjZtekFNQmdOVkhSTUVCVEFEQVFIL01BMEdDU3FHU0liM0RRRUJDd1VBDQpBNElCQVFBWWtBT05RWTJzTEhrSFhkcEpaNGxGOC9KUWxvbitWV0ljSE5zVnByUko2MUdtUHI1ejc5MWpnSVNzDQp6ZXJiMVc2cnA3TlhnN08zUkVoaWN0TUp4RGU2ZXVFZXZrblI3QmNmYWlhaGdpUVJJOHIyUWlPczBWNm1zai82DQp5VkRYS1hsaytWTmN4SXFWSHJPOGorQ2ljbnlHdzdsNU5UMitDVTdidkFHZysrVnRXSVMxbDZhMUVVWkpZMW1DDQphL0E2Q01KT2R3WjVyQVptRFRyNjZhd2pBcUt1ZnBvK05VdklLazZtRVlEc2dGU0VtTnBGY0REa3NxZGFkdE9PDQpzMWcwMVdmbEYycWNPNm9WaEIvd012bmZ6Z2ZneVBBU2EzSU5IRDZBZE5RYkVrYmxvbWFOeEpvMlpmaFZMMjRODQpyUjZPVy8xTm10bzM2MjFFaFdjZjkvVWIyaU5wDQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tDQo=</identity_store>
<identity_store_password>***********</identity_store_password>
</ekmserver>