Get all relay domains¶

Fetch all relay domains including verified and pending verification

• HTTP Method: GET
• URL: https://example.domain.tld/api/v1/relaydomains/
• Require authentication: Yes
• Permission level required: MasterAdmin / DomainAdmin

Response parameters¶

Parameter	Type	Description
relay_domains	list	List of verified relay domains
relay_domains_pending_verification	list	List of relay domains pending verification
destination_hostname	str	Destination hostname
destination_port	int	Destination port
expire_time	int	Expire time for domain verification as UNIX timestamp (seconds)
relay_domain	str	Relay 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/relaydomains/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)¶

{'relay_domains': [],
 'relay_domains_pending_verification': [{'destination_hostname': 'mail3.mymailcheap.com',
                                         'destination_port': 25,
                                         'expire_time': 1583667188,
                                         'relay_domain': 'test.vonmail.com',
                                         'verification_code': 'nms-domain-verification=797147642125'}]}