HTTP Requests for vSphere Native Key Provider Operations

You can use HTTP requests to retrieve, add, configure, or remove providers. You can also export and import provider configuration.

HTTP Requests

The following HTTP requests show the syntax that you can use to perform the available user operations.

Note: Before you send requests, you must authenticate with administrator credentials or as a user with appropriate cryptographic operations privileges. For information about the required privileges, see vSphere Security.
  • List host providers
    GET https://<server>/api/vcenter/crypto-manager/hosts/<host>/kms/providers
  • Get host provider
    GET https://<server>/api/vcenter/crypto-manager/hosts/<host>/kms/providers/<provider>
  • List providers
    GET https://<server>/api/vcenter/crypto-manager/kms/providers
  • Get provider
    GET https://<server>/api/vcenter/crypto-manager/kms/providers/<provider>
  • Create provider
    POST https://<server>/api/vcenter/crypto-manager/kms/providers
  • Update provider
    PATCH https://<server>/api/vcenter/crypto-manager/kms/providers/<provider>
  • Delete provider
    DELETE https://<server>/api/vcenter/crypto-manager/kms/providers/<provider>
  • Export configuration
    POST https://<server>/api/vcenter/crypto-manager/kms/providers?action=export
  • Import configuration
    POST https://<server>/api/vcenter/crypto-manager/kms/providers?action=import

For information about the content and syntax of the HTTP query parameters, path parameters, and request body parameters, see the API Reference documentation.