You can get information about all configured external KMS servers.
HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/kmip/list_servers
Request structure
Not applicable.
Response structure
The response body structure is:
[ { "name": "label", "host": "host_name", "port": nnnnn, "isPrimary": {true|false}, "isTLS12Enabled": {true|false}, "httpsCiphers": "cipher_1[,...,cipher_n]", "isOnline": {true|false}, "uuid": "uuid" } . . . ]
Parameter |
Type |
Description |
---|---|---|
name | String | The name of the KMS server. |
host | String | The host name or IP address of the KMS server. |
port | Integer | The port number of the KMS server. |
isPrimary | Boolean | true if server is primary (read/write access), false if server is secondary (read-only access). |
isTLS12Enabled | Boolean | true if TLS v1.2 is enabled, false otherwise. |
httpsCiphers | String | A string of comma-separated cyphers. |
isOnline | Boolean | true if server is online, false if server is offline. |
uuid | UUID | The UUID of the server. |
Return codes
Status code |
HTTP name |
Description |
---|---|---|
200 | OK | The request was executed successfully. |
401 | Unauthorized | Access was denied because credentials are not valid. |
405 | Method Not Allowed | The specified HTTP method is not allowed. Resend using POST. |
503 | Service Unavailable | External KMS servers have not been set up. Configure connection to an external KMS server and resend. |
Example
Request example:
POST https://10.10.24.195:9099/mapi/v1/kmip/list_servers
JSON response:
[ servers: { myName=class MAPIKMIPServer { "name": "myName", "host": "myHost_0", "port": 9876, "isPrimary": true, "isTLS12Enabled": false, "httpsCiphers": "TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "isOnline": true, "uuid": "uuid"}, myName_0=class MAPIKMIPServer { "name": "myName_0", "host": "myHost_0", "port": 5678, "isPrimary": true, "isTLS12Enabled": false, "httpsCiphers": "TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "isOnline": true, "uuid": "uuid"},} } ]