# MinecraftREST<\/p>\n
The first stable release of MinecraftREST, a powerful REST API interface for Minecraft servers that provides secure endpoints for server management and player interactions.<\/p>\n
## \ud83d\ude80 Features<\/p>\n
– \ud83d\udd12 Secure JWT Authentication
\n– \ud83c\udf10 RESTful API endpoints for server management
\n– \ud83d\udc65 Player management (kick, gamemode, messaging)
\n– \ud83d\udcca Server information and statistics
\n– \u26a1 Rate limiting protection
\n– \ud83d\udd0d Real-time player and world data<\/p>\n
## \ud83d\udccb Requirements<\/p>\n
– Java 17 or higher
\n– Spigot\/Paper server 1.20.4<\/p>\n
## \ud83d\udd27 Installation<\/p>\n
1. Download the `minecraft-rest-1.0.0.jar` from this release
\n2. Place it in your server’s `plugins` folder
\n3. Start\/restart your server
\n4. Configure the plugin in `plugins\/MinecraftREST\/config.yml`<\/p>\n
## Configuration<\/p>\n
The plugin creates a `config.yml` file in `plugins\/MinecraftREST\/` with the following options:<\/p>\n
“`yaml
\n# API Configuration
\napi-port: 4567 # The port on which the HTTP API will run<\/p>\n
# Security Configuration
\nsecurity:
\n jwt-secret: “your-secret-key-here” # Change this to a secure random string
\n max-requests-per-minute: 60 # Rate limiting threshold
\n admin-credentials:
\n username: “admin” # Change this to a secure username
\n password: “change-this-password” # Change this to a secure password
\n“`<\/p>\n
\u26a0\ufe0f **Important**: Change the default security settings before using in production!<\/p>\n
## API Documentation<\/p>\n
The API is documented using the OpenAPI (Swagger) specification. You can find the full API documentation in:
\n– `api-docs\/swagger.yaml` – OpenAPI 3.0 specification file
\n– Import this file into tools like:
\n – Swagger Editor
\n – Postman
\n – Insomnia<\/p>\n
### Quick API Overview<\/p>\n
All endpoints except `\/api\/auth\/login` require JWT authentication via Bearer token.<\/p>\n
1. **Authentication**
\n – `POST \/api\/auth\/login` – Get JWT token<\/p>\n
2. **Server Management**
\n – `GET \/api\/server\/info` – Get server information
\n – `POST \/api\/server\/command` – Execute console command
\n – `POST \/api\/broadcast` – Broadcast message<\/p>\n
3. **Player Management**
\n – `GET \/api\/players` – List online players
\n – `POST \/api\/player\/message` – Send message to player
\n – `POST \/api\/player\/kick` – Kick player
\n – `POST \/api\/player\/gamemode` – Change player gamemode<\/p>\n","protected":false},"excerpt":{"rendered":"
MinecraftREST, a powerful REST API interface for Minecraft servers that provides secure endpoints for server management and player interactions.<\/p>\n","protected":false},"featured_media":102240,"template":"","meta":{"_minecraft_slug":"minecraftrest","_minecraft_project_id":"cPxGOxRw","_minecraft_author":"aymond","_minecraft_license":"MIT","_minecraft_downloads":80,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"minecraftrest.zip","_minecraft_size_bytes":16150604,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T20:15:37.638275Z","_minecraft_date_created":"2025-03-20T02:30:31.604541Z","_minecraft_date_modified":"2025-03-16T18:40:22.732250Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/minecraftrest","_minecraft_icon_attachment_id":102240,"_minecraft_imported_at":"2026-06-05T20:58:09+00:00","_minecraft_import_hash":"31d583265f71da730454392841e6d7b9","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,127,129,92],"mod_loader":[130,132,134],"minecraft_version":[59,36,60,93,94,101,102],"class_list":["post-102239","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-paper","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-spigot","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6"],"yoast_head":"\n