Export KMS Providers
Export provider configuration. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ManageKeyServers.
Request
URLURL
https://{api_host}/api/vcenter/crypto-manager/kms/providers?action=export
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
CryptoManagerKmsProvidersExportSpec of mimetype application/json
Required
ExportSpec needed to export a provider.
{
"provider": "string"
}
string
provider
Required
Provider identifier When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.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.vcenter.crypto_manager.kms.provider.
string
password
Optional
Password used to encrypt the exported configuration. If unset or empty, the configuration will not be encrypted.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
CryptoManagerKmsProvidersExportResult
of type application/json
{
"location": {
"download_token": {
"expiry": "string",
"token": "string"
},
"url": "string"
},
"type": "LOCATION"
}
type
Required
The Providers.ExportType enumerated type identifies the type of result that is returned when a provider is exported.
LOCATION : Result returned as a URL from which the provider configuration can be downloaded.
Possible values are: LOCATION
location
Optional
Location of the exported configuration This field is optional and it is only relevant when the value of Providers.ExportResult.type is LOCATION.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the provider identifier is empty. | com.vmware.vapi.std.errors.unsupported : if the provider’s type does not allow export.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"password":"string","provider":"string"}' https://{api_host}/api/vcenter/crypto-manager/kms/providers?action=export
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: export
Availability
Added in 7.0.2.0
On This Page
KMS Providers Operations
post
patch
delete
post
