mostly completed docs
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s
All checks were successful
Deploy App / docker (ubuntu-latest) (push) Successful in 1m38s
This commit is contained in:
45
documentation/server/preview.md
Normal file
45
documentation/server/preview.md
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Server - Preview
|
||||
summary: 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
|
||||
|
||||
```bash
|
||||
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. |
|
Reference in New Issue
Block a user