Requests - A REST API for Minecraft Servers
Requests is a PaperMC plugin that provides a RESTful API for Minecraft servers. With Requests, server admins can easily query and interact with their servers using simple REST semantics.
Features
Requests exposes a RESTful API that can be accessed using HTTP requests. The base URL for the API is http://localhost:5000 and can be configured in config.toml.
Authentication
Requests uses API keys to authenticate requests. There are two types of tokens:
To generate a master API key, use the following command in the server console:
The <name> parameter is optional and can be used to give the key a custom name. The generated API key will be displayed in the console.
To generate a player API key, use the following command in game:
To authenticate a request, include the API key in the Authorization header of the HTTP request:
API Endpoints
Requests provides the following API endpoints:
GET /server
Returns the status of the Minecraft server.
GET /players
Returns a list of online players on the Minecraft server.
GET /players/<uniqueId>
Returns the information of a player.
GET /worlds
Returns a list of worlds on the Minecraft server.
POST /command
Sends a command to the Minecraft server. This route can be used by master tokens only, and is disabled by default.
Example Requests
Get server status
Get player profile
Send command
License
Requests is licensed under the GPL-3 License.
Requests is a PaperMC plugin that provides a RESTful API for Minecraft servers. With Requests, server admins can easily query and interact with their servers using simple REST semantics.
Features
- RESTful API for Minecraft servers
- Query server information such as player count and server status
- Send commands to the server
- Authenticate requests using API keys
- Easy to use and integrate
Requests exposes a RESTful API that can be accessed using HTTP requests. The base URL for the API is http://localhost:5000 and can be configured in config.toml.
Code (toml (Unknown Language)):
[plugin]
salt = "change this" # Used for token generation - change for security
prefix = "<light_purple>[requests]<reset> "
[database]
tokens = "tokens.db"
players = "players.db"
[api]
port = 5000
vault = false # Enable Vault integration for economy data
luckperms = false # Enable LuckPerms integration for permission data
[api.danger]
remote_commands = false
salt = "change this" # Used for token generation - change for security
prefix = "<light_purple>[requests]<reset> "
[database]
tokens = "tokens.db"
players = "players.db"
[api]
port = 5000
vault = false # Enable Vault integration for economy data
luckperms = false # Enable LuckPerms integration for permission data
[api.danger]
remote_commands = false
Authentication
Requests uses API keys to authenticate requests. There are two types of tokens:
- Master tokens: Full access to all endpoints including admin operations (e.g., /command)
- Player tokens: Limited access to player-specific endpoints
To generate a master API key, use the following command in the server console:
Code (Bash):
/api generate-master
[force
]
The <name> parameter is optional and can be used to give the key a custom name. The generated API key will be displayed in the console.
To generate a player API key, use the following command in game:
Code (Text):
/api token new
To authenticate a request, include the API key in the Authorization header of the HTTP request:
Code (Bash):
Authorization: Bearer
<api_key
>
API Endpoints
Requests provides the following API endpoints:
GET /server
Returns the status of the Minecraft server.
GET /players
Returns a list of online players on the Minecraft server.
GET /players/<uniqueId>
Returns the information of a player.
GET /worlds
Returns a list of worlds on the Minecraft server.
POST /command
Sends a command to the Minecraft server. This route can be used by master tokens only, and is disabled by default.
Example Requests
Get server status
Code (Bash):
GET
/server HTTP
/
1.1
Authorization: Bearer <api_key >
User-Agent: Example Agent /0.0.1
Authorization: Bearer <api_key >
User-Agent: Example Agent /0.0.1
Get player profile
Code (Bash):
GET
/players
/<uniqueId
> HTTP
/
1.1
Authorization: Bearer <api_key >
User-Agent: Example Agent /0.0.1
Authorization: Bearer <api_key >
User-Agent: Example Agent /0.0.1
Send command
Code (Bash):
POST
/
command HTTP
/
1.1
Authorization: Bearer <master_key >
Content-Type: text /plain; charset=utf- 8
User-Agent: Example Agent /0.0.1
Content-Length: 17
say Hello, World !
Authorization: Bearer <master_key >
Content-Type: text /plain; charset=utf- 8
User-Agent: Example Agent /0.0.1
Content-Length: 17
say Hello, World !
License
Requests is licensed under the GPL-3 License.
Resource Information
Author:
----------
Total Downloads:
21
First Release:
Oct 13, 2025
Last Update:
Oct 13, 2025
Category:
---------------
All-Time Rating:
0 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings