Get auto migration details¶
Fetch all domains setup for automatic migration
- HTTP Method:
GET
- URL:
https://example.domain.tld/api/v1/automigration/setup/
- Require authentication:
Yes
- Permission level required:
MasterAdmin
/DomainAdmin
Response parameters¶
Parameter | Type | Description |
---|---|---|
automigration_setup | list | List of all domains setup for automatic migration |
added_by | str | Admin username who created auto migration for domain |
domain | str | Domain name setup for auto migration |
imap_serverhost | str | Source (old) IMAP server hostname |
imap_serverport | int | Source (old) IMAP server port |
imap_session | str | IMAP session (ssl or plain ) to use |
Example request (Python)¶
import requests
import json
from pprint import pprint
url = "https://example.domain.tld/api/v1/automigration/setup/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
pprint(r.json())
except:
print(r.text)
Example response (JSON)¶
{'automigration_setup': [{'added_by': 'pavinj',
'domain': 'cheapmailhosting.com',
'imap_serverhost': 'mail2.mymailcheap.com',
'imap_serverport': 993,
'imap_session': 'ssl'},
{'added_by': 'admin',
'domain': 'vonmail.com',
'imap_serverhost': 'mail3.mymailcheap.com',
'imap_serverport': 993,
'imap_session': 'ssl'}]}