Get the catch-all

gethttps://api.nsin.ir/domains/{domain}/email-routing/catch-all

Auth: Authorization: Bearer nsin_… or X-Api-Key: nsin_… — see API keys.

What happens to mail for an address on this domain that no rule matches: when enabled, it is forwarded to destination_id or dropped (action); when not, it is rejected. Requires domain.view.

Path parameters

domainstringrequiredpath

The domain name (for example example.com) — not a numeric id.

Responses

200The catch-all.

Content type: application/json

enabledboolean

Whether the catch-all handles mail for addresses you have not created. Off, such mail is refused as an unknown user.
actionstring

forward to the destination, or drop (accept and discard).

One of: "forward" "drop"
destination_idinteger | null

The destination for forward.
destination_emailstring | null

That destination's address.
destination_verifiedboolean

Whether the destination has confirmed its address.

json

{
  "enabled": true,
  "action": "forward",
  "destination_id": 0,
  "destination_email": "string",
  "destination_verified": true
}

401Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

Content type: application/json

errorstringrequired

Human-readable description of what went wrong.

json

{
  "error": "invalid API key"
}

404No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Content type: application/json

errorstringrequired

Human-readable description of what went wrong.

json

{
  "error": "read-only API key"
}

429The key exceeded its request budget (300 requests per minute by default).

Content type: application/json

errorstringrequired

Human-readable description of what went wrong.

json

{
  "error": "rate limit exceeded"
}

Example request

bash

curl -X GET "https://api.nsin.ir/domains/example.com/email-routing/catch-all" \
  -H "Authorization: Bearer $NSIN_API_KEY"