Organization API: Org Staff Abuse

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/staff/abuse/patterns

List the values that many of your new accounts share within an hour.

A pattern opens when enough distinct accounts made in the window share an email domain, a sign-up network (an IPv4 /24 or IPv6 /48), a free-order network or a server name. Each row carries up to five of its accounts, the rule that blocks it if there is one, and who acted on it. counts has the number of patterns in every status, whatever status asks for. Needs Tier 3 support or above; lists only your brand's patterns.

POST /api/v1/orgs/{org_slug}/staff/abuse/patterns/{pattern_id}/block

Block a pattern's value for your brand, and mark the pattern blocked.

An email domain pattern blocks the domain, so it can no longer sign up or order a free server. A network pattern blocks free orders from the whole network, and a server name pattern refuses free servers with that name. hours sets how long the block lasts (1 to 8760), and null makes it last until someone deletes the rule. If your brand already has a rule for the value, it becomes this block. Needs an org owner or admin; answers the pattern row, and 404 for a pattern that is not your brand's.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/abuse/patterns/{pattern_id}/dismiss

Dismiss a pattern for 1 to 90 days.

The pattern reads dismissed and does not open again before then, however many accounts share the value. After that date it opens again only when the value is over its threshold again. A rule the pattern already has stays in place; delete the rule to let the value back in. Needs an org owner or admin; answers the pattern row, and 404 for a pattern that is not your brand's.

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/abuse/rules

List the email domains, networks and server names your brand blocks or allows.

The list holds your brand's own rules (scope org) and the rules the platform set for every brand (scope platform), newest first. You can read a platform rule and cannot change it; your brand's own rule for the same value decides first. An expired rule is listed with its expires_at and no longer applies. Needs Tier 3 support or above.

POST /api/v1/orgs/{org_slug}/staff/abuse/rules

Block or allow an email domain, a network or a server name for your brand.

kind is email_domain, ip_cidr or server_name, and action is block (the default) or allow; an ip_cidr rule may also be nonresidential, which treats the network as hosting. A blocked email domain refuses sign-ups and free orders, and covers its subdomains. A blocked network refuses free orders from it. A blocked server name refuses free servers with that name, whatever number follows it. hours makes the rule expire; null keeps it until someone deletes it. The value is stored normalized (an email domain in lowercase, an address as its network). Needs an org owner or admin. Answers the rule row, 409 when your brand already has a rule for the value, and 422 when the value is not one of its kind.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/staff/abuse/rules/{rule_id}

Delete one of your brand's rules, so the value it matched is let in again.

A pattern that the rule blocked goes back to open. A rule the platform set for every brand cannot be deleted here and answers 403. Needs an org owner or admin; 404 for a rule that is neither yours nor the platform's.