Get email forwarding settings for a domain

Retrieve the current email forwarding configuration for a specific domain. It returns information about active rules and destinations, and an ID that may be needed for subsequent calls related to email configuration.

Query Parameters

domain string required

Headers

Accept Example

Content-Type Example

Responses

200

success boolean

timestamp string

requestId string

data object

GET https://cloud.hostup.se/api/email-forwarding

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/email-forwarding?domain=string" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "emailRoutingEnabled": true,
    "rules": [
      "string"
    ],
    "destinations": [
      "string"
    ],
    "catchAll": "string",
    "settings": {
      "id": "string",
      "tag": "string",
      "name": "string",
      "enabled": true,
      "created": "string",
      "modified": "string",
      "skip_wizard": true,
      "support_subaddress": true,
      "synced": true,
      "admin_locked": true,
      "status": "string",
      "errors": [
        {
          "code": "string",
          "existing": {
            "id": "string",
            "name": "string",
            "content": "string",
            "type": "string",
            "priority": 0,
            "ttl": 0
          }
        }
      ]
    },
    "mxRecords": [
      {
        "id": 0,
        "domain_id": 0,
        "name": "string",
        "type": "string",
        "content": "string",
        "ttl": 0,
        "prio": 0,
        "change_date": 0,
        "priority": 0
      }
    ]
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "emailRoutingEnabled": {
          "type": "boolean"
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "destinations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "catchAll": {
          "type": "string",
          "nullable": true
        },
        "settings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "tag": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            },
            "created": {
              "type": "string"
            },
            "modified": {
              "type": "string"
            },
            "skip_wizard": {
              "type": "boolean"
            },
            "support_subaddress": {
              "type": "boolean"
            },
            "synced": {
              "type": "boolean"
            },
            "admin_locked": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "errors": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "existing": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "content": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "priority": {
                        "type": "integer"
                      },
                      "ttl": {
                        "type": "integer"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "mxRecords": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "domain_id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "content": {
                "type": "string"
              },
              "ttl": {
                "type": "integer"
              },
              "prio": {
                "type": "integer"
              },
              "change_date": {
                "type": "integer"
              },
              "priority": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}