POST Certificates/Retry

Allows the Application object to retry the last unsuccessful lifecycle stage of a particular certificate. Application objects only participate in stages of the certificate lifecycle that involve certificate provisioning. For more information, see the Administration Guide.

Requirements

  • Permissions:  The caller must have Read permission and Write permission to the Certificate object
  • Token scope:  Certificate:Manage

Headers

  • Content type: Content-Type:application/json.

Parameters

Input parameters

Name

Description
CertificateDN The Distinguished Name (DN) of the certificate.

WorkToDoTimeout

(Optional) The maximum wait time to retry a certificate stage.

Overrides the Platforms tree setting for the Certificate API ToDo Timeout setting. The maximum number of seconds to wait for the ToDo operation to complete. The default is zero seconds with a maximum value of 120 seconds. For example:WorkToDoTimeout: 60. For more information, see Certificates API configuration.

Returns

The response includes information about errors. On error, Certificates/Retry returns a HTTP 400 Bad Request and one of the following error messages:

  • Access error. Certificates/Retry requires write permissions for certificate [ CertificateDN].

  • Failed to add work for application [Consumer]. Retry for this application will not occur. Failure details: [ErrorMessage] Result Code: [ Certificates WorkToDo result codes ].

  • Failed to add work for certificate [CertificateDN]. Retry for this cert and any associate applications will not occur. Failure details: [Error Message] Result Code: [ Certificates WorkToDo result codes ].

  • Invalid CertificateDN format. The Certificate DN contained null or white spaces for [ CertificateDN].

  • Retry canceled. No retry is required for the certificate. [error]

For valid requests, Certificates/Retry returns a HTTP 200 message and the following data in the message body:

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Success: true: The certificate will retry the current lifecycle stage.

HTTP 400

For invalid requests, this call returns a HTTP 400 BadRequest and the following data in the message body:

  • Error: [Error Message]

  • Success: false: The certificate remains in error at the current lifecycle stage.

Example: Retry the previous lifecycle stage

Request

POST https://tpp.venafi.example/vedsdk/Certificates/Retry
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "CertificateDN":"\\VED\\Policy\\test_retry122017141215963\\cert_122017141215969"
}

Response

HTTP/1.1 200 OK
{
   "Success":true
}