Update selected configuration values for an external KMIP server.
Endpoint
POST /kmip/update_server
Request structure
{
"name": "name",
"host": "{hostname|ip_addr}",
["port": [nnnnn],]
"isTLS12Enabled": {true|false},
"kmipProtocol": "version",
"httpsCiphers": "cipher_1[,...,cipher_n",
"uuid": "uuid"
}
| Parameter | Type | Description |
|---|---|---|
| name | String | The user-assigned name of the KMIP server you want to update. Type up to 63 Unicode characters. The server name must be unique. |
| host | String | The host name or IP address of the KMIP server. |
| port | Integer | The port number of the KMIP server. Default: 5956 |
| isTLS12Enabled | Boolean | true if TLS v1.2 is enabled, false otherwise. Note: TLS v1.2 support is provided for backward compatibility only. |
| kmipProtocol | String | The version of the KMIP protocol assigned to the server. |
| httpsCiphers | String | A string of comma-separated cyphers. The default group supports interoperability with a range of commercial key managers. Default: TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, SSL_RSA_WITH_3DES_EDE_CBC_SHA, TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 |
| uuid | UUID | The UUID of the server. |
Response structure
{
"name": "label",
"host": "host_name",
"port": nnnnn,
"isPrimary": {true|false},
"isTLS12Enabled": {true|false},
"kmipProtocol": "version",
"httpsCiphers": "cipher_1[,...,cipher_n]",
"isOnline": {true|false},
"uuid": "uuid"
}
|
Parameter |
Type |
Description |
|---|---|---|
| name | String | The name of the KMIP server. |
| host | String | The host name or IP address of the KMIP server. |
| port | 32-bit integer | The port number of the KMIP 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. |
| kmipProtocol | String | The version of the KMIP protocol assigned to the server. |
| 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. |
| 400 | Bad Request | The request is invalid or improperly formatted. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 404 | Not Found | The KMIP configuration can't be located. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed. Resend using POST. |
| 500 | Internal Server Error | An issue has occurred with the server. |