Provides information about an individual external KMIP server.
Endpoint
POST /kmip/get_server
Request structure
"name"
| Parameter | Type | Description |
|---|---|---|
| name | String | The user-assigned name of the KMIP server you want to get information about. Type up to 63 Unicode characters. |
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 | Integer | The port number of the KMIP server. |
| isPrimary | Boolean | true. |
| 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. |
| 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. |
| 408 | Request Timeout | The request has timed out internally. |