Frontend/documentation/server/preview.md
Liam 9e17145e90
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m30s
change docs and docs page
2024-04-22 20:07:53 +01:00

1.3 KiB

title summary
Server Preview Get the server list preview of a Minecraft server.

Overview

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

Server Icon

Errors

Status Code Description
400 The server was not found.
429 The Mojang API rate limit has been exhausted.