Add Certificate

Submit a TLS certificate request.

OV and EV certificates:

OV and EV certificates require an organization. We strongly recommend that you reuse an existing organization whenever possible. Using multiple organizations for the same corporate entity may delay or block the validation of your certificate. Use the Get Organization by Name endpoint to find out the system-defined ID and the exact name under which your organization was registered.
If your organization has an ID of 0, then it has only been registered with Digicert. This means that you must also set the company_name property to the exact name under which your organization was registered.

Request

Order a certificate through the following request:

HTTP Method	Request URI
POST	https://api.vdms.io/sec/cps/v2.0/certificates/cdnprovided

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_authority Required	String	Set to DigiCert.
certificate_label Required	String	Sets the certificate's name. Specify a name that solely consists of alphanumeric characters, underscores, and dashes.
dcv_method Required	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 Required	Array of objects	Contains the certificate's domain(s).
organization Required	Object	Required for OV and EV certificates Describes the certificate request's organization. Do not specify an organization for DV certificates.
validation_type Required	String	Determines the certificate's level of validation. Learn more. Use the Get Certificate Validation Levels endpoint to retrieve a list of validation levels.

domains Array

The domains array describes each domain through the following properties:

Name	Data Type	Description
is_common_name	Boolean	Determines whether this domain corresponds to the certificate's common name. You may only designate a single domain as the common name. Default Value: If you do not designate a domain as the common name, then our system will assign it to one of your domains.
name Required	String	Sets the domain name. Example: cdn.example.com

Name

Data Type

Description

is_common_name

Boolean

Determines whether this domain corresponds to the certificate's common name.

You may only designate a single domain as the common name.

Default Value:

If you do not designate a domain as the common name, then our system will assign it to one of your domains.

name

Required

String

Sets the domain name.

Example:

cdn.example.com

organization Object

The organization object describes the certificate request's organization through the following properties:

Name	Data Type	Description
additional_contacts Required	Array of objects	Required for EV certificates Contains additional contacts that are also responsible for validating certificates for this organization.
city Required	String	Required for OV and EV certificates Sets the organization's city.
company_address Required	String	Required for OV and EV certificates Sets the organization's address.
company_address2 Required	String	Sets the organization's secondary address information (e.g., suite number).
company_name Required	String	Required for OV and EV certificates Sets the organization's name. If we are unable to identify an organization through the id property, then we will compare the name specified in this property to all of your organizations. If an exact match is found, then the certificate request will be associated with that organization. Additionally, all other properties defined within this object will be ignored. If we cannot identify an existing organization through either the id or company_name properties, then we will create a new organization using the information supplied in this object.
contact_email Required	String	Required for OV and EV certificates Sets the email address for the individual responsible for validating certificates for this organization.
contact_first_name Required	String	Required for OV and EV certificates Sets the first name for the individual responsible for validating certificates for this organization.
contact_last_name Required	String	Required for OV and EV certificates Sets the last name for the individual responsible for validating certificates for this organization.
contact_phone Required	String	Required for OV and EV certificates Sets the phone number for the individual responsible for validating certificates for this organization.
contact_title	String	Sets the title of the individual responsible for validating certificates for this organization.
country Required	String	Required for OV and EV certificates Sets the organization's country by its ISO 3166 country code. Use the Get Country Codes endpoint to retrieve a list of countries and their codes.
id	Integer	Identifies an organization by its system-defined ID. Key information: Specify an existing organization by passing either of the following values: ID: Set this property to the system-defined ID for the desired organization. 0: Set this property to 0 if the desired organization has only been registered with Digicert. Additionally, you must set the company_name property to your organization's exact name as defined within Digicert. Use the Get Organization by Name endpoint to find organizations by name. Use the Get Organization by ID endpoint to get detailed information about a specific organization. You cannot modify an existing organization. If you assign an existing organization to this certificate, then other properties defined within this object will be ignored.
organizational_unit	String	Sets the name of the organizational unit responsible for validating certificates for this organization.
state Required	String	United States Only: Required for OV and EV certificates Sets the organization's state by its abbreviation.
zip_code Required	String	United States Only: Required for OV and EV certificates Sets the organization's zip code.

additional_contacts Array

The additional_contacts array describes each of the organization's additional contacts through the following properties:

Name	Data Type	Description
contact_type Required	String	Required for EV certificates Set to EVApprover.
email Required	String	Required for EV certificates Sets the email address for the current contact.
first_name Required	String	Required for EV certificates Sets the first name for the current contact.
id	Integer	Reserved for future use.
last_name Required	String	Required for EV certificates Sets the last name for the current contact.
phone Required	String	Required for EV certificates Sets the phone number for the current contact.
title Required	String	Required for EV certificates Sets the title of the current contact.

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 (201 Created) 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	Returns a null value.
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	Returns a null value.
organization	Object	Describes the certificate request's organization.
request_type	String	Returns Enterprise.
thumbprint	String	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.

domains Array

The domains array describes each domain through the following properties:

Name	Data Type	Description
active_date	String	Returns a null value.
created	String	Indicates the timestamp at which this domain was added to the certificate request. Syntax: YYYY-MM-DDThh:mm:ss.ffffffZ Learn more.
id	Integer	Indicates the system-defined ID assigned to this domain.
is_common_name	Boolean	Indicates whether this domain corresponds to the certificate's common name.
name	String	Indicates the domain name. Example: cdn.example.com
status	String	Returns ProvisioningInitiated.

organization Object

The organization object describes the certificate request's organization through the following properties:

Name	Data Type	Description
additional_contacts	Array of objects	Contains additional contacts that are also responsible for validating certificates for this organization.
city	String	Indicates the organization's city.
company_address	String	Indicates the organization's address.
company_address2	String	Indicates the organization's secondary address information (e.g., suite number).
company_name	String	Indicates the organization's name.
contact_email	String	Indicates the email address for the individual responsible for validating certificates for this organization.
contact_first_name	String	Indicates the first name for the individual responsible for validating certificates for this organization.
contact_last_name	String	Indicates the last name for the individual responsible for validating certificates for this organization.
contact_phone	String	Indicates the phone number for the individual responsible for validating certificates for this organization.
contact_title	String	Indicates the title of the individual responsible for validating certificates for this organization.
country	String	Indicates the organization's country by its ISO 3166 country code. Use the Get Country Codes endpoint to retrieve a list of countries and their codes.
id	Integer	Identifies an organization by its system-defined ID.
organizational_unit	String	Indicates the name of the organizational unit responsible for validating certificates for this organization.
state	String	Indicates the organization's state by its abbreviation.
zip_code	String	Indicates the organization's zip code.

additional_contacts Array

The additional_contacts array describes each of the organization's additional contacts through the following properties:

Name	Data Type	Description
contact_type	String	Returns EVApprover for EV certificates.
email	String	Indicates the email address for the current contact.
first_name	String	Indicates the first name for the current contact.
id	Integer	Reserved for future use.
last_name	String	Indicates the last name for the current contact.
phone	String	Indicates the phone number for the current contact.
title	String	Indicates the title of the current contact.

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.

POST https://api.vdms.io/sec/cps/v2.0/certificates/cdnprovided HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host: api.vdms.io

{
	"domains": [{
			"name": "cdn.example.com"			
		}
	],
	"certificate_authority": "DigiCert",
	"validation_type": "DV",
	"certificate_label": "cdn example domain",
	"dcv_method": "DnsTxtToken"
}

A sample JSON response is shown below.

HTTP/1.1 201 Created

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 1053

{
    "@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": null,
    "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
}