Back to mods
Spark REST project artwork

CurseForge · Minecraft mod

Spark REST

Creates a REST Endpoint to show metrics using Spark

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Spark REST release should I use?

Updated 14 days ago
Latest stable file Spark REST 1.0.5
Game version 1.20.1
Loader Forge

Spark REST 1.0.5 targets 1.20.1 with Forge. The project page does not say whether this file belongs on the client, dedicated server, or both. All 1 required mods have matching files.

Where it goes

Is Spark REST required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does Spark REST 1.0.5 need?

Spark REST 1.0.5. Change the file and its required mods may change too.

All 1 required mods have matching files

Install spark first. We found matching files for this game-version and loader setup.

spark Needed by Spark REST 1.0.5
required
Matching file found Matched file: 1.10.53 (Forge 1.20.1)

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add Spark REST without breaking your instance.

Built for Spark REST 1.0.5. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use Spark REST 1.0.5. It targets 1.20.1 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    Install spark first. We found matching files for this game-version and loader setup.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside Spark REST 1.0.5. It opens that exact file at the source.

About this project

What does Spark REST add?

Spark-REST

Spark-REST is a lightweight Minecraft Forge 1.20.1 mod that exposes server performance metrics — provided by the Spark profiler — through a simple REST API.
Designed for server administrators who want to monitor TPS, MSPT, CPU usage, and other performance data using external dashboards, bots, or monitoring tools.


🚀 Features

  • Built-in HTTP server that exposes live performance metrics
  • Retrieves data directly from Spark
  • Metrics include: TPS (10s, 1m, 5m, 15m), MSPT, CPU usage, etc…
  • Fully configurable port and endpoint
  • Extremely lightweight and safe for production servers

📦 Requirements

  • Minecraft Forge 1.20.1
  • Spark profiler installed on the server (created by Lucko)
  • Java 17 or higher

Note: Spark-REST does not include Spark. You must install Spark separately.


⚙️ Installation

  1. Download spark-rest.jar
  2. Place it in your server’s /mods/ folder
  3. Ensure the Spark mod is also installed
  4. Start the server to generate the configuration file

📝 Configuration

  • After the first launch, the configuration file is created at:
  • config/spark_rest-common.toml
  • Example:
    • [general] port = 8080 endpoint = "metrics" enabled = true

🔗 REST API

  • Access your metrics from any browser, bot, or dashboard:
  • http://{server-ip}:{port}/{endpoint};
  • Example:
  • http://localhost:8080/metrics
  • Example JSON response:
    • > { "tps_10s": 20.0, "tps_1m": 19.95, "tps_5m": 19.87, "tps_15m": 19.76, "mspt_1m": 12.4, "cpu": 45.2 }

❓FAQ

  • Spark-REST returns no metrics or errors
    Make sure Spark is installed and running — Spark-REST depends on Spark’s API.
  • The port is already in use
    Change the port value in the config file.

👤 Author


🙌 Credits

  • This mod is powered by performance data provided by the Spark profiler, created by Lucko.
    Spark-REST is not affiliated with the original Spark project but depends on its API to function.

📜 License


Project description from CurseForge.

Pick your setup

Spark REST by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

1 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Spark REST versions and loaders

6 of 6 releases match

Looking for an older file? The official CurseForge project page is in Resources.