REST API - get

vcenter trusted infrastructure kms services: get

Returns the detailed information about a registered Key Provider Service instance in this vCenter. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
service string the Key Provider Service instance unique identifier.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "trusted_CA"{
        "cert_chain"[
            "string",
            "string"
        ]
    },
    "trust_authority_cluster""string",
    "group""string"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Detailed information about the specified Key Provider Service instance.
-.address network_address The service's address. This attribute was added in vSphere API 7.0.0.0.

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

-.trusted_CA.cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 7.0.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.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.0.

Errors:

HTTP Status Code Type Description
500 error if an error occurred while getting the data.
404 not_found if there is no Key Provider Service instance with the specified ID.
401 unauthenticated if the user can not be authenticated.