modpacks.ch by CreeperHost No ads. Just mods.
Back to mods
Arisu's REST API + project artwork

CurseForge · Hytale mod

Arisu's REST API +

Simple API for web integration: Manage Players, run commands, track deaths and mods info. Works for localhost and servers.

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

Quick answer

Which Arisu's REST API + release should I use?

Updated 5 months ago
Latest stable file ArisuRESTAPI-1.7.0.jar
Game version Not listed
Mod system Built-in Hytale mod system

Arisu's REST API + ArisuRESTAPI-1.7.0.jar targets Hytale. Do not install it as a separate client mod. Enable it on the world host—the local server in singleplayer or the dedicated server in multiplayer. No required dependencies listed for this file.

Where it goes

Where should Arisu's REST API + be installed in Hytale?

Do not install it as a separate client mod. Enable it on the world host—the local server in singleplayer or the dedicated server in multiplayer.

Separate client mod Not supported
World host / dedicated server Required
Mod system for this release Built-in Hytale mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

Put Hytale mods on the world host or dedicated server. Singleplayer runs a local server too; Hytale does not use separate client mods.

Read the Hytale installation guide

What else does Arisu's REST API + ArisuRESTAPI-1.7.0.jar need?

ArisuRESTAPI-1.7.0.jar. Change the file and its required mods may change too.

No required dependencies listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional project dependencies. Check the creator notes before changing an existing world.

Before you install it

Add Arisu's REST API + without breaking your instance.

Built for Arisu's REST API + ArisuRESTAPI-1.7.0.jar. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use ArisuRESTAPI-1.7.0.jar. It targets Hytale; another release may target a different game build or dependency set.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Enable it on the world host

    Do not install it as a separate client mod. Enable it on the world host—the local server in singleplayer or the dedicated server in multiplayer.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside ArisuRESTAPI-1.7.0.jar. It opens that exact file at the source.

About this project

What does Arisu's REST API + add?

Support me on Ko-fi

Arisu's REST API + Deaths (because why not)

A Hytale server mod that exposes a REST API over HTTP so you can manage players, run server commands, and monitor your server from external tools, dashboards, or scripts.

Features

  • Health check & status – Monitor API status and server info
  • Death tracking – Built-in death counter via /api/deaths, /api/deaths/summary, /api/deaths/recent
  • Player management – List online/saved players, give items, kick, ban/unban
  • Mod discovery – List installed mods and configs via /api/mods and /api/mods/configs
  • Broadcast & commands – Send messages and run server commands over HTTP

Quick Notes

  1. Please generate and set an API key via apiKey in config.json.
  2. How to Test: http://localhost:8223/api/health.

All endpoints except /api/health require the header: X-API-Key: <your-api-key>.

Background info

I created this mod because I've been playing with friends hosting a server, and I wanted to have a place to centralize general info and useful tools. It started as a side-project but I have used it so much for my boards and other mods, I decided to make it available here as it may suit some of you.

I believe its easier to show it's potential through some stuff I built:

Mod list of my server pulled through api in my website:

ModList

Dashboards containing player, universe and mod info:

image

image

image

image

image

image

Main Endpoints

Method Endpoint Description
GET /api/health Check API status (no auth)
GET /api/server/status Server information
GET /api/deaths Death counter: summary, recent deaths, total (built-in tracking)
GET /api/deaths/summary Per-player death counts (sorted by deaths)
GET /api/deaths/recent Recent deaths (optional ?limit=50)
GET /api/mods List installed mods (JAR and ZIP in mods folder)
GET /api/mods/configs List mod config folders, config files, and main class when resolvable from manifest (mods/<folder>/manifest.json or mods/<folder>.jar)
GET /api/universe/players List saved players from Server/universe/players/*.json (id, name) for the board app
GET /api/universe/players/{id} Full player JSON by id (filename without .json)
GET /api/players List online players
GET /api/players/{name} Get specific player info
POST /api/players/{name}/give Give item to player
POST /api/players/{name}/kick Kick player
POST /api/players/{name}/ban Ban player
POST /api/players/{name}/unban Unban player
POST /api/broadcast Send message to all players
POST /api/command Execute server command

Configuration

Edit mods/ArisuRESTAPI/config.json:

Option Default Description
port 8223 HTTP port
apiKey changeme needed for authentication
bindAddress 0.0.0.0 Bind address (0.0.0.0 = all)

There are plenty of uses to manipulate your server with these commands from web if you wish to do so. Use and modify as needed for your server!

Project description from CurseForge.

Recent files

Arisu's REST API + releases and Hytale builds

1 of 1 releases match

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