REST API - get

esx trusted infrastructure kms providers: get

Return information about a provider. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/esx/trusted-infrastructure/kms/providers/{provider}

Path Parameters

Name	Type	Description
Required
provider	string	Identifier of the provider.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "type" : "NATIVE",
    "native_info" : {
        "key_id" : "string"
    }
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Provider information.
-.type	string	Type of provider. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Contains the types of providers. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: NATIVE: Native provider. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. TRUST_AUTHORITY: Trust Authority provider. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.native_info	native_provider_info	Native provider info. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when type has value NATIVE. This field is optional and it is only relevant when the value of `type` is NATIVE.
-.native_info.key_id	string	Key identifier for the provider. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code	Type	Description
500	error	if there is a generic error.
400	invalid_argument	if the provider Id is empty.
404	not_found	if the provider is not found.
401	unauthenticated	if the caller is not authenticated.
403	unauthorized	if the caller is not authorized.