REST API - get

vcenter trusted infrastructure trust authority hosts kms: get

Returns the connection info about the Key Provider Service running on the specified host. This operation was added in vSphere API 7.0.0.

Request:

HTTP request

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/

Path Parameters

Name Type Description
Required
host string @{link com.vmware.vcenter.Host} id.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "cluster""string",
    "trusted_CA"{
        "cert_chain"[
            "string",
            "string"
        ]
    },
    "address"{
        "hostname""string",
        "port"1
    },
    "host""obj-103",
    "group""string"
}

Headers:

None

Type:

Name Type Description
bold = required
- info The vcenter.trusted_infrastructure.trust_authority_hosts.kms.info instance which contains the information necessary to connect to the Key Provider Service.
-.host string The trusted ESX on which the service runs. This attribute was added in vSphere API 7.0.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

-.address network_address The service's address. This attribute was added in vSphere API 7.0.0.

-.address.hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

-.address.port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

-.group string The group ID determines which Attestation Service instances this Key Provider Service can communicate with. This attribute was added in vSphere API 7.0.0.

-.cluster string The opaque string identifier of the cluster in which the Key Provider Service is part of. This attribute was added in vSphere API 7.0.0.

-.trusted_CA x509_cert_chain The service's TLS certificate chain. This attribute was added in vSphere API 7.0.0.

-.trusted_CA.cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 7.0.0.

Errors:

HTTP Status Code Type Description
500 error if service's TLS certificate chain is not valid.
404 not_found if host doesn't match to any Host.
401 unauthenticated if the user can not be authenticated.
500 resource_inaccessible if connection to host failed.