Get and display email forwarding settings

Retrieve and display email forwarding configuration details for a specific domain. It also returns a 'domain_id' that may be needed to enable forwarding via POST /api/email-forwarding/enable or to verify domain identity.

Domain Services Email

Context

Workflow links

Query Parameters

domain string required · Example: example.com

Headers

Accept Example
Content-Type Example

Responses

200
data object required
data.catchAll object · nullable required

Nullable: may be null when not applicable.

data.catchAll.actionType string required · Example: drop
data.catchAll.destination string · nullable required · Example: null

Nullable: may be null when not applicable.

data.catchAll.enabled boolean required · Example: false
data.catchAll.id string required · Example: 65cce367eaa242f799d43d5dde1446ab
data.catchAll.name string required · Example: Catch-all
data.catchAll.tag string required · Example: catch-all
data.destinations array<object> required · Example: []
data.emailRoutingEnabled boolean required · Example: false
data.error string · Example: Domain not found in Cloudflare

HTTP status title (e.g. 'Bad Request').

data.mxRecords array<object> required · Example: [{"id":29850909,"domain_id":12984,"name":"example.com","type":"MX","content":"example.c...
data.mxRecords[].change_date integer required · Example: 0
data.mxRecords[].content string required · Example: example.com
data.mxRecords[].domain_id integer required · Example: 12984
data.mxRecords[].id integer required · Example: 29850909
data.mxRecords[].name string required · Example: example.com
data.mxRecords[].prio integer required · Example: 1
data.mxRecords[].priority integer required · Example: 1
data.mxRecords[].ttl integer required · Example: 300
data.mxRecords[].type string required · Example: MX
data.rules array<object> required · Example: []
data.settings object
data.settings.admin_locked boolean required · Example: false
data.settings.created string required · Example: 2025-11-12T06:23:26.469349Z
data.settings.enabled boolean required · Example: false
data.settings.errors array<object> · Example: [{"code":"mx.missing","missing":{"name":"example.com","content":"example.com.","type":"...
data.settings.errors[].code string required · Example: mx.missing

Machine-readable error code.

data.settings.errors[].existing object
data.settings.errors[].existing.content string required · Example: example.com.
data.settings.errors[].existing.id string required · Example: f6fab39e836ba64ccaa2db60ff7f6a41
data.settings.errors[].existing.name string required · Example: example.com
data.settings.errors[].existing.priority integer · Example: 1
data.settings.errors[].existing.ttl integer required · Example: 300
data.settings.errors[].existing.type string · enum required · Example: MX
MX
TXT
data.settings.errors[].missing object
data.settings.errors[].missing.content string required · Example: example.com.
data.settings.errors[].missing.name string required · Example: example.com
data.settings.errors[].missing.priority integer · Example: 60
data.settings.errors[].missing.ttl integer required · Example: 1
data.settings.errors[].missing.type string · enum required · Example: MX
MX
TXT
data.settings.id string required · Example: e6c635f3b0699379b026f8917f4c704c
data.settings.modified string required · Example: 2025-11-12T06:23:26.469349Z
data.settings.name string required · Example: example.com
data.settings.skip_wizard boolean required · Example: false
data.settings.status string · enum required · Example: unconfigured
misconfigured
ready
unconfigured
data.settings.support_subaddress boolean required · Example: false
data.settings.synced boolean required · Example: true
data.settings.tag string required · Example: e6c635f3b0699379b026f8917f4c704c
requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

GET https://cloud.hostup.se/api/email-forwarding
For AI assistants
cURL 
curl -X GET "https://cloud.hostup.se/api/email-forwarding?domain=example.com" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response 
{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "emailRoutingEnabled": false,
    "rules": [],
    "destinations": [],
    "catchAll": null,
    "settings": {
      "id": "e6c635f3b0699379b026f8917f4c704c",
      "tag": "e6c635f3b0699379b026f8917f4c704c",
      "name": "example.com",
      "enabled": false,
      "created": "2025-11-12T06:23:26.469349Z",
      "modified": "2025-11-12T06:23:26.469349Z",
      "skip_wizard": false,
      "support_subaddress": false,
      "synced": true,
      "admin_locked": false,
      "status": "unconfigured",
      "errors": [
        {
          "code": "mx.missing",
          "missing": {
            "name": "example.com",
            "content": "example.com.",
            "type": "MX",
            "priority": 60,
            "ttl": 1
          }
        },
        {
          "code": "mx.missing",
          "missing": {
            "name": "example.com",
            "content": "example.com.",
            "type": "MX",
            "priority": 2,
            "ttl": 1
          }
        },
        {
          "_truncated": "... and 3 more items"
        }
      ]
    },
    "mxRecords": []
  }
}