Get all domains

Fetch all domains including verified and pending verification

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

Response parameters

Parameter Type Description
domains list List of verified domains
domains_pending_verification list List of domains pending verification
domain str Domain name
expire_time int Expire time for domain verification as UNIX timestamp (seconds)
verification_code str Verification code

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/domains/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)

{'domains': ['vonmail.com'],
 'domains_pending_verification': [{'domain': 'test1.vonmail.com',
                                   'expire_time': 1583548002,
                                   'verification_code': 'nms-domain-verification=173121280786'}]}