Lets Encrypt Settings

Get

Retrieve the Let's Encrypt settings.

GET/api/LetsEncryptSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

termsAcceptedboolean

Whether Let's Encrypt Terms are accepted.

expirationEmailsnullable array of string

The list of email addresses where expiration emails will be sent.

autoRenewCertBeforeExpirationDaysinteger (int32)

The amount of days before expiration for automatic renewal to take place.

replicateboolean

Whether Replicate is enabled.

Request

JavaScriptCurlPython

const response = await fetch('/api/LetsEncryptSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "termsAccepted": false,
  "expirationEmails": [
    "text"
  ],
  "autoRenewCertBeforeExpirationDays": 0,
  "replicate": false
}

Update

Modify the Let's Encrypt settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/LetsEncryptSettings

Query parameters

Body

application/json; api-version=1.0

Let's Encrypt settings

termsAcceptednullable boolean

Whether Let's Encrypt Terms are accepted.

expirationEmailsnullable array of string

The list of email addresses where expiration emails will be sent.

autoRenewCertBeforeExpirationDaysnullable integer (int32)

The amount of days before expiration for automatic renewal to take place. Accepted values: 1-60 days; 0 for 'Never'.

replicatenullable boolean

>Whether Replicate is enabled.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/LetsEncryptSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}