Port 5550

HytaleAdminAPI Documentation

Complete REST API for managing and monitoring Hytale servers

Endpoints

Handler

REST

Architecture

JSON

Format

Quick Start

Test the API with a simple status check:

curl http://localhost:5550/api/status

Response:

{
  "status": "online",
  "players": { "online": 12, "max": 50 },
  "tps": 20.0,
  "uptime": "2h 15m 30s",
  "version": "0.3.1"
}

API Reference

1 Endpoint

Status

/api/status

Query server status, online status and basic information

1 Endpoint

Statistics

/api/stats

Advanced server statistics and performance metrics

1 Endpoint

Version

/api/version

API and server version information

5 Endpointe

Players

/api/players

Manage online players, retrieve information, kick, teleport

2 Endpointe

Chat

/api/chat

Send server chat messages and broadcast functions

3 Endpointe

Bans

/api/bans

Manage player bans (list, add, remove)

3 Endpointe

Mutes

/api/mutes

Manage player mutes

4 Endpointe

World

/api/world

Retrieve world information, control weather and time, save world

4 Endpointe

Warps

/api/warps

Manage teleportation points (create, list, delete, teleport)

3 Endpointe

Items

/api/items

Manage player inventory and give items

2 Endpointe

Icons

/api/icons

Manage server icon and MOTD (Message of the Day)

3 Endpointe

Permissions

/api/permissions

Manage player permissions

4 Endpointe

Whitelist

/api/whitelist

Manage server whitelist

2 Endpointe

Server Config

/api/config

Read and modify server configuration

4 Endpointe

Backup

/api/backup

Create, list and manage server backups

3 Endpointe

Deaths

/api/deaths

View player deaths and causes of death

3 Endpointe

Memories

/api/memories

Store and retrieve server memories and notes

Guides

Architecture & Overview

# Architecture & Overview The **HytaleAdminAPI** is a REST API that runs as a...

Authentication

# Authentication ## Token-Based Authentication The API uses **token-based...

Configuration

# Configuration The API is configured via the `config.yml` in the plugin dire...

Error Handling

# Error Handling ## HTTP Status Codes | Code | Meaning | |------|--------...

Persistence & Data

# Persistence & Data Storage ## Storage Systems The API uses various stora...

Background Processes

# Background Processes Some API operations trigger background processes on th...

PHP Client Example

# PHP Client Example A simple PHP client for the HytaleAdminAPI. ## Base C...