Get All Certificate Requests

Retrieve the certificates that have been requested for your account.

Request

Retrieve your certificate requests through the following request:

HTTP Method	Request URI
GET	Get All Certificates: https://api.vdms.io/sec/cps/v2.0/certificates Search for certificates: https://api.vdms.io/sec/cps/v2.0/certificates?query=Search Query&page=Page Number&page_size=Page Size&sort=Sort Order

Define the following variables:

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
Page Number	Filter the response by a specific page. Replace this variable with the desired page. Use the navigation links within the @links object to navigate between pages. Default Value: 1
Page Size	Limit the response to only include the specified number of results. Default Value / Upper Limit: 20
Query	Filter the response to only include certificate requests that match the specified query. Valid values are: certificate_label | description | id | domain_names Use * as a wildcard. Example: Filters the response to only include certificates that contain at least one domain that ends with example.com: ?query=domain_names:*.example.com
Sort Order	Determines the order in which certificates are listed in the response. Valid values are: certificate_label | description | id By default, certificate requests are sorted in descending order. Use - to sort them in ascending order. Example: Sorts the response by certificate's name in ascending order: ?sort=-certificate_label

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 the requested endpoint.
@type	String	Returns Collection.
items	Array	Contains a list of certificates.
total_items	Integer	Indicates the total number of certificates.

items Array

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

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	Contains a list of delivery platforms to which this certificate has been deployed.
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	Describes the user that last modified this certificate request.
request_type	String	Returns Enterprise.
thumbprint	String	Indicates the certificate's thumbprint (aka fingerprint). If the CA is still processing the certificate request, then this property 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.

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",
	"@type": "Collection",
	"items": [{
			"@id": "/v2.0/certificates/11602",
			"@type": "Certificate",
			"domains": [{
					"name": "cdn1.example.com",
					"status": "AwaitingCertificateAuthority",
					"active_date": null,
					"is_common_name": true,
					"created": "2021-12-15T21:49:18.013077Z",
					"id": 23047
				}, {
					"name": "cdn2.example.com",
					"status": "AwaitingCertificateAuthority",
					"active_date": null,
					"is_common_name": false,
					"created": "2021-12-15T21:49:18.013077Z",
					"id": 23048
				}
			],
			"certificate_authority": "DigiCert",
			"validation_type": "DV",
			"organization": null,
			"dcv_method": "DnsTxtToken",
			"certificate_label": "cdn1 certificate",
			"description": null,
			"last_modified": "2021-12-16T00:21:13.50608Z",
			"created": "2021-12-15T21:49:18.013077Z",
			"expiration_date": "0001-01-01T00:00:00Z",
			"request_type": "Enterprise",
			"thumbprint": null,
			"deployments": [],
			"created_by": {
				"user_id": 244982,
				"portal_type_id": "Customer",
				"identity_id": "2c43121c-a8ac-4bdd-951a-aca0a34a2n2c",
				"identity_type": "User"
			},
			"modified_by": null,
			"workflow_error_message": null,
			"auto_renew": true,
			"id": 11602
		}, {
			"@id": "/v2.0/certificates/11603",
			"@type": "Certificate",
			"domains": [{
					"name": "cdn-images1.example.com",
					"status": "AwaitingCertificateAuthority",
					"active_date": null,
					"is_common_name": true,
					"created": "2021-12-15T23:40:33.961381Z",
					"id": 23049
				}, {
					"name": "cdn-images2.example.com",
					"status": "AwaitingCertificateAuthority",
					"active_date": null,
					"is_common_name": false,
					"created": "2021-12-15T23:40:33.961381Z",
					"id": 23050
				}
			],
			"certificate_authority": "DigiCert",
			"validation_type": "DV",
			"organization": null,
			"dcv_method": "DnsTxtToken",
			"certificate_label": "CDN images certificate",
			"description": null,
			"last_modified": "2021-12-16T00:21:14.468145Z",
			"created": "2021-12-15T23:40:33.961381Z",
			"expiration_date": "0001-01-01T00:00:00Z",
			"request_type": "Enterprise",
			"thumbprint": null,
			"deployments": [],
			"created_by": {
				"user_id": null,
				"portal_type_id": null,
				"identity_id": "2cd24392-3edb-4f2d-9b1d-e089f9357n2c",
				"identity_type": "Client"
			},
			"modified_by": null,
			"workflow_error_message": null,
			"auto_renew": true,
			"id": 11603
		}, {
			"@id": "/v2.0/certificates/11604",
			"@type": "Certificate",
			"domains": [{
					"name": "cdn-resources.example.com",				
					"status": "Active",
					"active_date": null,
					"is_common_name": true,
					"created": "2021-02-18T21:40:49.921598Z",
					"id": 15230
				}
			],
			"certificate_authority": "DigiCert",
			"validation_type": "DV",
			"organization": null,
			"dcv_method": "DnsTxtToken",
			"certificate_label": "CDN resources certificate",
			"description": null,
			"last_modified": "2021-03-11T22:14:13.933637Z",
			"created": "2021-02-18T21:40:49.921598Z",
			"expiration_date": "2022-10-07T00:00:00Z",			
			"request_type": "Enterprise",
			"thumbprint": "32C1DF418293CBF28517297067D16E8C1A853076",
			"deployments": [{
					"delivery_region": "GlobalPremiumAsiaPlusLatam",
					"platform": "HttpLarge",
					"hex_url": "cs123.wpc.0001.omegacdn.net"
				}
			],
			"created_by": {
				"user_id": null,
				"portal_type_id": null,
				"identity_id": "2cd24392-3edb-4f2d-9b1d-e089f9357n2c",
				"identity_type": "Client"
			},
			"modified_by": null,
			"workflow_error_message": null,
			"auto_renew": true,
			"id": 11604
		}
	],
	"total_items": 3
}