Get Certificate Request Status

Retrieve status information for your certificate request. This includes:

• Certificate request status.
• Certificate order status.
• Organization validation status.
• Domain control validation (DCV) status.

Request

Use the following endpoint to retrieve certificate request status information:

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

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 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 order status information for the current certificate request.
@type	String	Returns Certificate.
id	Integer	Indicates the system-defined ID assigned to this certificate.
step	Integer	Indicates the order's current step in the certificate provisioning workflow. Example: This property returns 3 when a certificate order is currently in step 3. Domain Validation (DCV).
status	String	Indicates the status for this certificate request. Use the Get Certificate Request Statuses endpoint to retrieve all available certificate request statuses.
order_validation	Object	Contains order status information for this certificate request.
requires_attention	Boolean	Indicates whether this certificate request requires your attention before it can proceed to the next step.
error_message	String	Indicates the reason why an error occurred. Returns a null value if an error has not occurred.

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/certificates/11400",
	"@type": "Certificate",
	"id": 11400,
	"step": 5,
	"status": "Active",
	"order_validation": {
		"status": "Issued",
		"organization_validation": {
			"validation_type": "OV",
			"status": "Approved"
		},
		"domain_validations": [{
				"domain_id": 22333,
				"status": "Approved",
				"domain_names": ["functions.example.com"]
			}
		]
	},
	"requires_attention": false,
	"error_message": null
}