Update Certificate Request

Update a certificate request.

Key information:

• The certificate request's state determines the set of allowed changes.

  • In Progress: If the TLS certificate has not been generated by the Certificate Authority (CA), then you will only be allowed to update basic settings (e.g., name, description, and automatic renewal).
  • Completed: If the TLS certificate has been generated by the CA, then you may also administer the domain(s) associated with the certificate. This type of modification will result in a new request being submitted to the CA.
• Use the Cancel Certificate Request endpoint to cancel a request for a TLS certificate.
• Use the Resubmit Certificate Request endpoint to resubmit a certificate request that timed out and therefore was never issued.
• Use the Change Organization endpoint to change the organization associated with a certificate that has already been generated by the Certificate Authority (CA).

Request

Update a request for a certificate through the following endpoint:

HTTP Method	Request URI
PATCH	https://api.vdms.io/sec/cps/v2.0/certificates/Certificate Request ID

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

Pass the following request body parameters:

Name	Data Type	Description
auto_renew	Boolean	Determines whether this certificate will automatically renew prior to its expiration date.
certificate_label	String	Sets the certificate's name. Specify a name that solely consists of alphanumeric characters, underscores, and dashes.
dcv_method	String	Determines the method through which your control over the domains associated with this certificate will be validated. Use the Get Domain Control Validation Types endpoint to retrieve a list of validation methods.
description	String	Sets the certificate's description.
domains	Array of objects	Contains the certificate's domain(s). You cannot add, modify, or delete the domain(s) associated with a certificate request still being processed by the Certificate Authority (CA).

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

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 (200 OK) contains the following response elements:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint through which you may retrieve the current certificate request.
@type	String	Returns Certificate.
auto_renew	Boolean	Indicates whether this certificate will automatically renew prior to its expiration date.
certificate_authority	String	Returns DigiCert.
certificate_label	String	Indicates the certificate's name.
created	String	Indicates the timestamp at which this request for a certificate was initially submitted. Syntax: YYYY-MM-DDThh:mm:ss.ffffffZ Learn more.
created_by	Object	Describes the user that submitted this certificate request.
dcv_method	String	Indicates the method through which your control over the domains associated with this certificate will be validated. Use the Get Domain Control Validation Types endpoint to retrieve a list of validation methods.
deployments	Array	Contains a list of delivery platforms to which this certificate has been deployed.
description	String	Indicates the certificate's description.
domains	Array of objects	Contains the certificate's domain(s).
expiration_date	String	Indicates the timestamp at which this certificate will expire. Syntax: YYYY-MM-DDThh:mm:ss.ffffffZ Learn more. If the Certificate Authority (CA) is still processing the certificate request, then this property returns the following timestamp: 0001-01-01T00:00:00Z
id	Integer	Indicates the system-defined ID assigned to this certificate.
last_modified	String	Indicates the timestamp at which this request for a certificate was last modified. Syntax: YYYY-MM-DDThh:mm:ss.ffffffZ Learn more.
modified_by	Object	Describes the user that last modified this certificate request.
organization	Object	Describes the certificate request's organization.
request_type	String	Returns Enterprise.
thumbprint	String	Indicates the certificate's thumbprint (aka fingerprint). If the CA is still processing the certificate request, then this property returns a null value.
validation_type	String	Indicates the certificate's level of validation. Learn more. Use the Get Certificate Validation Levels endpoint to retrieve a list of validation levels.
workflow_error_message		Returns a null value.

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.

{
	"certificate_label": "cdn.example.com",
	"description": "DV certificate for cdn.example.com"
}

A sample JSON response is shown below.

{
    "@id": "/v2.0/certificates/11614",
    "@type": "Certificate",
    "domains": [
        {
            "name": "cdn-example-com",
            "status": "ProvisioningInitiated",
            "active_date": null,
            "is_common_name": true,
            "created": "2021-12-17T19:29:07.294329Z",
            "id": 23079
        }
    ],
    "certificate_authority": "DigiCert",
    "validation_type": "DV",
    "organization": null,
    "dcv_method": "DnsTxtToken",
    "certificate_label": "cdn example domain",
    "description": "DV certificate for cdn.example.com",
    "last_modified": "2021-12-17T19:29:07.294329Z",
    "created": "2021-12-17T19:29:07.294329Z",
    "expiration_date": "0001-01-01T00:00:00Z",
    "request_type": "Enterprise",
    "thumbprint": null,
    "deployments": [],
    "created_by": {
        "user_id": null,
        "portal_type_id": null,
        "identity_id": null,
        "identity_type": null
    },
    "modified_by": null,
    "workflow_error_message": null,
    "auto_renew": true,
    "id": 11614
}