Delete KMS Services
DescriptionRemoves a currently registered Key Provider Service instance from this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ManageTrustedHosts.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/kms/services/{service}
Path Parameters
Path Parameters
string
service
Required
the Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.
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"
Authentication
This operation uses the following authentication methods.
Errors
Errors
500
com.vmware.vapi.std.errors.error : if an error occurred while deleting the service. | com.vmware.vapi.std.errors.resource_busy : if the Key Provider Service instance is used by a configuration on a cluster level.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteServiceKms -Service "MyService"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/kms/services/{service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 7.0.0.0
