REST API - list

esx trusted infrastructure kms services: list

Returns the list of all KMS service instances.

Request:

HTTP request

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

?action=query
{
    "address"[
        {
            "hostname""string",
            "port"1
        },
        {
            "hostname""string",
            "port"1
        }
    ],
    "services"[
        "obj-103",
        "obj-103"
    ],
    "group"[
        "string",
        "string"
    ]
}

Body Parameters:

Name Type Description
bold = required
- filter_spec Optional. Return only services matching the specified filters. If the filter doesn't match, return an empty list.
-.services string[] A set of identifiers by which to filter the services.

Optional. If unset, the services will not be filtered by identifier.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.esx.trusted_infrastructure.kms.service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.esx.trusted_infrastructure.kms.service.

-.address network_address[] The service's address.

Optional. If unset, the services will not be filtered by 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.

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

Optional. If unset, the services will not be filtered by group.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "address"{
            "hostname""string",
            "port"1
        },
        "service""obj-103",
        "group""string"
    },
    {
        "address"{
            "hostname""string",
            "port"1
        },
        "service""obj-103",
        "group""string"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of all KMS service instances.
-[].service string The service's unique identifier.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.trusted_infrastructure.kms.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.trusted_infrastructure.kms.service.

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

-[].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
500 error if there is a problem accessing the stored data.
401 unauthenticated if the user can not be authenticated.