Bans
Useful Items
In the documentation, bans will be replaced by this object:
{
banId: string;
user: number;
game: number;
reason: string;
mod: {
roblox: number;
discord: string;
};
data: {
privacy: 'Public' | 'Restricted' | 'Private' | 'Database';
proof: string;
};
createdAt: Date;
updatedAt: Date;
deletedAt: Date?;
}data.proof will be a private Discord message link. It is reserved for the IRF Administration bot exclusively. banId will always be a UUID v4.
Adding a ban
POST /api/post_irf_ban
Adds a ban to the database. You must have a token with the AddBans scope enabled.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Body
user
number
Target Roblox user ID
game
number
Roblox game ID. 0 is global
mod
number
Moderator Roblox user ID
reason
string
Reason. Do not add 'Banned by'
Response
Checking bans
POST /api/check_irf_bans
Checks if the user is banned and returns the bans per the query provided. A token is not currently required but will be when the system is fully released. By default, global bans are only returned in your request unless you specifically opt out using the excludeGlobal option.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Body
user
number
Roblox user ID to check
game
number
Roblox game ID to check
excludeGlobal
boolean
Exclude global bans on check (Default: false)
Response
Delete a ban
DELETE /api/remove_irf_ban
Removes a ban from the database. You must have a token with the RemoveBans scope enabled.
Note: Bans issued by developers for FairPlay cannot be removed by the API. Contact a developer to arrange the unban. The API will return 403 Forbidden if you try to remove one. Ensure your ban query exists as a 404 Not Found will be returned if you query a ban that doesn't exist.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Body
user
number
Target Roblox user ID
game
number
Roblox game ID. 0 is global
mod
number
Moderator Roblox user ID
reason
string
Reason for unban. Do not add 'Unbanned by'
Response
Last updated