Return to Homepage

Get Domain Details

http
GET /cranemail/domains/{domain}

Includes the DNS records the domain needs and the TXT record that verifies it.

Response

json
{
  "domain": "example.com",
  "service_id": 12,
  "status": "active",
  "verified": true,
  "disk_limit": 10,
  "disk_usage": 2450.5,
  "user_limit": 50,
  "user_count": 12,
  "user_alias_limit": 100,
  "user_alias_count": 5,
  "domain_alias_limit": 10,
  "domain_alias_count": 1,
  "hostname": "mail.example.com",
  "split_domain": null,
  "mxfilter_enabled": true,
  "mxfilter_admin_access": "primary",
  "archive_years": 0,
  "archive_direction": "disabled",
  "file_storage": true,
  "office": false,
  "webmail_sso": true,
  "mxfilter_sso": true,
  "verification": { "host": "craneverify.example.com", "value": "550e8400-e29b-41d4-a716-446655440000" },
  "dns_records": [
    { "name": "@", "type": "MX", "content": "10 mx1.mxfilter.net.", "ttl": 3600 },
    { "name": "mail", "type": "CNAME", "content": "us1.workspace.org.", "ttl": 3600 },
    { "name": "dkim._domainkey", "type": "TXT", "content": "v=DKIM1;k=rsa;h=sha256;p=MIIB...", "ttl": 3600 }
  ],
  "spf_include": "include:_spf.workspace.org"
}

Statuses: pending (waiting for verification), active, suspended (the service is suspended), client_suspended (suspended through this API), admin_suspended (suspended by staff).

On this page

Snagged on something?

Our sysadmins answer tickets around the clock.