API Reference

Introduction

The rbAdmin API allows you to interact with your Unreal Engine server programmatically. You can use this API to build custom dashboards, Discord bots, or automate server management tasks.

GET

Get Server Status

Retrieves the current health, tick rate, and player count of the server instance.

Endpoint /api/v1/status

GET https://your-server.com/api/v1/status

Response

{
  "status": "online",
  "version": "2.4.1",
  "tick_rate": 60.0,
  "players": {
    "current": 12,
    "max": 64
  },
  "uptime": 3600
}

POST

Kick Player

Removes a player from the current session.

Endpoint /api/v1/players/kick

POST https://your-server.com/api/v1/players/kick

Request Body

{
  "player_id": "76561198000000000",
  "reason": "AFK"
}