Modbot Docs
APIAPI referenceSettings

Preview a purge

GET/api/settings/purge

What 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.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

platform?string
subjectId?string

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}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.