/migrations (GET)

GET

/migrations

const url = 'https://example.com/api/v1/migrations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

bearer

Responses

200

Default Response

application/json

Array<object>

object

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
null

string

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

errorDetail

required

Any of:

string
null

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
null

string

finishedAt

required

Any of:

string
null

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