Let’s Encrypt Request Certificate¶

Overview¶

You can use the Let’s Encrypt Request Certificate API to request a signed certificate by proving the certificate signing request (CSR).

REST Endpoint: /mgmt/cm/adc-core/external-ca/lets-encrypt/csr-request¶

Requests¶

POST /mgmt/cm/adc-core/external-ca/lets-encrypt/csr-request¶

To request a signed certificate, send a POST to the endpoint.

Request Parameters¶

Name	Type	Required	Description
certificateName	string	True	Name of the certificate
domainName	string	True	Name of the domain
externalCaConfigReference	object	True	Link to the CA configuration
link	string	True	URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API.

Query Parameters¶

None

Response¶

The JSON in the POST’s response can include the following parameters.

HTTP/1.1 200 OK

Name	Type	Required
externalCaConfigReference	object	Link to the CA configuration
link	string	URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API.
domainName	string	Name of the domain
certificateName	string	Name of the certificate
keySize	number	Size of the key
keyType	string	Type of cryptography key
userReference	object	link
link	string	URL for the user
identityReferences	object	List of links for user identities
link	string	URL for a user identity
selfLink	string	URL for the CSR request

Permissions¶

Role	Allow
admin	Yes
Certificate Editor/Viewer	Yes

Examples¶

POST to request a signed certificate¶

Following is an example of a POST to request a signed certificate by proving the CSR

POST https://<BIG-IQ>/mgmt/cm/adc-core/external-ca/lets-encrypt/csr-request

Using POST we can request a signed certificate by proving the CSR

{
    "certificateName": "le_cert",
    "domainName": "letsencrypt.example1.de",
    "externalCaConfigReference": {
            "link": "https://localhost/mgmt/cm/adc-core/external-ca/config/5194e771-18d1-377d-8706-1d3102ebb312"
    }
}

Response¶

HTTP/1.1 200 OK

{
    "externalCaConfigReference": {
            "link": "https://localhost/mgmt/cm/adc-core/external-ca/config/5194e771-18d1-377d-8706-1d3102ebb312"
    },
    "domainName": "letsencrypt.example1.de",
    "certificateName": "le_cert",
    "keySize": 2048,
    "keyType": "RSA",
    "id": "9fcbd977-1714-4924-8623-3ba697504648",
    "status": "STARTED",
    "userReference": {
            "link": "https://localhost/mgmt/shared/authz/users/admin"
    },
    "identityReferences": [{
            "link": "https://localhost/mgmt/shared/authz/users/admin"
    }],
    "ownerMachineId": "9feafafd-a910-4a71-93d5-c074cd8f1a7a",
    "taskWorkerGeneration": 1,
    "generation": 1,
    "lastUpdateMicros": 1567672177044642,
    "kind": "cm:adc-core:external-ca:lets-encrypt:csr-request:letsencryptcertrequesttaskstate",
    "selfLink": "https://localhost/mgmt/cm/adc-core/external-ca/lets-encrypt/csr-request/9fcbd977-1714-4924-8623-3ba697504648"
}

Previous Next