Frontend/documentation/server/blocked.md

45 lines
1022 B
Markdown
Raw Normal View History

2024-04-21 04:47:52 +00:00
---
2024-04-22 19:07:53 +00:00
title: Server Blocked Status
2024-04-21 04:47:52 +00:00
summary: Get the Mojang blocked status of a Minecraft server.
---
2024-04-22 19:07:53 +00:00
# Overview
2024-04-21 04:47:52 +00:00
The server blocked status endpoint allows you to get the Mojang blocked status of a Minecraft server.
## Endpoint
```
GET /server/blocked/:query
```
## 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 look up. | Yes |
## Example
```bash
curl -X GET "https://api.mcutils.xyz/server/blocked/play.hypixel.net"
```
## Response
```json
{
"blocked": false
}
```
## Errors
| Status Code | Description |
|-------------|-----------------------------------------------|
| 400 | The server was not found. |
| 429 | The Mojang API rate limit has been exhausted. |