Get Server Status

gorp -f [server]

Where “server” is the server name. This will show and follow the server’s log file in real time. This allows for easy access to monitor gameplay without giving the chance to accidentally enter a rogue command.

gorp -s [server]

Where “server” is the server name. Gorp will only respond with JSON.

JSON Output

The status command will output the server’s status in JSON. This makes it easy to integrate your server’s status with other applications or scripts.

Array: status

• running [bool] Server running status
• version [string] Last-started game version
• jar_file [string] Path to currently set JAR file
• jar_file_overridden [bool] Whether the JAR file has been overridden in the server’s settings
• ram [string] Amount of RAM allocated to the server
• ram_overridden [bool] Whether the allocated ram has been overridden in the server’s settings
• path [string] Path to server files

Array: world

• active [string] Directory name of the active world
• total_size [string] Total size of all world files
• o_size [string] Size of Overworld dimension files
• n_size [string] Size of Nether dimension files
• e_size [string] Size of End dimension files

Array: properties

• whitelist [bool] Whitelist status
• gamemode [string] The set game mode (in server.properties)
• difficulty [string] The set difficulty (in server.properties)
• hardcore [bool] Hardcore enabled status
• server_port [int] Server’s game port

Sample JSON Output

{
  "status": [
    {
      "running": true,
      "version": "1.21.4",
      "jar_file": "/home/user/gorpmc/jars/paper-1.21.4-222.jar",
      "jar_file_overridden": false,
      "ram": "8G",
      "ram_overridden": false,
      "path": "/home/lance/gorpmc/servers/my-server"
    }
  ],
  "world": [
    {
      "active": "world-default",
      "total_size": "3.7G",
      "o_size": "3.1G",
      "n_size": "255M",
      "e_size": "381M"
    }
  ],
  "properties": [
    {
      "whitelist": false,
      "gamemode": "survival",
      "difficulty": "normal",
      "hardcore": false,
      "server_port": 25565
    }
  ]}