Liam
e6a28ed268
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s
1.3 KiB
1.3 KiB
| title | summary |
|---|---|
| Server - Preview | Get the server list preview of a Minecraft server. |
Server - Preview
The server preview endpoint allows you to get the server list preview of a Minecraft server.
Endpoint
GET /server/:platform/preview/:query
Platforms
| Platform | Description |
|---|---|
| bedrock | Bedrock Edition |
| java | Java Edition |
Parameters
| Parameter | Description | Required |
|---|---|---|
| platform | The platform of the server you want to get the preview for. | Yes |
| query | The IP address or hostname of the server you want to get the preview for. | Yes |
Example
curl -X GET "https://api.mcutils.xyz/server/java/preview/hypixel.net" -H "accept: image/png"
Response
Errors
| Status Code | Description |
|---|---|
| 400 | The server was not found. |
| 429 | The Mojang API rate limit has been exhausted. |