List KMIP servers

Virtual Storage Platform One Object API Reference Guide

Version
3.0.x
File Size
270 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-01

Provides a list of all configured external KMIP servers.

Endpoint

POST /kmip/list_servers

Request structure

Not applicable.

Response structure

{
  "servers": {
      "additionalProp1": {
        "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"    
      }
      "additionalProp2": {
        "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"    
      }
      "additionalProp3": {
        "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 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.
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.
500 Internal Server Error An issue has occurred with the server.