# REST HTTP API<\/p>\n
<\/p>\n
A Minecraft Paper plugin that allows executing server commands via HTTP requests and get various information. Perfect for integrating external tools, web dashboards, or automation scripts with your Minecraft server.<\/p>\n
## Features<\/p>\n
– Execute Minecraft commands via HTTP API
\n– RESTful endpoints for server information
\n– Bearer token authentication
\n– Command queuing for offline players
\n– Support for waiting for players to join before executing commands
\n– Auto-generated interactive API documentation<\/p>\n
## Requirements<\/p>\n
– Minecraft Server running Paper or a Paper fork (Spigot, Bukkit may work but not tested)
\n– Java 17 or higher<\/p>\n
## Installation<\/p>\n
### From Release<\/p>\n
1. Download the latest release from the Releases page
\n2. Drop the `http-commands-*.jar` file into your server’s `plugins` folder
\n3. Restart or reload your server<\/p>\n
### From Source<\/p>\n
“`bash
\n# Clone the repository
\ngit clone https:\/\/github.com\/lelenaic\/minecraft-http-commands-plugin.git
\ncd http-commands-plugin<\/p>\n
# Build the plugin
\n.\/gradlew build<\/p>\n
# The JAR file will be in build\/libs\/
\ncp build\/libs\/http-commands-*.jar \/path\/to\/server\/plugins\/
\n“`<\/p>\n
## Configuration<\/p>\n
After first launch, the plugin creates `plugins\/http-commands\/config.yml`.<\/p>\n
### Security Recommendations<\/p>\n
1. **Change the bearer token** – Use a strong, random string
\n2. **Use HTTPS** – Always use a reverse proxy with TLS\/SSL
\n3. **Firewall** – Only allow access from trusted IPs if possible<\/p>\n
### Using with a Reverse Proxy (Recommended)<\/p>\n
For production, use a reverse proxy like Nginx or Caddy with HTTPS:<\/p>\n
**Nginx example:**
\n“`nginx
\nserver {
\n listen 443 ssl;
\n server_name mc-api.example.com;<\/p>\n
ssl_certificate \/path\/to\/cert.pem;
\n ssl_certificate_key \/path\/to\/key.pem;<\/p>\n
location \/ {
\n proxy_pass http:\/\/127.0.0.1:8080;
\n proxy_set_header Host $host;
\n proxy_set_header X-Real-IP $remote_addr;
\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
\n proxy_set_header X-Forwarded-Proto $scheme;
\n }
\n}
\n“`<\/p>\n
## API Documentation<\/p>\n
Interactive API documentation is generated from the OpenAPI specification.
\nYou can access the API documentation from here: https:\/\/minecraft-http-commands-plugin-api-doc.lenaic.me<\/p>\n
### Generating Documentation<\/p>\n
“`bash
\n# Generate HTML API documentation
\n.\/gradlew openApiGenerate<\/p>\n
# Output will be in docs\/index.html
\n“`<\/p>\n
### Viewing Documentation<\/p>\n
Open `docs\/index.html` in a web browser to view the interactive Swagger UI.<\/p>\n
The documentation includes:
\n– All available endpoints
\n– Request\/response schemas
\n– Example requests
\n– Try-it-out functionality<\/p>\n
## Commands<\/p>\n
### \/http-commands reload<\/p>\n
Reloads the plugin configuration and restarts the HTTP server.<\/p>\n
“`bash
\n\/http-commands reload
\n“`<\/p>\n
Requires permission: `httpcommands.reload`<\/p>\n
## Building<\/p>\n
“`bash
\n# Build the plugin
\n.\/gradlew build<\/p>\n
# Build and generate API docs
\n.\/gradlew build openApiGenerate
\n“`<\/p>\n
The output JAR will be in `build\/libs\/`.<\/p>\n
## License<\/p>\n
[MIT License](LICENSE)<\/p>\n","protected":false},"excerpt":{"rendered":"
A Minecraft Paper plugin that allows executing server commands and get various information via HTTP requests. Perfect for integrating external tools, web dashboards, or automation scripts with your Minecraft server.<\/p>\n","protected":false},"featured_media":132671,"template":"","meta":{"_minecraft_slug":"rest-http-api","_minecraft_project_id":"UYulHID6","_minecraft_author":"lelenaic","_minecraft_license":"MIT","_minecraft_downloads":8,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"rest-http-api.zip","_minecraft_size_bytes":61860,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T23:17:58.782568Z","_minecraft_date_created":"2026-04-10T19:56:32.626295Z","_minecraft_date_modified":"2026-03-24T18:17:58.544002Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/rest-http-api","_minecraft_icon_attachment_id":132671,"_minecraft_imported_at":"2026-06-07T19:50:43+00:00","_minecraft_import_hash":"64ca9dfab9dc86c106fd93e7c138f06e","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[125,873,126,127,92],"mod_loader":[131,132],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-132670","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-folia","mod_category-library","mod_category-management","mod_category-paper","mod_category-utility","mod_loader-folia","mod_loader-paper","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n