Let’s Encrypt Authenticate¶

Overview¶

You can use the Let’s Encrypt Authenticate API to authenticate for a domain.

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

Requests¶

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

Using POST we can authenticate for a domain.

Request Parameters¶

Name	Type	Required	Description
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.
authenticationUrl	string	True	Let’s Encrypt authentication URL
forceValidate	boolean	True	True means validate
checkOnlyStatus	boolean	True	True means check status only

Query Parameters¶

None

Response¶

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

HTTP/1.1 200 OK

Name	Type	Description
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.
authenticationUrl	string	URL
forceValidate	boolean	True means validate
checkOnlyStatus	boolean	True means check status only

Permissions¶

Role	Allow
admin	Yes
Certificate Editor/Viewer	No

Examples¶

POST to authenticate¶

The following is an example of a POST to authenticatefor a domain.

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

The JSON in the body of the request can look similar to the following.

{
    "externalCaConfigReference": {
            "link": "https://localhost/mgmt/cm/adc-core/external-ca/config/5194e771-18d1-377d-8706-1d3102ebb312"
    },
    "authenticationUrl": "https://acme-v02.api.letsencrypt.org/acme/authz-v3/1899037193",
    "forceValidate": false,
    "checkOnlyStatus": false,
    "status": "valid",
    "generation": 0,
    "lastUpdateMicros": 0
}

Response¶

HTTP/1.1 200 OK

The JSON in the body of the response can look similar to the following.

{
    "externalCaConfigReference": {
            "link": "https://localhost/mgmt/cm/adc-core/external-ca/config/5194e771-18d1-377d-8706-1d3102ebb312"
    },
    "authenticationUrl": "https://acme-v02.api.letsencrypt.org/acme/authz-v3/1899037193",
    "forceValidate": false,
    "checkOnlyStatus": false,
    "status": "valid",
    "generation": 0,
    "lastUpdateMicros": 0
}

Previous Next