REST API - get

esx kms providers: get

Return information about a Key Provider.

Request:

HTTP request

GET https://{server}/api/esx/kms/providers/{provider}

Path Parameters

Name	Type	Description
Required
provider	string	Identifier of the provider.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "key_server" : {
        "proxy_server" : {
            "hostname" : "string",
            "port" : 1
        },
        "description" : "string",
        "kmip_server" : {
            "servers" : [
                {
                    "address" : {
                        "hostname" : "string",
                        "port" : 1
                    },
                    "name" : "string"
                },
                {
                    "address" : {
                        "hostname" : "string",
                        "port" : 1
                    },
                    "name" : "string"
                }
            ],
            "username" : "string"
        },
        "type" : "KMIP",
        "connection_timeout" : 1
    },
    "master_key_id" : "string"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Provider information.
-.master_key_id	string	Master key identifier created for the provider. A unique Key identifier.
-.key_server	key_server_info	Key server associated with this provider.
-.key_server.type	string	Type of the key server. List the {@name KeyServer) types. Value is one of: KMIP: Key Management Interoperability Protocol (KMIP) based key management server.
-.key_server.description	string	Description of the key server.
-.key_server.proxy_server	network_address	Proxy server configuration. Optional. If unset, proxy server configuration will not be set.
-.key_server.proxy_server.hostname	string	The IP address or the hostname.
-.key_server.proxy_server.port	long	The port for the connection. Optional. If unset, a default port depending on the server type will be used or 443 if it's not explicitly specified.
-.key_server.connection_timeout	long	Connection timeout in seconds. Optional. If unset, connection timeout will be unset.
-.key_server.kmip_server	kmip_server_info	Key Server configuration detail for KMIP based KMS. Optional. It is only relevant when type has value KMIP. This field is optional and it is only relevant when the value of `type` is KMIP.
-.key_server.kmip_server.servers	server[]	List of KMIP compliant key servers.
-.key_server.kmip_server.servers[].name	string	Name of the server. A unique string chosen by the client.
-.key_server.kmip_server.servers[].address	network_address	The server's address.
-.key_server.kmip_server.servers[].address.hostname	string	The IP address or the hostname.
-.key_server.kmip_server.servers[].address.port	long	The port for the connection. Optional. If unset, a default port depending on the server type will be used or 443 if it's not explicitly specified.
-.key_server.kmip_server.username	string	Username for authentication. Optional. If unset, username will not be set.

Errors:

HTTP Status Code	Type	Description
400	invalid_argument	if the provider Id is empty.
404	not_found	if the provider is not found.
401	unauthenticated	if the caller is not authenticated.
403	unauthorized	if the caller is not authorized.
500	error	if any other error occurs.