Update Task Trust Authority Clusters KMS Providers Client Certificate
Released in v7.0.0Update the client certificate. The key server will use this certificate to validate the client connection. If a client certificate already exists, it will be replaced.
An optional private key can be specified if the certificate has already been provisioned.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate?vmw-task=true
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
| required |
|
string | Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains TrustedInfrastructureTrustAuthorityClustersKmsProvidersClientCertificateUpdateSpec
of type application/json
(required)
{
"certificate": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | certificate | string |
Public certificate used by every host in the cluster. |
| optional | private_key | string |
Private part of the certificate. If unset, the update request is for a public/private client certificate pair, not for a signed CSR. |
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"certificate":"string","private_key":"string"}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate?vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : If the cluster or provider is not found. | com.vmware.vapi.std.errors.error : If any other error occurs. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If the certificate or private key is invalid or cluster/provider id are empty. |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
