REST API - get

vcenter trusted infrastructure trusted clusters kms services: get

Returns detailed information about the given Key Provider Service instance used by the given cluster. This operation was added in vSphere API 7.0.0.

Request:

HTTP request

GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}

Path Parameters

Name Type Description
Required
cluster string The ID of the cluster.
service string The ID of the service.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "trusted_CA"{
        "cert_chain"[
            "string",
            "string"
        ]
    },
    "address"{
        "hostname""string",
        "port"1
    },
    "trust_authority_cluster""string",
    "group""string"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Detailed information about the given Key Provider Service instance used by the given cluster.
-.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.

-.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.

-.group string The group determines the Attestation Service instances this Key Provider Service can accept reports from. This attribute was added in vSphere API 7.0.0.

-.trust_authority_cluster string The cluster specifies the Trust Authority Cluster this Key Provider Service belongs to. This attribute was added in vSphere API 7.0.0.

Errors:

HTTP Status Code Type Description
500 error if there is a generic error.
404 not_found if the cluster or the service ID is invalid.
401 unauthenticated if the user can not be authenticated.