REST API - update-task

vcenter trusted infrastructure trust authority clusters kms providers client certificate: update-task

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

. This operation was added in vSphere API 7.0.0.


HTTP request

PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate

    "private_key""secret string"

Path Parameters

Name Type Description
cluster string Identifier of the cluster.
provider string Identifier of the provider.

Body Parameters:

Name Type Description
bold = required
- update_spec The update spec.
-.certificate string Public certificate used by every host in the cluster. This attribute was added in vSphere API 7.0.0.

-.private_key secret Private part of the certificate. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the update request is for a public/private client certificate pair, not for a signed CSR.


HTTP Status Code: 202

Response Body Structure:





Name Type Description
bold = required
- string


HTTP Status Code Type Description
400 invalid_argument If the certificate or private key is invalid or cluster/provider id are empty.
404 not_found If the cluster or provider is not found.
401 unauthenticated If the caller is not authenticated.
500 error If any other error occurs.