Organization API: Org Staff Bulk Runs

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/bulk-runs

The brand's bulk runs, newest first, as {"runs": [...], "total": N}.

Each run says what it does (target, action, filter, reason), where it is (status: queued, running, done, failed or cancelled) and how far it got (total, processed, applied, skipped). pattern names the pattern a pattern_id filter acted on (id, kind, value), and is null for any other filter. Tier 3 support and up.

POST /api/v1/orgs/{org_slug}/staff/abuse/bulk-runs

Start one action over every account or server a filter matches.

Send the filter the directory (GET /staff/customers) or the fleet (GET /staff/servers) was showing and the total it showed as expected_total. The run resolves the selection once, with the same query that list uses, and answers the run with 201; it then works through the selection in the background, 100 at a time, and GET /staff/abuse/bulk-runs/{uuid} shows its progress.

Refused with 409 selection_changed (and the current total) when the filter no longer matches expected_total rows, and with 422 when the filter narrows nothing or is not one the list takes, when nothing matches, or when more rows match than a run takes (abuse.bulk_run_max, 20000). Support may suspend and unsuspend; terminate, ban, pause and a deletion date need an org admin who stepped up in the last ten minutes. Each staff member may start 6 runs an hour. A run opens tickets and emails customers only when open_ticket and notify_customer say so.

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/abuse/bulk-runs/preview

How many accounts or servers a run with this filter would act on.

Answers {"target", "filter", "total", "max"}: send total back as a run's expected_total. The fleet list pages without a total, so this is where a server run's count comes from. Changes nothing, and refuses an empty or unknown filter with 422 as a run does. Tier 3 support and up.

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/abuse/bulk-runs/{uuid}

One bulk run and its progress. last_error says why a failed run stopped. Another brand's run answers 404.

POST /api/v1/orgs/{org_slug}/staff/abuse/bulk-runs/{uuid}/cancel

Stop a run that has not finished. It reads cancelled at once and stops before its next chunk of 100; what it already did stays done. A run that already finished answers 409. Tier 3 support and up.