REST API - list

esx trusted infrastructure kms providers: list

Return the available providers.

Contacts the KMS service to get the list of providers available for key operation.

Request:

HTTP request

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

?providers={value-1}
&providers={value-2}
&available={true}

Query Parameters:

Name Type Description
bold = required
providers string[] Identifier of the provider.

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

available boolean Whether the provider is available for key operations.

Optional. If unset, the result will not be filtered by availability of the providers.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "provider""obj-103",
        "available"true,
        "details"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    },
    {
        "provider""obj-103",
        "available"true,
        "details"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "localized""string",
                "id""string",
                "params"{
                    "<string>"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"{
                                "<string>"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"{}
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] Summary of providers.
-[].provider string Identifier of the provider.

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

-[].available boolean Whether the provider is available for key operation.

-[].details localizable_message[] Details regarding the availability of the provider.

-[].details[].id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-[].details[].default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-[].details[].args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Errors:

HTTP Status Code Type Description
401 unauthenticated If the caller is not authenticated.
403 unauthorized If the caller is not authorized.
500 error For any other error.