deliveryservices/sslkeys/generate/acme

POST

Generates an SSL certificate and private key using ACME protocol for a Delivery Service

Auth. Required:

Yes

Roles Required:

“admin” or “operations”

Permissions Required:

DS-SECURITY-KEY:UPDATE, ACME:READ, DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE

Response Type:

Object (string)

Request Structure

authType:

The certificate provider correlating to an ACME account in cdn.conf or Let’s Encrypt.

key:

The xml_id of the Delivery Service for which keys will be generated [1]

deliveryservice:

The xml_id of the Delivery Service for which keys will be generated [1]

version:

An integer that defines the “version” of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key

hostname:

The desired hostname of the Delivery Service

Note

In most cases, this must be the same as the Example URLs.

cdn:

The name of the CDN of the Delivery Service for which the certs will be generated

#1255 Request Example
POST /api/5.0/deliveryservices/sslkeys/generate/acme HTTP/1.1
Content-Type: application/json

{
    "authType": "Lets Encrypt",
    "key": "ds-01",
    "deliveryservice": "ds-01",
    "version": "3",
    "hostname": "tr.ds-01.mycdn.ciab.test",
    "cdn":"test-cdn"
}

Response Structure

#1256 Response Example
{ "alerts": [{
    "level": "success",
    "text": "Beginning async ACME call for demo1 using Lets Encrypt. This may take a few minutes. Status updates can be found here: /api/5.0/async_status/1"
}]}