Frontend/documentation/server/favicon.md

41 lines
1.0 KiB
Markdown
Raw Normal View History

2024-04-21 04:47:52 +00:00
---
2024-04-22 19:07:53 +00:00
title: Server Favicon
2024-04-21 04:47:52 +00:00
summary: Get the favicon of a Minecraft server.
---
2024-04-22 19:07:53 +00:00
# Overview
2024-04-21 04:47:52 +00:00
The server favicon endpoint allows you to get the favicon of a Minecraft server.
## Endpoint
```
2024-04-21 05:27:01 +00:00
GET /server/icon/:query
2024-04-21 04:47:52 +00:00
```
## Platforms
This endpoint is only available for Java servers.
## Parameters
| Parameter | Description | Required |
|-----------|---------------------------------------------------------------------------|----------|
| query | The IP address or hostname of the server you want to get the favicon for. | Yes |
## Example
```bash
curl -X GET "https://api.mcutils.xyz/server/icon/hypixel.net" -H "accept: image/png"
```
## Response
![Server Icon](https://api.mcutils.xyz/server/icon/play.hypixel.net)
## Errors
| Status Code | Description |
|-------------|-----------------------------------------------|
| 400 | The server was not found. |
| 429 | The Mojang API rate limit has been exhausted. |