Get domain email forwarding

Read full description Hide full description

Return domain-level email forwarding state for one domain. Get {id} from GET /api/v2/domains data[].id. Use this domain-level surface when there is no shared-hosting account for the domain, or the domain is not attached to a shared-hosting account. If GET /api/v2/shared-hosting/{accountId}/domains shows the domain belongs to a hosting account, prefer the shared-hosting email-forwarder routes so existing hosting mailboxes and forwarders keep working. integrationStatus is the source of truth: enabled means rules can be used, disabled means routing can be enabled with PATCH, and unavailable means the domain/integration is not eligible. existingMxRecords is populated when forwarding is disabled or unavailable so callers can explain MX conflicts.

Domains & DNS Email Forwarding

Authentication

Required API scopes: read:dnsread:domains

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

PATCH /api/v2/domains/{id}/email-forwarding Toggle domain email forwarding POST /api/v2/domains/{id}/email-forwarding Create domain email forwarding rule PUT /api/v2/domains/{id}/email-forwarding Update domain email catch-all

Path Parameters

id string required Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID from `GET /api/v2/domains` `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Accept Example

Content-Type Example

Responses

200 Domain email forwarding state.

enabled boolean · Example: true

integrationStatus string · enum · Example: enabled

enabled

disabled

unavailable

reason stringnull · Example: null

maxRules integer · Example: 200

ruleCount integer · Example: 1

rules array<object>

rules[].id string required · Example: ef_01hxa3b4c5d6e7f8g9h0j1k2m3

rules[].email string required · Example: [email protected]

rules[].destination string required · Example: [email protected]

rules[].isEnabled boolean required · Example: true

rules[].name stringnull required · Example: null

rules[].priority integer required · Example: 0

destinations array<object>

destinations[].id string required · Example: efd_01hxa3b4c5d6e7f8g9h0j1k2m3

destinations[].email string required · Example: [email protected]

destinations[].verificationStatus string · enum required · Example: verified

verified

pending

unverified

destinations[].createdAt stringnull required · Example: 2026-04-27T12:00:00.000Z

destinations[].verifiedAt stringnull required · Example: 2026-04-27T12:05:00.000Z

catchAll object | null · Example: {"action":"disabled","destination":null}

catchAll.action string · enum required · Example: disabled

forward

drop

disabled

catchAll.destination stringnull required · Example: null

existingMxRecords array<object>

existingMxRecords[].type string · enum required · Example: MX

MX

existingMxRecords[].value string required · Example: mail.example.com

existingMxRecords[].priority integernull required · Example: 10

actions object

actions.canCreateNewRule object required

actions.canCreateNewRule.allowed boolean required · Example: true

actions.canCreateNewRule.reason stringnull required · Example: null

actions.canCreateNewRule.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

actions.canSetCatchAll object required

actions.canSetCatchAll.allowed boolean required · Example: true

actions.canSetCatchAll.reason stringnull required · Example: null

actions.canSetCatchAll.code stringnull · Example: pending_order

Machine-readable reason code when an action is blocked.

400 Invalid request. The response body is an RFC 7807 Problem Details document.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the resource.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Not found. The resource does not exist or is not owned by the caller.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

GET https://cloud.hostup.se/api/v2/domains/{id}/email-forwarding

For AI assistants

View as Markdown

cURL

curl -X GET "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/email-forwarding" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "enabled": false,
  "integrationStatus": "disabled",
  "reason": "Email forwarding is not enabled for this domain. Enable it to start receiving rules.",
  "maxRules": 200,
  "ruleCount": 0,
  "rules": [],
  "destinations": [],
  "catchAll": null,
  "existingMxRecords": [
    {
      "type": "MX",
      "value": "mail.example.com",
      "priority": 10
    }
  ],
  "actions": {
    "canCreateNewRule": {
      "allowed": false,
      "reason": "Email forwarding is not enabled for this domain. Enable it to start receiving rules."
    },
    "canSetCatchAll": {
      "allowed": false,
      "reason": "Email forwarding is not enabled for this domain. Enable it to start receiving rules."
    }
  }
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "integrationStatus": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled",
        "unavailable"
      ]
    },
    "reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "maxRules": {
      "type": "integer"
    },
    "ruleCount": {
      "type": "integer"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "destination": {
            "type": "string"
          },
          "isEnabled": {
            "type": "boolean"
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "priority": {
            "type": "integer"
          }
        }
      }
    },
    "destinations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "verificationStatus": {
            "type": "string",
            "enum": [
              "verified",
              "pending",
              "unverified"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "verifiedAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    },
    "catchAll": {
      "type": "object | null",
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "forward",
            "drop",
            "disabled"
          ]
        },
        "destination": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "existingMxRecords": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "MX"
            ]
          },
          "value": {
            "type": "string"
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ]
          }
        }
      }
    },
    "actions": {
      "type": "object",
      "properties": {
        "canCreateNewRule": {
          "type": "object",
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "reason": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ],
              "description": "Machine-readable reason code when an action is blocked."
            }
          }
        },
        "canSetCatchAll": {
          "type": "object",
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "reason": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ],
              "description": "Machine-readable reason code when an action is blocked."
            }
          }
        }
      }
    }
  }
}