Lift a paused mail relay sender

POST /api/v2/me/mail-relay/blocks/unblock

Lifts a pause the outbound mail relay put on one of your senders. Take blockScope and blockValue from scope and value of an entry in GET /api/v2/me/mail-relay/blocks. The relay still checks every message afterwards. A sender that keeps sending the same kind of mail is paused again, for longer. When the entry has passwordChangeAcknowledgementRequired: true, change the mailbox password first and send passwordChangeAcknowledged: true. You can lift a pause on the same sender 3 times in 7 days. The pause ends within a minute. Until then the entry shows unblockPending: true.

Authentication: An API key with one of these scopes: write:hosting, write:vm. About keys and scopes

Request

Body

scopestringrequired

Where the sender lives, as on the list. hosting takes domain and needs the scope write:hosting. vps takes vpsId and needs write:vm. One of hosting, vps.

domainstring

A domain on one of your web hosting accounts. Required when scope is hosting.

vpsIdstring

The VPS ID (vps_…). Required when scope is vps.

blockScopestringrequired

The scope of the entry on the list. One of email, domain, envelope, ip.

blockValuestringrequired

The value of the entry on the list, unchanged.

passwordChangeAcknowledgedboolean

Confirms that the mailbox password was changed. Required as true when the entry has passwordChangeAcknowledgementRequired: true.

Example

Lift a pause on a mailbox of a hosting domain
Lift a pause on a VPS address

curl -X POST "https://cloud.hostup.se/api/v2/me/mail-relay/blocks/unblock" \
  -H "Authorization: Bearer $HOSTUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "hosting",
    "domain": "example.com",
    "blockScope": "email",
    "blockValue": "[email protected]",
    "passwordChangeAcknowledged": true
  }'

curl -X POST "https://cloud.hostup.se/api/v2/me/mail-relay/blocks/unblock" \
  -H "Authorization: Bearer $HOSTUP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "vps",
    "vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "blockScope": "ip",
    "blockValue": "198.51.100.10"
  }'

Responses

202 The lift is queued. The pause ends within a minute.

{
  "commandId": "mru_0b8e5f0c-3c1a-4f7e-9d2b-6a5c4e3d2f10",
  "status": "pending",
  "appliesWithinSeconds": 60
}

Response fields

commandIdstring

ID of the queued lift.

statusstring

Always pending. One of pending.

appliesWithinSecondsinteger

The most seconds it takes until the sender can send again.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400	Invalid request. The response body is an RFC 7807 Problem Details document.
401	Unauthorized. Authentication is required.
403	Forbidden. The caller lacks a required scope or does not own the resource.
404	`domain_not_found` or `vps_not_found`: the domain or VPS is not on your account. `mail_relay_block_not_found`: none of your active pauses matches `blockScope` and `blockValue`. The pause may already have ended.
409	`unblock_pending`: a lift for this sender is already on its way. `password_change_acknowledgement_required`: the pause is for phishing, a scam, malware or a hijacked mailbox. Change the password, then send again with `passwordChangeAcknowledged: true`.
429	`unblock_limit_reached`: a pause on this sender was lifted 3 times in the last 7 days. Contact support to lift it again.
500	Internal error. Retry later or contact support if the issue persists.

This page as Markdown OpenAPI spec