AH StatusAPI

AH StatusAPI

Overview

ServerStatusAPI is a powerful secure monitoring plugin for Minecraft servers that collects comprehensive performance data and provides it through a REST API. It allows server administrators to monitor key metrics in real-time and analyze historical data without impacting server performance.

Note that the Plugin is still in beta.

In order to work correctly the Server need to be restarted daily once.

The Ping currently only works if a player is online.

Features

• Real-time monitoring of server performance metrics (TPS, RAM, CPU)
• RESTful API for easy integration with external tools and dashboards
• Player tracking with playtime and ping statistics
• Entity monitoring per world with detailed distribution by type
• Historical data for trend and performance analysis
• Configurable data collection with adjustable intervals
• Database storage with SQLite (optionally disabled)
• Resource-friendly through optimized data collection
• Automatic deletion of old history data
• CORS integration
• rate limiting
• log API requests

Coming Soon!

• Multi-World Support
• Console Integration
• custom Discord bot for Server Status

Configuration

Before you can start using it, you need to specify the port in the config.yml on which the Server will run the API. (perhaps you also need to configure your firewall)

After that you can access your API here:

http://serverip:port/metrics/current

API Endpoints

• /metrics/current - Current server status data
• /metrics/history - Historical performance data
• /metrics/players - Player data with playtime statistics
• /metrics/entities - Entity distribution by worlds

Example data for each Endpoint

/metrics/current

{
  "cpuUsage": 0.06,
  "uptimeMillis": 76504272,
  "memory": {
    "max": 2147483648,
    "used": 716963360
  },
  "maxPlayers": 100,
  "onlinePlayers": 0,
  "tps": 20.0000152480116,
  "ping": 0,
  "players": [],
  "serverAddress": "serverip",
  "loadedChunks": 147,
  "timestamp": 1746884632413
}

/metrics/entities

{
  "counts": {
    "nether": 4,
    "overworld": 3,
    "the_end": 10
  },
  "distribution": {
    "nether": {
      "STRIDER": 4
    },
    "overworld": {
      "CHEST_MINECART": 3
    },
    "the_end": {
      "END_CRYSTAL": 10
    }
  }
}

/metrics/players

[
  {
    "totalPlaytimeMillis": 26095444,
    "name": "MeisterAH",
    "uuid": "debb8545-6216-4115-bc21-11c3529e3a3a"
  },
  {
    "totalPlaytimeMillis": 384016,
    "name": "Nickkyy_",
    "uuid": "095ecf90-6a7e-42eb-84eb-efd1c5f4417f"
  },
  {
    "totalPlaytimeMillis": 26416194,
    "name": "Schwabbel_Split",
    "uuid": "63a3ae68-0d98-4428-91e5-b4862d8b4e62"
  },
  {
    "totalPlaytimeMillis": 2268454,
    "name": "Jak0bUVA",
    "uuid": "fefca110-bcc9-483a-b647-54afc3ce9ba5"
  },
  {
    "totalPlaytimeMillis": 2267672,
    "name": "Maxomito",
    "uuid": "9dd498e6-517a-4b33-9d0a-57747e5c4e4f"
  }
]

/metrics/history (if enabled, default true)

{
    "cpuUsage": 0.06,
    "uptimeMillis": 81362446,
    "memory": {
      "max": 2147483648,
      "used": 631376208
    },
    "maxPlayers": 100,
    "onlinePlayers": 0,
    "entityCount": 17,
    "tps": 20.0000402534144,
    "ping": 0,
    "players": [],
    "serverAddress": "123.123.123.123",
    "loadedChunks": 147,
    "timestamp": 1746889490587
  },
  {
    "cpuUsage": 0,
    "uptimeMillis": 81361458,
    "memory": {
      "max": 2147483648,
      "used": 619055352
    },
    "maxPlayers": 100,
    "onlinePlayers": 0,
    "entityCount": 17,
    "tps": 19.9999879986739,
    "ping": 0,
    "players": [],
    "serverAddress": "123.123.123.123",
    "loadedChunks": 147,
    "timestamp": 1746889489600
  },
  {
    "cpuUsage": 0.06,
    "uptimeMillis": 81360450,
    "memory": {
      "max": 2147483648,
      "used": 619055352
    },
    "maxPlayers": 100,
    "onlinePlayers": 0,
    "entityCount": 17,
    "tps": 19.9999989690001,
    "ping": 0,
    "players": [],
    "serverAddress": "123.123.123.123",
    "loadedChunks": 147,
    "timestamp": 1746889489600
  }

  [...]