Get Certificate Request's Notification Configuration

Retrieve a specific certificate request's notification configuration.

If you have not explicitly defined a notification configuration on a certificate request, then your account-level notification configuration determines the conditions under which notifications will be sent and to whom they will be sent.

Request

Retrieve a certificate request's notification configuration through the following request:

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

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 the certificate request's notification configuration.
@type	String	Returns Collection.
items	Array of objects	Contains the certificate request's notification configuration.

items Array

The items array describes each notification configuration for this certificate request through the following properties:

Name	Data Type	Description
notification_type	String	Indicates the type of notification. Valid values are: CertificateRenewal | CertificateExpiring | PendingValidations
emails	Array of string values	Indicates one or more email addresses to which a notification will be sent.
enabled	Boolean	Indicates whether emails for this type of notification will be sent.

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/notifications",
	"@type": "Collection",
	"items": [{
			"notification_type": "CertificateRenewal",
			"emails": [
				"joe@example.com"
			],
			"enabled": true
		}, {
			"notification_type": "CertificateExpiring",
			"emails": [
				"joe@example.com"
			],
			"enabled": true
		}, {
			"notification_type": "PendingValidations",
			"emails": [
				"jane@example.com"
			],
			"enabled": true
		}
	]
}