/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

Query parameters

experienceBanCompletedbooleanoptional

isAppealbooleanoptional

Body

overwritebooleanrequired

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

userIdnumberrequired

experienceIdnumberrequired

banModeratornumberrequired

banTypeundefined · enumrequired

Available options:

banLengthTypeundefined · enumrequired

Available options:

banLengthstringrequired

banPrivateReasonstringrequired

banPublicReasonstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sentinel.metatable.dev/api/v1/ban-async' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "overwrite": true,
    "userId": 1,
    "experienceId": 1,
    "banModerator": 1,
    "banType": "Experience",
    "banLengthType": "Temporary",
    "banLength": "text",
    "banPrivateReason": "text",
    "banPublicReason": "text"
  }'

200

409

200

{
  "status": "ok"
}

OK