Stats

Check an address or domain against the policy

Admin-only. Says whether a new signup from the address would be refused, which list refuses it, and whether an allow rule overrides a block. Existing users are never refused — this is what a new address would meet.

get/stats/email-domains/check

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/stats/email-domains/check
  • Auth: bearer (a scheme the document does not define)

Query parameters

valuestring required
Example:someone@example.com

An email address or a bare domain.

Response

domainstring nullable required

The normalised domain checked; null when none was found.

blockedboolean required

Whether a new signup would be refused.

list'community' | 'nippy' | 'plus_alias' nullable required

What blocks it: a domain list, or plus_alias for a + alias outside the staff domains. Null when not blocked.

matchedDomainstring nullable required

The listed domain that matched (the domain or a parent).

allowedBystring nullable required

The allow rule that overrode a block, if any.

existingUsersnumber required

Existing users on the domain or a subdomain.

signupRule'same_mailbox' | 'numbered_address' | 'device_limit' nullable required

The signup limit that would refuse this address as a new account (address rules only — the browser limit needs a browser); null when none applies or the input is a bare domain (ADR 0050).

signupMatchstring nullable required

The existing account that triggers signupRule.

signupAllowlistedboolean required

Whether the address is on the signup-limit override list.

Changes

No recorded changes to this operation across all 1 revision of this API.