REST API - get
  1. Operations
  2. esx
  3. trusted infrastructure
  4. kms
  5. services

esx trusted infrastructure kms services: get

Returns the detailed information about a KMS service instance.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
service string the attestation service instance unique identifier.

Response:

HTTP Status Code: 200

Response Body Structure:

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

Headers:

None

Type:

Name Type Description
bold = required
- info Detailed information about the specified KMS service instance.
-.address network_address The service's address.
-.address.hostname string The IP address or DNS resolvable name of the service.
-.address.port long The port of the service.

Optional. If unset, port 443 will be used.
-.trusted_CA x509_cert_chain The service's TLS certificate chain.
-.trusted_CA.cert_chain string[] Certificate chain in base64 format
-.group string The group identifier determines which attestation service instances this KMS service can communicate with.

If the group attribute values of attestation and KMS records match then those services are associated with each other.

Errors:

HTTP Status Code Type Description
404 not_found if there is no KMS service instance with the specified identifier.
500 error if there is a problem accessing the stored data.
401 unauthenticated if the user can not be authenticated.