/migrations/{id}/run

POST

/migrations/{id}/run

curl --request POST \
  --url https://example.com/api/v1/migrations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mailboxIds": [] }'

Authorizations

• bearer

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

Media typeapplication/json

object

mailboxIds

Array<string>

default:

Responses

200

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

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

object

object

kind

required

string

Allowed values: cpanel

host

required

string

>= 1 characters <= 253 characters

port

required

integer

default: 2083 >= 1 <= 65535

api

required

string

default: cpanel

Allowed values: cpanel whm

account

string

>= 1 characters <= 64 characters

imapHost

string

>= 1 characters <= 253 characters

imapPort

required

integer

default: 993 >= 1 <= 65535

imapSecurity

required

string

default: tls

Allowed values: tls starttls none

allowInvalidCert

required

boolean

object

object

kind

required

string

Allowed values: plesk

host

required

string

>= 1 characters <= 253 characters

port

required

integer

default: 8443 >= 1 <= 65535

domain

string

>= 1 characters <= 253 characters

imapHost

string

>= 1 characters <= 253 characters

imapPort

required

integer

default: 993 >= 1 <= 65535

imapSecurity

required

string

default: tls

Allowed values: tls starttls none

allowInvalidCert

required

boolean

object

object

kind

required

string

Allowed values: google

domain

required

string

>= 1 characters <= 253 characters

adminEmail

required

string

>= 3 characters <= 320 characters

imapHost

required

string

default: imap.gmail.com >= 1 characters <= 253 characters

imapPort

required

integer

default: 993 >= 1 <= 65535

readGmailSettings

required

boolean

default: true

includeGroups

required

boolean

default: true

object

object

kind

required

string

Allowed values: m365

tenantId

required

string

>= 1 characters <= 253 characters

domain

string

>= 1 characters <= 253 characters

imapHost

required

string

default: outlook.office365.com >= 1 characters <= 253 characters

imapPort

required

integer

default: 993 >= 1 <= 65535

readMailboxSettings

required

boolean

default: true

includeGroups

required

boolean

default: true

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

string

Allowed values: auth connection tls quota rate_limited folder source_missing target_missing cancelled unknown

null

null

errorDetail

required

Any of:

string

string

null

null

hasSecret

required

boolean

cutover

required

Array<string>

Allowed values: lower_ttl initial_sync verify_counts switch_mx final_delta

startedAt

required

Any of:

string

string

null

null

finishedAt

required

Any of:

string

string

null

null

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"
  ]
}