Esx. Settings. Internal. Notifications. Certificate Refresh Certificate

Esx. Settings. Internal. Notifications. Certificate Refresh Certificate

The refreshCertificate operation is used by CMS to notify updatemgr in the event of vCenter server TLS certificate change. Upon being notified, updatemgr service is reregistered with vCenter server using the new vCenter server TLS certificate.

This operation was added in vSphere API 8.0.2.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}/esx/settings/internal/notifications/certificate
COPY
Request Body

Esx.Settings.Internal.Notifications.Certificate.TLSCertChange schema that contains the notification contents.

Esx.Settings.Internal.Notifications.Certificate.TLSCertChange of type(s) application/json
Required 
"Esx.Settings.Internal.Notifications.Certificate.TLSCertChange Object"
Authentication
This operation uses the following authentication methods.
Responses
200

Success!

Operation doesn't return any data structure

400

If the TLSCertChange#CertChangeType property of notification specifies an invalid cert change type

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json 
"Vapi.Std.Errors.InvalidArgument Object"

401

If the user can not be authenticated

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

403

If the user is not authorized to access the API.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json 
"Vapi.Std.Errors.Unauthorized Object"

500

Vapi.Std.Errors.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Esx.Settings.Internal.Notifications.Certificate.WebHookError If the notification failed to be processed. The accompanying error type will give more details about the failure.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/esx/settings/internal/notifications/certificate
On This Page
Esx.settings.internal.notifications.certificate Operations
POST
Esx. Settings. Internal. Notifications. Certificate Refresh Certificate