<cat>Play.Hosting</cat> <title>Centralized Banning</title> # What is it? Centralized banning is a (new!) feature within the Rust dedicated server which allows server owners to build a synchronized, external ban list that can be shared across multiple servers. # How do I use it? You will need a web server (HTTP or HTTPS) which hosts the centralized banning API. We do not have a publicly available implementation of this but it is relatively simple to implement. To enable it on your server, simply set the `server.bansServerEndpoint` convar to your web server API endpoint. For example: ``` server.bansServerEndpoint "https://contoso.com/api/rustBans/" ``` Once set, the Rust dedicated server will query that API endpoint to check if players are banned at the time they join the server. # API details # FAQ ## Will players be kicked from servers when a ban is added to the endpoint? ## Will players be kicked from servers when a ban is added to the endpoint?⤶ No, centralized banning will only prevent players from entering the server. If you want them kicked from the server immediately then you will need to use the `kick` command on whichever server they are on.⤶ ⤶ ## What happens when the API endpoint is down or not working properly?⤶ A message will be logged to the Rust dedicated server console whenever the centralized banning system encounters an error. A separate convar (`server.bansServerFailureMode`) controls what happens to players who failed to be checked:⤶ ⤶ | bansServerFailureMode Value | Meaning |⤶ |--------------------------------------|---------|⤶ | 0 | Players are allowed into the server when an error occurs (message logged in server console) |⤶ | 1 | Players are rejected from joining the server when an error occurs (message logged in server console, also visible to player ) |⤶