Skip to content

Latest commit

 

History

History
69 lines (55 loc) · 2.65 KB

deliveryservices_sslkeys_generate_acme.rst

File metadata and controls

69 lines (55 loc) · 2.65 KB
Raw

deliveryservices/sslkeys/generate/acme

POST

Generates an SSL certificate and private key using :abbr:`ACME (Automatic Certificate Management Environment)` protocol for a :term:`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 :abbr:`ACME (Automatic Certificate Management Environment)` account in :ref:`cdn.conf` or Let's Encrypt.
key:

The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated [1]
deliveryservice:

The :ref:`ds-xmlid` of the :term:`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 :term:`Delivery Service`

Note

In most cases, this must be the same as the :ref:`ds-example-urls`.
cdn:

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

 
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.ott.kabletown.com",
        "cdn":"test-cdn"
}

Response Structure

{ "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"
}]}
[1](1, 2) Either the key or the deliveryservice field must be provided. If both are provided, then they must match.