Vcenter CertificateManagement Vcenter SigningCertificate refresh

Vcenter CertificateManagement Vcenter SigningCertificate refresh

Refresh the vCenter signing certificate chain. The new signing certificate will be issued in accordance with vCenter CA policy and set as the active signing certificate for the vCenter token service. The certificate will immediately be used to sign tokens issued by vCenter token service. If a third-party/custom certificate has been configured as the signing certificate for compliance reasons, refresh may take vCenter out of compliance.

This operation was added in vSphere API 7.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires CertificateManagement.Administer.
Request
URI
POST
https://{api_host}/api/vcenter/certificate-management/vcenter/signing-certificate?action=refresh
COPY
Request Body

Request body for invoking operation: refresh

{
    "force": false
}
boolean
force
Optional

Will force refresh in environments that would otherwise prevent refresh from occurring, such as a mixed-version environment. Force refresh may leave systems in the local vCenter domain in a non-functional state until they are restarted.

If missing or null, then refresh will not be forced.

Authentication
This operation uses the following authentication methods.
Responses
200

The signing certificate chain created during the refresh.

Returns Vcenter CertificateManagement X509CertChain of type(s) application/json
{
    "cert_chain": [
        "string"
    ]
}
array of string
cert_chain
Required

Certificate chain in base64 format

This property was added in vSphere API 6.7.2.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/certificate-management/vcenter/signing-certificate?action=refresh