Smtp

Update the SMTP settings used by the Octopus Server.

put/smtpconfiguration

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/smtpconfiguration
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Request body

EnableSslboolean
SendEmailFromstring
SmtpHoststring
SmtpPortinteger
Timeoutinteger

Response

Confirmation that SMTP Configuration was modified, containing the new configuration

EnableSslboolean
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

SendEmailFromstring
SmtpHoststring
SmtpPortnumber
Timeoutinteger

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.