Get VPS mail-relay status

GET /api/v2/vps/{id}/mail-relay

Return mail-relay verification data, usage, and relay-side 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.

activeBlocks shows current sender/domain/IP blocks with the reason and auto-clear time; manual unblock is not available to customer/API-key callers.

VPS Services VM

Authentication

Required API scope: read:vm

Authenticate with an API key in the Authorization: Bearer <token> header.

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

Authorization Bearer <token>
Accept application/json

Responses

200 Mail-relay status.
ip string · nullable required · Example: 203.0.113.10

token string · nullable required · Example: h_MjAzLjAuMTEzLjEw_example

dnsRecord string · nullable 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 string · nullable required · Example: none

alertTotal integer required · Example: 1
alertBuckets array<object> required
alertBuckets[].date string required · Example: 2026-04-27

Calendar day the alert bucket covers, as YYYY-MM-DD.

alertBuckets[].count integer required · Example: 1

Number of alerts recorded on that day.

alerts array<object> required
alerts[].conditionName string required · Example: Spam detected
alerts[].description string · nullable required · Example: Message blocked as spam

Nullable: may be null when not applicable.

alerts[].envelopeSender string · nullable required · Example: sender@example.com

Nullable: may be null when not applicable.

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 string · nullable required · Example: sender@example.com

Nullable: may be null when not applicable.

recentBlocks[].recipientDomain string · nullable required · Example: example.net

Nullable: may be null when not applicable.

recentBlocks[].responseCode string · nullable required · Example: 550

Nullable: may be null when not applicable.

recentBlocks[].responseMessage string · nullable required · Example: Message rejected

Nullable: may be null when not applicable.

recentBlocks[].lastCommand string · nullable required · Example: DATA

Nullable: may be null when not applicable.

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 string · nullable required · Example: Review sender authentication

Nullable: may be null when not applicable.

recentBlocks[].senderDomain string · nullable · Example: example.com

Nullable: may be null when not applicable.

recentBlocks[].eventType string · enum · Example: spam_drop
clean_release
spam_drop
domain_block
already_blocked
policy_defer
policy_reject
quota_reject
recentBlocks[].scope string · nullable · enum · Example: domain

Nullable: may be null when not applicable.

email
domain
envelope
ip
recentBlocks[].category string · nullable · Example: phishing

Nullable: may be null when not applicable.

recentBlocks[].categoryLabel string · nullable · Example: Phishing

Nullable: may be null when not applicable.

recentBlocks[].confidence number · nullable · min: 0 · max: 1 · Example: 0.95

Nullable: may be null when not applicable.

recentBlocks[].blockedUntil string · nullable · Example: 2026-06-09T15:06:30.000Z

Nullable: may be null when not applicable.

deliverySummary object required
deliverySummary.delivered number · nullable required · Example: 120

Nullable: may be null when not applicable.

deliverySummary.blocked number · nullable required · Example: 1

Nullable: may be null when not applicable.

deliverySummary.rejected number · nullable required · Example: 0

Nullable: may be null when not applicable.

deliverySummary.deferred number · nullable required · Example: 2

Nullable: may be null when not applicable.

windowDays integer required · Example: 7
refreshedAt string · nullable required · Example: 2026-04-27T12:00:00.000Z

activeBlocks array<object> required

Current sender/domain/IP blocks mirrored from the HostUp relay. Customers can view these blocks and their auto-clear time; manual unblock is staff-only.

activeBlocks[].scope string · enum required · Example: domain
email
domain
envelope
ip
activeBlocks[].value string required · Example: example.com

Customer-safe blocked value. Email-address blocks are redacted to the sender domain.

activeBlocks[].senderDomain string · nullable required · Example: example.com

Nullable: may be null when not applicable.

activeBlocks[].reason object required
activeBlocks[].reason.code string · enum required · Example: CSR
CSR
ESA
CS
INVALID_FROM_HEADER
BFD
TCR
UNKNOWN
activeBlocks[].reason.title string required · Example: Sender temporarily blocked for spam-like volume
activeBlocks[].reason.description string required · Example: The mail relay detected a large amount of spam-like mail from this sender in a short time.
activeBlocks[].reason.actions array<string> required
activeBlocks[].summary string · nullable required · Example: Password-expiration lure detected in outbound mail.

Nullable: may be null when not applicable.

activeBlocks[].category string · nullable required · Example: phishing

Nullable: may be null when not applicable.

activeBlocks[].categoryLabel string · nullable required · Example: Phishing

Nullable: may be null when not applicable.

activeBlocks[].confidence number · nullable · min: 0 · max: 1 required · Example: 0.99

Nullable: may be null when not applicable.

activeBlocks[].blockedUntil string required · Example: 2026-06-09T15:06:30.000Z
activeBlocks[].updatedAt string required · Example: 2026-06-09T08:58:00.000Z
activeBlocks[].manualUnblockAvailable boolean required · Example: false

Always false for customer/API-key callers. Staff unblock is handled through an internal admin workflow.

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",
  "activeBlocks": []
}