Get VPS mail-relay status

Return mail-relay verification data and delivery/security insights for the VPS primary IP. If dnsRecord is present, add it as a TXT record on the sender domain to verify relay ownership; insightsStatus explains whether live insight data is available.

VPS Services VM

Authentication

Required API scope: read:vm

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

Context

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public VPS ID. Get it from GET /api/v2/vps `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 Mail-relay status.
ip stringnull required · Example: 203.0.113.10
token stringnull required · Example: h_MjAzLjAuMTEzLjEw_example
dnsRecord stringnull required · Example: _hostup.yourdomain.com TXT "v=mc1 auth=h_MjAzLjAuMTEzLjEw_example"
insightsStatus string · enum required · Example: available
available
missing_ip
not_configured
rate_limited
unavailable
policyDisposition stringnull required · Example: none
alertTotal integer required · Example: 1
alertBuckets array<object> required
alertBuckets[].date string required · Example: 2026-04-27
alertBuckets[].count integer required · Example: 1
alerts array<object> required
alerts[].conditionName string required · Example: Spam detected
alerts[].description stringnull required · Example: Message blocked as spam
alerts[].envelopeSender stringnull required · Example: [email protected]
alerts[].reason object required
alerts[].reason.code string · enum required · Example: CS
CSR
ESA
CS
INVALID_FROM_HEADER
BFD
TCR
UNKNOWN
alerts[].reason.title string required · Example: Message blocked as spam
alerts[].reason.description string required · Example: This individual message matched spam filtering.
alerts[].reason.actions array<string> required
alerts[].timestamp string required · Example: 2026-04-27T12:00:00.000Z
recentBlocks array<object> required
recentBlocks[].timestamp string required · Example: 2026-04-27T12:00:00.000Z
recentBlocks[].sender stringnull required · Example: [email protected]
recentBlocks[].recipientDomain stringnull required · Example: example.net
recentBlocks[].responseCode stringnull required · Example: 550
recentBlocks[].responseMessage stringnull required · Example: Message rejected
recentBlocks[].lastCommand stringnull required · Example: DATA
recentBlocks[].reason object required
recentBlocks[].reason.code string · enum required · Example: CS
CSR
ESA
CS
INVALID_FROM_HEADER
BFD
TCR
UNKNOWN
recentBlocks[].reason.title string required · Example: Message blocked as spam
recentBlocks[].reason.description string required · Example: This individual message matched spam filtering.
recentBlocks[].reason.actions array<string> required
recentBlocks[].spamDisposition string required · Example: QUARANTINE
recentBlocks[].virusDisposition string required · Example: CLEAN
recentBlocks[].remediationOption stringnull required · Example: Review sender authentication
deliverySummary object required
deliverySummary.delivered numbernull required · Example: 120
deliverySummary.blocked numbernull required · Example: 1
deliverySummary.rejected numbernull required · Example: 0
deliverySummary.deferred numbernull required · Example: 2
windowDays integer required · Example: 7
refreshedAt stringnull required · Example: 2026-04-27T12:00:00.000Z
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/vps/{id}/mail-relay
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/mail-relay" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "ip": "203.0.113.10",
  "token": "h_MjAzLjAuMTEzLjEw_example",
  "dnsRecord": "_hostup.yourdomain.com TXT \"v=mc1 auth=h_MjAzLjAuMTEzLjEw_example\"",
  "insightsStatus": "available",
  "policyDisposition": "Sender was accepted by policy.",
  "alertTotal": 0,
  "alertBuckets": [
    {
      "date": "2026-04-27",
      "count": 0
    }
  ],
  "alerts": [],
  "recentBlocks": [],
  "deliverySummary": {
    "delivered": null,
    "blocked": null,
    "rejected": null,
    "deferred": null
  },
  "windowDays": 7,
  "refreshedAt": "2026-04-27T12:00:00.000Z"
}