This plugin provides a lightweight HTTP API that exports the real-time status of all Velocity backend servers in JSON format.
\nExported fields are fully configurable via `plugins\/velostat\/config.yml`, allowing safe public exposure.<\/p>\n
The game version is for all versions supported by Velocity 3.4.0-SNAPSHOT as it is added to the proxy server only. The game version must be specified and is specified, but see the Server compatibility for details.
\n– – –
\n# Installation
\n1. Download the latest release of the plugin
\n2. Put `velostat-x.x.jar` in \/plugins directory of velocity<\/p>\n
This completes the process! “` ### Root Object<\/p>\n | Field | Type | Description | —<\/p>\n ### Server Object<\/p>\n | Field | Type | Description | —<\/p>\n ### Players Object<\/p>\n | Field | Type | Description | —<\/p>\n ### Version Object<\/p>\n | Field | Type | Description | —<\/p>\n ## Notes<\/p>\n * Fields may be **omitted** depending on `config.yml` settings. Collects the status of servers under the Velocity server and exports it as JSON.<\/p>\n","protected":false},"featured_media":165658,"template":"","meta":{"_minecraft_slug":"velostat","_minecraft_project_id":"Aj03UN5N","_minecraft_author":"stellarcielo","_minecraft_license":"MIT","_minecraft_downloads":502,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"velostat.zip","_minecraft_size_bytes":651723,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T10:30:56.685803Z","_minecraft_date_created":"2026-01-15T00:00:20.770316Z","_minecraft_date_modified":"2026-01-11T16:18:03.941356Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/velostat","_minecraft_icon_attachment_id":165658,"_minecraft_imported_at":"2026-06-09T17:56:27+00:00","_minecraft_import_hash":"ae9d3fd9584b633fdbcf463dbc89bc23","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,92,985],"mod_loader":[986],"minecraft_version":[339,340,341,357,359,360,379,382,385,438,446,449,110,111,112,113,114,115,116,117,118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82,21,13,14,15,16,17,18,19,20,22,23,24,25,26,27,28,29,30,31,860,861,862,863,864],"class_list":["post-165657","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-utility","mod_category-velocity","mod_loader-velocity","minecraft_version-1-10","minecraft_version-1-10-1","minecraft_version-1-10-2","minecraft_version-1-11","minecraft_version-1-11-1","minecraft_version-1-11-2","minecraft_version-1-12","minecraft_version-1-12-1","minecraft_version-1-12-2","minecraft_version-1-13","minecraft_version-1-13-1","minecraft_version-1-13-2","minecraft_version-1-14","minecraft_version-1-14-1","minecraft_version-1-14-2","minecraft_version-1-14-3","minecraft_version-1-14-4","minecraft_version-1-15","minecraft_version-1-15-1","minecraft_version-1-15-2","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-1-7-10","minecraft_version-1-7-2","minecraft_version-1-7-3","minecraft_version-1-7-4","minecraft_version-1-7-5","minecraft_version-1-7-6","minecraft_version-1-7-7","minecraft_version-1-7-8","minecraft_version-1-7-9","minecraft_version-1-8","minecraft_version-1-8-1","minecraft_version-1-8-2","minecraft_version-1-8-3","minecraft_version-1-8-4","minecraft_version-1-8-5","minecraft_version-1-8-6","minecraft_version-1-8-7","minecraft_version-1-8-8","minecraft_version-1-8-9","minecraft_version-1-9","minecraft_version-1-9-1","minecraft_version-1-9-2","minecraft_version-1-9-3","minecraft_version-1-9-4"],"yoast_head":"\n
\n– – –
\n# Config reference
\n| Setting name | Description | Default |
\n|:—————————|:———————————————————————————–|:——–|
\n| `api.port` | The port number for the internal HTTP server to listen on. | `8080` |
\n| `ping.interval_seconds` | The interval (in seconds) at which the plugin pings sub-servers to collect status. | `10` |
\n| `export.server.name` | Whether to include the server name (defined in Velocity) in the JSON output. | `true` |
\n| `export.server.address` | Whether to include the server address in the JSON output. | `true` |
\n| `export.server.status` | Whether to include the online\/offline status in the JSON output. | `true` |
\n| `export.server.motd` | Whether to include the server’s MOTD (Message of the Day) in the JSON output. | `true` |
\n| `export.server.players` | Whether to include player counts (online\/max) in the JSON output. | `true` |
\n| `export.server.version` | Whether to include the game version name and protocol version in the JSON output. | `true` |
\n| `export.server.updated_at` | Whether to include the last update timestamp in the JSON output. | `true` |
\n– – –
\n# Example Json output
\nAccessing `http:\/\/
\n### FULL data
\n“`json
\n{
\n “lobby”: {
\n “name”: “lobby”,
\n “address”: “127.0.0.1:25565”,
\n “online”: true,
\n “motd”: “Welcome to the Lobby!”,
\n “players”: {
\n “online”: 12,
\n “max”: 100
\n },
\n “version”: {
\n “name”: “Paper 1.21.1”,
\n “protocol”: 767
\n },
\n “updated_at”: 1704681000000
\n },
\n “survival”: {
\n “name”: “survival”,
\n “address”: “127.0.0.1:25566”,
\n “online”: false,
\n “motd”: null,
\n “players”: {
\n “online”: 0,
\n “max”: 0
\n },
\n “version”: null,
\n “updated_at”: 1704681000000
\n }
\n}
\n“`
\n### Configured data
\n“`json
\n{
\n “lobby”: {
\n “name”: “lobby”,
\n “online”: true,
\n “motd”: “Welcome to the Lobby!”,
\n “players”: {
\n “online”: 12,
\n “max”: 100
\n },
\n “updated_at”: 1704681000000
\n },
\n “survival”: {
\n “name”: “survival”,
\n “online”: false,
\n “motd”: null,
\n “players”: {
\n “online”: 0,
\n “max”: 0
\n },
\n “updated_at”: 1704681000000
\n }
\n}<\/p>\n
\n## Field Description<\/p>\n
\n|———–|———|——————————————–|
\n| `servers` | `array` | List of servers defined in `velocity.toml` |<\/p>\n
\n|:————:|:———:|:——————————————————————|
\n| `name` | `string` | Server name defined in `[servers]` section of `velocity.toml` |
\n| `address` | `string` | Server address (`host:port`) |
\n| `online` | `boolean` | Whether the server responded to a ping |
\n| `motd` | `string` | Server MOTD (may contain legacy color codes) |
\n| `players` | `object` | Player information (only present if enabled and server is online) |
\n| `version` | `object` | Minecraft version information |
\n| `updated_at` | `number` | Last update timestamp(UNIX time) |<\/p>\n
\n|:——–:|:——–:|———————————-|
\n| `online` | `number` | Current number of online players |
\n| `max` | `number` | Maximum player capacity |<\/p>\n
\n|:———-:|:——–:|————————————-|
\n| `name` | `string` | Version name reported by the server |
\n| `protocol` | `number` | Minecraft protocol version |<\/p>\n
\n* If a server is offline, only `name`, `address`, and `online` are guaranteed.
\n* This API is intended for **internal dashboards, status pages, or monitoring tools**.
\n# Issue and question
\nIf the plugin does not work properly, try deleting `config.yml`.
\nProblems and questions feature request [here]([https:\/\/github.com\/stellarcielo\/velostat\/issues).<\/p>\n","protected":false},"excerpt":{"rendered":"