Create a new email endpoint for your hosting

Create a new email endpoint linked to your hosting account. A unique ID is returned, required for referencing this email endpoint in subsequent API calls.

Headers

Accept Example

Content-Type Example

Body

required

application/json

name string required

email string required

scope string · enum required

all

vm_monitor

Responses

200

success boolean

timestamp string

requestId string

data object

POST https://cloud.hostup.se/api/email-endpoints

For AI assistants

cURL

curl -X POST "https://cloud.hostup.se/api/email-endpoints" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "email": "string",
    "scope": "all"
  }'

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "email_endpoint": {
      "id": 0,
      "client_id": "string",
      "channel_type": "string",
      "scope": "string",
      "monitor_id": "string",
      "name": "string",
      "enabled": true,
      "config": {
        "address": "string",
        "verified": true
      },
      "created_at": "string",
      "updated_at": "string",
      "last_used_at": "string",
      "auto_paused": true,
      "auto_paused_reason": "string",
      "auto_paused_at": "string",
      "auto_resume_available_at": "string"
    },
    "message": "string"
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "email_endpoint": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "client_id": {
              "type": "string"
            },
            "channel_type": {
              "type": "string"
            },
            "scope": {
              "type": "string"
            },
            "monitor_id": {
              "type": "string",
              "nullable": true
            },
            "name": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            },
            "config": {
              "type": "object",
              "properties": {
                "address": {
                  "type": "string"
                },
                "verified": {
                  "type": "boolean"
                }
              }
            },
            "created_at": {
              "type": "string"
            },
            "updated_at": {
              "type": "string"
            },
            "last_used_at": {
              "type": "string",
              "nullable": true
            },
            "auto_paused": {
              "type": "boolean"
            },
            "auto_paused_reason": {
              "type": "string",
              "nullable": true
            },
            "auto_paused_at": {
              "type": "string",
              "nullable": true
            },
            "auto_resume_available_at": {
              "type": "string",
              "nullable": true
            }
          }
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Request Body

{
  "name": "string",
  "email": "string",
  "scope": "all"
}