/migrations/discover

POST

/migrations/discover

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

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

source

required

One of:

object

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

object

object

kind

required

string

Allowed values: cpanel

host

required

string

>= 1 characters <= 253 characters

port

integer

default: 2083 >= 1 <= 65535

api

string

default: cpanel

Allowed values: cpanel whm

account

string

>= 1 characters <= 64 characters

imapHost

string

>= 1 characters <= 253 characters

imapPort

integer

default: 993 >= 1 <= 65535

imapSecurity

string

default: tls

Allowed values: tls starttls none

allowInvalidCert

boolean

object

object

kind

required

string

Allowed values: plesk

host

required

string

>= 1 characters <= 253 characters

port

integer

default: 8443 >= 1 <= 65535

domain

string

>= 1 characters <= 253 characters

imapHost

string

>= 1 characters <= 253 characters

imapPort

integer

default: 993 >= 1 <= 65535

imapSecurity

string

default: tls

Allowed values: tls starttls none

allowInvalidCert

boolean

object

object

kind

required

string

Allowed values: google

domain

required

string

>= 1 characters <= 253 characters

adminEmail

required

string

>= 3 characters <= 320 characters

imapHost

string

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

imapPort

integer

default: 993 >= 1 <= 65535

readGmailSettings

boolean

default: true

includeGroups

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

string

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

imapPort

integer

default: 993 >= 1 <= 65535

readMailboxSettings

boolean

default: true

includeGroups

boolean

default: true

secret

required

One of:

object

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

object

object

kind

required

string

Allowed values: cpanel

username

required

string

>= 1 characters <= 64 characters

apiToken

required

string

>= 1 characters <= 1024 characters

adminUser

string

>= 1 characters <= 320 characters

adminPassword

string

>= 1 characters <= 1024 characters

adminSeparator

string

default: * >= 1 characters <= 1 characters

object

object

kind

required

string

Allowed values: plesk

apiKey

string

>= 1 characters <= 1024 characters

username

string

>= 1 characters <= 64 characters

password

string

>= 1 characters <= 1024 characters

adminUser

string

>= 1 characters <= 320 characters

adminPassword

string

>= 1 characters <= 1024 characters

adminSeparator

string

default: * >= 1 characters <= 1 characters

object

object

kind

required

string

Allowed values: google

clientEmail

required

string

>= 3 characters <= 320 characters

privateKey

required

string

>= 1 characters <= 8192 characters

object

object

kind

required

string

Allowed values: m365

clientId

required

string

>= 1 characters <= 200 characters

clientSecret

required

string

>= 1 characters <= 2048 characters

probe

string

probePassword

string

Responses

200

Default Response

Media typeapplication/json

object

mailboxes

required

Array<object>

object

address

required

string

sizeBytes

required

Any of:

integer

integer

<= 9007199254740991

null

null

quotaBytes

required

Any of:

integer

integer

<= 9007199254740991

null

null

suspended

required

boolean

suggestedTargetMailboxId

required

Any of:

string

string

null

null

suggestedTargetAddress

required

Any of:

string

string

null

null

forwarders

required

Array<object>

object

source

required

string

destination

required

string

autoresponders

required

Array<object>

object

address

required

string

subject

required

string

startsAt

required

Any of:

string

string

null

null

endsAt

required

Any of:

string

string

null

null

active

required

boolean

filters

required

Array<object>

object

address

required

string

name

required

string

supported

required

boolean

note

required

Any of:

string

string

null

null

domains

required

Array<string>

warnings

required

Array<string>

usedAdminCredential

required

boolean

probe

required

Any of:

object

object

ok

required

boolean

login

required

boolean

folders

required

Array<string>

code

required

Any of:

string

string

null

null

detail

required

Any of:

string

string

null

null

null

null

Example^generated

{
  "mailboxes": [
    {
      "address": "example",
      "sizeBytes": 1,
      "quotaBytes": 1,
      "suspended": true,
      "suggestedTargetMailboxId": "example",
      "suggestedTargetAddress": "example"
    }
  ],
  "forwarders": [
    {
      "source": "example",
      "destination": "example"
    }
  ],
  "autoresponders": [
    {
      "address": "example",
      "subject": "example",
      "startsAt": "example",
      "endsAt": "example",
      "active": true
    }
  ],
  "filters": [
    {
      "address": "example",
      "name": "example",
      "supported": true,
      "note": "example"
    }
  ],
  "domains": [
    "example"
  ],
  "warnings": [
    "example"
  ],
  "usedAdminCredential": true,
  "probe": {
    "ok": true,
    "login": true,
    "folders": [
      "example"
    ],
    "code": "example",
    "detail": "example"
  }
}