/ban-async

Bans published through this endpoint will not execute the following actions unless initiated via the Discord slash command:

• Notify the banned user (if notifications are enabled).

• Forcefully disconnect the client using MessagingService via the Roblox Open Cloud API.

This limitation exists because the Sentinel API does not directly handle these enforcement actions. Instead, these tasks are managed by the Sentinel Discord bot when a ban is issued through the /ban command.

Future Considerations

We may explore expanding the API to include these functionalities in the future, allowing for more automated enforcement directly from API calls.

Roblox BanAsync Integration

If BanAsync is enabled in your game, it will automatically force-disconnect the banned client upon execution, ensuring immediate removal without requiring additional enforcement from Sentinel.

post

Create a new ban

Authorizations

apiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

experienceBanCompletedbooleanOptional

isAppealbooleanOptional

Body

application/json

overwritebooleanRequired

If true it will forcefully overwritten any pre-existing ban with this updated data.

userIdnumberRequired

experienceIdnumberRequired

banModeratornumberRequired

banTypeundefined · enumRequiredPossible values:

banLengthTypeundefined · enumRequiredPossible values:

banLengthstringRequired

banPrivateReasonstringRequired

banPublicReasonstringRequired

Responses

200

OK

application/json

statusundefined · enumOptionalPossible values:

409

Conflict - Player is already banned

application/json

post

/ban-async

HTTPcURLJavaScriptPython

POST /api/v1/ban-async HTTP/1.1
Host: sentinel.metatable.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "overwrite": true,
  "userId": 1,
  "experienceId": 1,
  "banModerator": 1,
  "banType": "Experience",
  "banLengthType": "Temporary",
  "banLength": "text",
  "banPrivateReason": "text",
  "banPublicReason": "text"
}

{
  "status": "ok"
}