Get all domain aliases¶
Fetch all domain aliases including verified and pending verification
- HTTP Method:
GET
- URL:
https://example.domain.tld/api/v1/domainaliases/
- Require authentication:
Yes
- Permission level required:
MasterAdmin
/DomainAdmin
Response parameters¶
Parameter | Type | Description |
---|---|---|
domain_aliases | list | List of verified domain aliases |
domain_aliases_pending_verification | list | List of domain aliases pending verification |
domain_alias | str | Domain alias name |
expire_time | int | Expire time for domain verification as UNIX timestamp (seconds) |
rcpt_domain | str | Recipient domain name |
verification_code | str | Verification code |
Example request (Python)¶
import requests
import json
from pprint import pprint
url = "https://example.domain.tld/api/v1/domainaliases/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
pprint(r.json())
except:
print(r.text)
Example response (JSON)¶
{'domain_aliases': [],
'domain_aliases_pending_verification': [{'domain_alias': 'test.vonmail.com',
'expire_time': 1583665895,
'rcpt_domain': 'vonmail.com',
'verification_code': 'nms-domain-verification=955742751907'}]}