Skip to main content

Renew a certificate

POST 
/vedsdk/certificates/Renew

Requests immediate renewal for an existing certificate. A renewable certificate cannot be currently processing, in error, or contain a 'Monitoring' Management Type.

Optionally, this API call can renew a previously disabled certificate.

The caller must have Write permission to the Certificate object that requires renewal.

NOTE: Unless the WorkToDoTimeout parameter is specified, this method will immediately return. If you want to wait for the certificate to be issued and returned in the response, specify how long you are willing to wait via WorkToDoTimeout.

Result code:

  • 200 will be returned if the certificate request was accepted and the WorkToDoTimeout was not set.
  • 200 will be returned if the WorkToDoTimeout was set and the certificate is included in the response.
  • 202 will be returned if the certificate issuance is still pending. In this case, use the /certificate/retrieve endpoint to obtain the certificate after it is issued.

Required scope: certificate:manage

Request​

Responses​

The response body contains the renewed certificate data and other information. Returned if the certificate request was accepted and the WorkToDoTimeout was not set, OR WorkToDoTimeout was set and the certificate is included in the response.