Preview a purge
/api/settings/purgeWhat a purge of one person would erase, and what it would keep. Counts only; nothing is changed. Every number is counted from the same tables the purge writes to. A field Modbot cannot answer for a platform is null rather than zero: a Discord account has no group ban list and no case files.
Needs the Administrator permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/settings/purge"{ "platform": "string", "subjectId": "string", "name": null, "isMember": null, "isBanned": null, "facts": 0, "countedDailyTotals": 0, "days": 0, "messages": 0, "giveawayEntries": 0, "giveawayPlaces": 0, "importRecords": 0, "watches": 0, "appeals": 0, "milestones": 0, "caseFilesKept": 0, "evidenceFilesKept": 0, "linkedAccount": null}Set retention PUT
Zero means keep forever, which is the default for both classes. Turning a window on schedules destruction of data that cannot be recovered or filled in later.
Purge a person POST
Irreversible. `confirmation` must equal `subjectId` exactly. Erased: every fact where they are the subject, the counted-only daily totals dimensioned on them, the rows saying a record about them was imported, their Discord messages including earlier texts of edited ones, and their standing giveaway entries. Their place in a past draw keeps its position and weight and loses its name and ids, so an old result still checks out. Kept: facts where they were the actor rather than the subject — somebody else's moderation history — case files about them with their evidence and profile snapshots (evidence storage design §15.1), the current-state rows the next sync would write again, and the fact that this purge happened. A purge of somebody Modbot has never seen removes nothing and is not an error. Needs the `Administrator` permission.