Generate Domain Control Validation Token

Generate a domain control validation (DCV) token.

• DV certificates: You must generate a token for a certificate whose DCV method is DNS text.
• EV and OV certificates: You must generate a token for each SAN defined within a certificate request whose DCV method is either DNS text or DNS CNAME.

If your certificate request uses email DCV, then you should follow the instructions provided in the email sent by the Certificate Authority (CA). A token is not required for email DCV.

Learn more.

Request

Generate a token through the following endpoint:

HTTP Method	Request URI
PUT	https://api.vdms.io/sec/cps/v2.0/dcv/certificates/Certificate Request ID/token?domain_ids=Domain IDs

Define the following variables 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.
Domain IDs	Replace this variable with a comma-delimited list of system-defined IDs for the desired domains associated with the specified certificate request. Use the Get Certificate Request endpoint to retrieve the domains associated with a specific certificate request. Example: ?domain_ids=12345,12346

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 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 generate a DCV token.
@type	String	Returns Collection.
items	Array	Contains the requested DCV token(s).

Name	Data Type	Description
token	String	Indicates the token value through which you may prove control over a specific domain.

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.

{
	"@id": "/v2.0/dcv/certificates/11605/token",
	"@type": "Collection",
	"items": [{
			"dcv_token": {
				"token": "2dltfl3l0jtmyylyh619jhwrect1u0eg"
			},
			"domain_id": null,
			"dcv_method": "DnsTxtToken"
		}
	]
}