Lets Encrypt

To configure the Let’s Encrypt integration, see https://octopus.com/docs/security/exposing-octopus/lets-encrypt-integration

Request the current Let’s Encrypt configuration

GET /api/letsencryptconfiguration

Response

200 — The current Let’s Encrypt configuration for this Octopus Server

AcceptLetsEncryptTermsOfService boolean
CertificateExpiryDate string
Format date-time.
CertificateThumbprint string
DnsName string
Enabled boolean
HttpsPort integer
IPAddress string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Path string
RegistrationEmailAddress string

{
  "AcceptLetsEncryptTermsOfService": false,
  "CertificateExpiryDate": "2020-01-01T00:00:00.000Z",
  "CertificateThumbprint": "string",
  "DnsName": "string",
  "Enabled": false,
  "HttpsPort": 0,
  "IPAddress": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "Self": "/api/..."
  },
  "Path": "string",
  "RegistrationEmailAddress": "string"
}

Disable Let’s Encrypt

PUT /api/letsencryptconfiguration

To re-enable Let’s Encrypt you must go through the configuration process again.

If the integration is enabled, set Enabled: false to disable it.

If you set Enabled: true when it is already enabled, or Enabled: false when it is already disabled, no changes occur.

If you set Enabled: true when the integration is disabled, an error is returned.

Request Body

Enabled boolean (required)

Response

200 — The updated configuration

AcceptLetsEncryptTermsOfService boolean
CertificateExpiryDate string
Format date-time.
CertificateThumbprint string
DnsName string
Enabled boolean
HttpsPort integer
IPAddress string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Path string
RegistrationEmailAddress string

{
  "Enabled": false
}

{
  "AcceptLetsEncryptTermsOfService": false,
  "CertificateExpiryDate": "2020-01-01T00:00:00.000Z",
  "CertificateThumbprint": "string",
  "DnsName": "string",
  "Enabled": false,
  "HttpsPort": 0,
  "IPAddress": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "Self": "/api/..."
  },
  "Path": "string",
  "RegistrationEmailAddress": "string"
}