Get Domain Control Validation Metadata

Retrieve the following domain control validation (DCV) for a specific certificate request:

• Email: Returns the set of email addresses to which DCV instructions were sent.
• DNS Text: Returns the token that should be applied to each SAN's TXT record.

• OV and EV Certificates

  DNS CNAME: Returns the token that should be applied to the name of the CNAME record for the SAN(s) defined in the request.

Request

Retrieve a certificate's DCV metadata through the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/sec/cps/v2.0/dcv/certificates/Certificate Request ID?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	Required for DNS Text and DNS CNAME DCV 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 retrieve the current certificate request's DCV metadata.
@type	String	Returns Collection.
items	Array of objects	Returns a certificate request's DCV metadata.

dcv_token Object

The dcv_token object describes DCV metadata for the domain identified by the domain_id property.

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 will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

{
	"@id": "/v2.0/dcv/certificates/11500",
	"@type": "Collection",
	"items": [{
			"dcv_token": {
				"token": "23f5zhv4k7pz4zxx3h1jy2ykjmf5hnx8"
			},
			"domain_id": 22333,
			"dcv_method": "DnsCnameToken"
		}
	]
}