Cancel Certificate Request

Cancel a certificate request that is still being processed by the Certificate Authority (CA).

Use the Delete Certificate endpoint to delete a TLS certificate that has already been generated by the CA.

Canceling a certificate request may result in one of the following actions:

• New Certificates: Canceling a new certificate request cancels the request submitted to the CA and deletes the certificate request from our system.
• Existing Certificates: Canceling an update to an existing certificate cancels the request submitted to the CA. The existing certificate will remain active.
• Legacy Certificates: Canceling an update to a legacy certificate deletes the legacy certificate. This only occurs for certificates that have not been created or updated through the Certificate Provisioning System (e.g., legacy certificates that were migrated to the Certificate Provisioning System).

You may preview the effect that this operation will have on an certificate request by passing ?apply=false query string when requesting it.

Request

Request the following endpoint to either cancel a certificate request or to revert it:

HTTP Method	Request URI
PUT	Cancel certificate request: https://api.vdms.io/sec/cps/v2.0/certificates/Certificate Request ID/cancel?apply=true Preview the effect of canceling a certificate request: https://api.vdms.io/sec/cps/v2.0/certificates/Certificate Request ID/cancel?apply=false

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Certificate Request ID Required	Replace this variable with the system-defined ID for the desired certificate request. Use the Get All Certificate Requests endpoint to retrieve a list of certificate requests and their system-defined ID.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Request body parameters are not required by this endpoint.

Response

The response includes an HTTP status code, response headers, and a response body. The HTTP status code and response body varies according to whether you are canceling a certificate request or previewing what will happen.

Status Code

A status code indicates whether the request was successfully performed. This status code varies according to whether you are canceling a certificate request or previewing what will happen.

• Cancel Certificate Request (?apply=true)

  204 No Content

• Preview Cancel Certificate Request (?apply=false)

  200 OK

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request varies according to whether you are canceling a certificate request or previewing what will happen.

• Cancel Certificate Request (?apply=true)

  Returns an empty response body.

• Preview Cancel Certificate Request (?apply=false)

  The response body contains the following elements:

  Name	Data Type	Description
  action	String	Indicates the action that will take place upon canceling this certificate request. Valid values are: Delete: Indicates that CPS will delete the certificate and cancel the certificate request. This only occurs for certificates that were not created or updated through the Certificate Provisioning System. Cancel: Indicates that CPS will cancel the request submitted to the CA and delete the request for a new certificate from our system. Revert: Indicates that a request to update an existing certificate will be canceled. The existing certificate will remain active.
  id	Integer	Indicates the system-defined ID for the action that will take place upon canceling this certificate request. Valid values are: 1: Delete 2: Cancel 3: Revert

Errors

The response body for an unsuccessful request may contain an error element that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

A sample JSON response is shown below.