Get Certificate Request Statuses

Retrieve the set of available statuses for certificate requests.

Use the Get Certificate Request endpoint to find out the status for a specific certificate request.

Request

Retrieve a list of certificate request statuses through the following request:

HTTP Method Request URI

GET

https://api.vdms.io/sec/cps/v2.0/appendix/certificate-statuses

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 a list of certificate request statuses.

@type

String

Returns Collection.

items

Array of objects

Contains a list of certificate request statuses.

total_items

Integer

Indicates the total number of certificate request statuses.

items Array

The items array describes each certificate request status through the following properties:

Name Data Type Description

name

String

Indicates the name of a certificate request status.

id

Integer

Indicates the system-defined ID for a certificate request status.

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.

HTTP/1.1 200 OK

Cache-Control: no-cache

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

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

Content-Length: 399

{
	"@id": "/v2.0/appendix/certificate-statuses",
	"@type": "Collection",
	"items": [{
			"name": "Processing",
			"id": 1
		}, {
			"name": "DomainControlValidation",
			"id": 2
		}, {
			"name": "OtherValidation",
			"id": 3
		}, {
			"name": "Deployment",
			"id": 4
		}, {
			"name": "Active",
			"id": 5
		}, {
			"name": "Deleted",
			"id": 6
		}
	],
	"total_items": 6
}