ProductsSupportPartnersDocumentation

Lets Encrypt Settings

Get

get

Retrieve the Let's Encrypt settings.

Query parameters
SiteIdinteger · int32Optional

Site ID for which to retrieve Let's Encrypt settings (optional)

Responses
200
Success
application/json; api-version=1.0
get
GET /api/LetsEncryptSettings HTTP/1.1
Host: 
Accept: */*

{
  "termsAccepted": true,
  "expirationEmails": [
    "text"
  ],
  "autoRenewCertBeforeExpirationDays": 1,
  "replicate": true
}

Update

put

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.

Query parameters
SiteIdinteger · int32Optional

Site ID for which to update the Let's Encrypt settings (optional)

Body

Update the Let's Encrypt settings

termsAcceptedboolean | nullableOptional

Whether Let's Encrypt Terms are accepted.

expirationEmailsstring[] | nullableOptional

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

autoRenewCertBeforeExpirationDaysinteger · int32 | nullableOptional

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

replicateboolean | nullableOptional

>Whether Replicate is enabled.

Responses
204
No Content
put
PUT /api/LetsEncryptSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 105

{
  "termsAccepted": true,
  "expirationEmails": [
    "text"
  ],
  "autoRenewCertBeforeExpirationDays": 1,
  "replicate": true
}
No content
PreviousUpdate IntermediateNextEULA

Was this helpful?