# LittleWeb
\nSpigot plugin that exposes a REST API for developers to consume<\/p>\n
> Requires plugin LittleLink<\/p>\n
## Configuration<\/p>\n
“`yml
\napi:
\n port: 8888
\n address: localhost
\n “`<\/p>\n
– `port` where the HTTP Jetty Server will bind too, must be greater than 1024 since minecraft servers **shouldn’t be run as root**
\n– `address` where the HTTP Jetty Server will listen to. If you want to expose the api without a reverse proxy you can do so by setting it to `0.0.0.0`<\/p>\n
## API Endpoints<\/p>\n
Plugin provides currently only 2 endpoints<\/p>\n
### GET `\/api\/status`<\/p>\n
Sample response:
\n“`json
\n{
\n “players”: {
\n “max”: 30,
\n “online”: 3,
\n “list”: [
\n {
\n “id”: “12b7b9c9-7611-4679-bae8-94ed55a6b7a4”,
\n “name”: “jb_himawari”
\n },
\n {
\n “id”: “eaf3de81-e7e9-4395-a0b1-456735b63aa7”,
\n “name”: “Twan_MC”
\n },
\n {
\n “id”: “5be97b0c-657f-4fb9-baa8-b463b3040c28”,
\n “name”: “Rekcah_”
\n }
\n ]
\n },
\n “world”: {
\n “seed”: “-4255308501429674615”,
\n “time”: 2832,
\n “type”: “minecraft:normal”
\n },
\n “plugins”: [
\n {
\n “name”: “CoreProtect”,
\n “version”: “21.2”,
\n “authors”: [
\n “Intelli”
\n ],
\n “description”: “Provides block protection for your server.n”,
\n “website”: “http:\/\/coreprotect.net”
\n },
\n {
\n “name”: “LuckPerms”,
\n “version”: “5.4.26”,
\n “authors”: [
\n “Luck”
\n ],
\n “description”: “A permissions plugin”,
\n “website”: “https:\/\/luckperms.net”
\n },
\n {
\n “name”: “CustomBeaconRange”,
\n “version”: “0.1”,
\n “authors”: [
\n “Soussou”
\n ],
\n “description”: “A plugin to customize beacon effect range”,
\n “website”: null
\n },
\n {
\n “name”: “LittleLink”,
\n “version”: “1.7”,
\n “authors”: [
\n “Pequla”
\n ],
\n “description”: “Allows for simple whitelisting on the minecraft server”,
\n “website”: “https:\/\/pequla.com”
\n },
\n {
\n “name”: “LittleWeb”,
\n “version”: “1.3”,
\n “authors”: [
\n “Pequla”
\n ],
\n “description”: “Exposes a public REST API from data found in LittleLink”,
\n “website”: “https:\/\/github.com\/Pequla\/LittleWeb”
\n },
\n {
\n “name”: “LittleHooks”,
\n “version”: “1.2”,
\n “authors”: [
\n “Pequla”
\n ],
\n “description”: “Discord webhook integration for your minecraft server”,
\n “website”: “https:\/\/pequla.com”
\n },
\n {
\n “name”: “spark”,
\n “version”: “1.9.9”,
\n “authors”: [
\n “Luck”
\n ],
\n “description”: “spark is a performance profiling plugin\/mod for Minecraft clients, servers and proxies.”,
\n “website”: “https:\/\/spark.lucko.me\/”
\n },
\n {
\n “name”: “Vault”,
\n “version”: “1.7.3-b131”,
\n “authors”: [
\n “cereal”,
\n “Sleaker”,
\n “mung3r”
\n ],
\n “description”: “Vault is a Permissions & Economy API to allow plugins to more easily hook into these systems without needing to hook each individual system themselves.”,
\n “website”: “https:\/\/dev.bukkit.org\/projects\/vault”
\n },
\n {
\n “name”: “Essentials”,
\n “version”: “2.19.5-dev+23-6816eb4”,
\n “authors”: [
\n “Zenexer”,
\n “ementalo”,
\n “Aelux”,
\n “Brettflan”,
\n “KimKandor”,
\n “snowleo”,
\n “ceulemans”,
\n “Xeology”,
\n “KHobbits”,
\n “md_5”,
\n “Iaccidentally”,
\n “drtshock”,
\n “vemacs”,
\n “SupaHam”,
\n “mdcfe”,
\n “JRoy”,
\n “pop4959”
\n ],
\n “description”: “Provides an essential, core set of commands for Bukkit.”,
\n “website”: “https:\/\/essentialsx.net\/”
\n },
\n {
\n “name”: “EssentialsChat”,
\n “version”: “2.19.5-dev+23-6816eb4”,
\n “authors”: [
\n “Zenexer”,
\n “ementalo”,
\n “Aelux”,
\n “Brettflan”,
\n “KimKandor”,
\n “snowleo”,
\n “ceulemans”,
\n “Xeology”,
\n “KHobbits”,
\n “md_5”,
\n “Okamosy”,
\n “Iaccidentally”,
\n “mdcfe”,
\n “JRoy”,
\n “triagonal”
\n ],
\n “description”: “Provides chat control features for Essentials. Requires Permissions.”,
\n “website”: “https:\/\/essentialsx.net\/”
\n },
\n {
\n “name”: “LWC”,
\n “version”: “2.2.7-ad0f824”,
\n “authors”: [
\n “Hidendra”,
\n “pop4959”,
\n “Me_Goes_RAWR”
\n ],
\n “description”: “Inventory protection & management utilizing SQLite or MySQL as its backend Other blocks can also be protected individually, if configured.n”,
\n “website”: “https:\/\/www.spigotmc.org\/resources\/lwc-extended.69551\/”
\n },
\n {
\n “name”: “EssentialsSpawn”,
\n “version”: “2.19.5-dev+23-6816eb4”,
\n “authors”: [
\n “Zenexer”,
\n “ementalo”,
\n “Aelux”,
\n “Brettflan”,
\n “KimKandor”,
\n “snowleo”,
\n “ceulemans”,
\n “Xeology”,
\n “KHobbits”,
\n “SupaHam”,
\n “mdcfe”,
\n “DoNotSpamPls”,
\n “JRoy”
\n ],
\n “description”: “Provides spawn control commands, utilizing Essentials.”,
\n “website”: “https:\/\/essentialsx.net\/”
\n },
\n {
\n “name”: “Harbor”,
\n “version”: “1.6.3”,
\n “authors”: [
\n “TechToolbox (@nkomarn)”
\n ],
\n “description”: “Harbor redefines how sleep works in your server, making it easier for all the online players to get in bed quickly and skip through the night!”,
\n “website”: “https:\/\/nkomarn.xyz”
\n }
\n ],
\n “version”: “git-Paper-41 (MC: 1.19)”
\n}
\n“`<\/p>\n
> When there are no players online the `list` will be returned as an empty array<\/p>\n
There are also additional endpoints for targeting specific fields:<\/p>\n
– GET `\/api\/status\/players` (Returns only the `players` object)
\n– GET `\/api\/status\/plugins` (Returns only the `plugins` array)
\n– GET `\/api\/status\/world` (Returns only the `world` object)<\/p>\n
### GET `\/api\/user`<\/p>\n
> The `uuid` query parameter is mandatory. So the example url should be `\/api\/user?uuid=69c154a4-0a6a-4578-b169-c4be379e1e8e`<\/p>\n
Sample response:
\n“`json
\n{
\n “id”: “407635624787443712”,
\n “name”: “LYuae#5987”,
\n “nickname”: “Yuae %”,
\n “avatar”: “https:\/\/cdn.discordapp.com\/avatars\/407635624787443712\/8d80be04a42c5622aa5ebe358c68ea67.png”
\n}
\n“`<\/p>\n
### GET `\/api\/players`<\/p>\n
> Displays all players that have ever joined the server<\/p>\n
Sample response:
\n“`json
\n[
\n {
\n “id”: “12b7b9c9-7611-4679-bae8-94ed55a6b7a4”,
\n “name”: “jb_himawari”
\n },
\n {
\n “id”: “eaf3de81-e7e9-4395-a0b1-456735b63aa7”,
\n “name”: “Twan_MC”
\n },
\n {
\n “id”: “5be97b0c-657f-4fb9-baa8-b463b3040c28”,
\n “name”: “Rekcah_”
\n }
\n]
\n“`<\/p>\n
### Exceptions and Status codes<\/p>\n
If there is an error you can receive the following status codes:<\/p>\n
– `404 NOT FOUND` – The required object was not found
\n– `400 BAD REQUEST` – There was an error processing your request’s arguments
\n– `500 SERVER ERROR` – Something went wrong internally, you should probably restart the minecraft server<\/p>\n
Sample response:
\n“`json
\n{
\n “message”: “User not found”,
\n “timestamp”: 1655245110448
\n}
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"
Spigot plugin that exposes a REST API for developers to consume<\/p>\n","protected":false},"featured_media":94690,"template":"","meta":{"_minecraft_slug":"littleweb","_minecraft_project_id":"5zBkFVTG","_minecraft_author":"Pequla","_minecraft_license":"MIT","_minecraft_downloads":157,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"littleweb.zip","_minecraft_size_bytes":2891947,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T13:21:22.651916Z","_minecraft_date_created":"2023-08-21T23:02:20.391172Z","_minecraft_date_modified":"2023-08-17T16:56:40.666724Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/littleweb","_minecraft_icon_attachment_id":94690,"_minecraft_imported_at":"2026-06-05T10:08:36+00:00","_minecraft_import_hash":"2bf33f6c4d42de3ae5270e703b8bb772","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,127,128,867,129,92],"mod_loader":[132,133,134],"minecraft_version":[54,55,56,57,58,59,36],"class_list":["post-94707","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-social","mod_category-spigot","mod_category-utility","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1"],"yoast_head":"\n