Skip to content
MailDock Docs

/server/config/history

GET
/server/config/history
curl --request GET \
  --url https://example.com/api/v1/server/config/history \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
Array<object>
object
version
required
integer
>= -9007199254740991 <= 9007199254740991
config
required
object
hostname
required
string
tls
required
object
mode
required
string
Allowed values: acme byo none
acmeEmail
string
limits
required
object
messageSizeBytes
required
integer
default: 52428800 >= 1048576 <= 1073741824
perUserMessagesPerHour
required
integer
default: 500 <= 9007199254740991
perDomainMessagesPerHour
required
integer
default: 2000 <= 9007199254740991
smtpdClientConnectionRateLimit
required
integer
default: 60 <= 9007199254740991
relay
required
Any of:
object
host
required
string
port
required
integer
default: 587 >= 1 <= 65535
username
required
string
>= 1 characters
password
string
>= 1 characters
passwordUnreadable
boolean
spf
required
Any of:
string
protocols
required
object
pop3
required
boolean
default: true
spam
required
object
rejectScore
required
number
default: 15
addHeaderScore
required
number
default: 6
greylistScore
required
number
default: 4
mtaSts
required
object
mode
required
string
default: testing
Allowed values: none testing enforce
maxAgeSeconds
required
integer
default: 604800 >= 86400 <= 31557600
warmup
required
object
enabled
required
boolean
startedAt
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
targetPerHour
required
integer
default: 2000 >= 10 <= 9007199254740991
abuse
required
object
enabled
required
boolean
default: true
windowMinutes
required
integer
default: 60 >= 5 <= 1440
minMessages
required
integer
default: 20 >= 5 <= 9007199254740991
reputationRatio
required
number
default: 0.3 >= 0.01 <= 1
hardBounceRatio
required
number
default: 0.6 >= 0.01 <= 1
autoBlock
required
boolean
burstAlert
required
object
enabled
required
boolean
default: true
windowMinutes
required
integer
default: 60 >= 5 <= 1440
minEvents
required
integer
default: 10 >= 1 <= 9007199254740991
authLimits
required
object
enabled
required
boolean
default: true
windowMinutes
required
integer
default: 15 >= 1 <= 1440
passwordAttempts
required
integer
default: 10 >= 1 <= 1000
ipAttempts
required
integer
default: 50 >= 1 <= 10000
totpAttempts
required
integer
default: 5 >= 1 <= 100
banMinutes
required
integer
default: 60 >= 1 <= 43200
trustedNetworks
required
Array<string>
default:
outboundIpv6
required
boolean
status
required
string
Allowed values: pending applied failed rolled_back
message
required
Any of:
string
createdBy
required
Any of:
string
renderedBy
required
Any of:
string
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
Example
[
  {
    "config": {
      "tls": {
        "mode": "acme"
      },
      "limits": {
        "messageSizeBytes": 52428800,
        "perUserMessagesPerHour": 500,
        "perDomainMessagesPerHour": 2000,
        "smtpdClientConnectionRateLimit": 60
      },
      "relay": null,
      "protocols": {
        "pop3": true
      },
      "spam": {
        "rejectScore": 15,
        "addHeaderScore": 6,
        "greylistScore": 4
      },
      "mtaSts": {
        "mode": "testing",
        "maxAgeSeconds": 604800
      },
      "warmup": {
        "enabled": false,
        "targetPerHour": 2000
      },
      "abuse": {
        "enabled": true,
        "windowMinutes": 60,
        "minMessages": 20,
        "reputationRatio": 0.3,
        "hardBounceRatio": 0.6,
        "autoBlock": false
      },
      "burstAlert": {
        "enabled": true,
        "windowMinutes": 60,
        "minEvents": 10
      },
      "authLimits": {
        "enabled": true,
        "windowMinutes": 15,
        "passwordAttempts": 10,
        "ipAttempts": 50,
        "totpAttempts": 5,
        "banMinutes": 60
      },
      "trustedNetworks": [],
      "outboundIpv6": false
    },
    "status": "pending"
  }
]