Skip to content
MailDock Docs

/migrations/{id}/discover

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “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 Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
probe
string
probePassword
string

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
mailboxes
required
Array<object>
object
address
required
string
sizeBytes
required
Any of:
integer
<= 9007199254740991
quotaBytes
required
Any of:
integer
<= 9007199254740991
suspended
required
boolean
suggestedTargetMailboxId
required
Any of:
string
suggestedTargetAddress
required
Any of:
string
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
endsAt
required
Any of:
string
active
required
boolean
filters
required
Array<object>
object
address
required
string
name
required
string
supported
required
boolean
note
required
Any of:
string
domains
required
Array<string>
warnings
required
Array<string>
usedAdminCredential
required
boolean
probe
required
Any of:
object
ok
required
boolean
login
required
boolean
folders
required
Array<string>
code
required
Any of:
string
detail
required
Any of:
string
Examplegenerated
{
  "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"
  }
}