Skip to content
MailDock Docs

/migrations (POST)

POST
/migrations
curl --request POST \
  --url https://example.com/api/v1/migrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "source": { "kind": "imap", "host": "example", "port": 993, "security": "tls", "allowInvalidCert": false }, "secret": { "kind": "imap", "adminUser": "example", "adminPassword": "example", "adminSeparator": "*" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
source
required
One of:
object
kind
required
string
Allowed values: imap
host
required
string
>= 1 characters <= 253 characters
port
integer
default: 993 >= 1 <= 65535
security
string
default: tls
Allowed values: tls starttls none
allowInvalidCert
boolean
secret
required
One of:
object
kind
required
string
Allowed values: imap
adminUser
string
>= 1 characters <= 320 characters
adminPassword
string
>= 1 characters <= 1024 characters
adminSeparator
string
default: * >= 1 characters <= 1 characters

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
id
required
string
name
required
string
kind
required
string
Allowed values: imap cpanel plesk google m365
source
required
One of:
object
kind
required
string
Allowed values: imap
host
required
string
>= 1 characters <= 253 characters
port
required
integer
default: 993 >= 1 <= 65535
security
required
string
default: tls
Allowed values: tls starttls none
allowInvalidCert
required
boolean
state
required
string
Allowed values: draft discovering ready running paused done failed cancelled
progress
required
object
foldersTotal
required
integer
<= 9007199254740991
foldersDone
required
integer
<= 9007199254740991
messagesTotal
required
integer
<= 9007199254740991
messagesDone
required
integer
<= 9007199254740991
messagesSkipped
required
integer
<= 9007199254740991
bytesDone
required
integer
<= 9007199254740991
mailboxCount
required
integer
<= 9007199254740991
mailboxesDone
required
integer
<= 9007199254740991
mailboxesFailed
required
integer
<= 9007199254740991
errorCode
required
Any of:
string
Allowed values: auth connection tls quota rate_limited folder source_missing target_missing cancelled unknown
errorDetail
required
Any of:
string
hasSecret
required
boolean
cutover
required
Array<string>
Allowed values: lower_ttl initial_sync verify_counts switch_mx final_delta
startedAt
required
Any of:
string
finishedAt
required
Any of:
string
createdAt
required
string
updatedAt
required
string
Example
{
  "kind": "imap",
  "source": {
    "kind": "imap",
    "port": 993,
    "security": "tls",
    "allowInvalidCert": false
  },
  "state": "draft",
  "errorCode": "auth",
  "cutover": [
    "lower_ttl"
  ]
}