Developer API
Get Punishment
Get a specific punishment by its ID.
GET /v1/minecraft/punishments/{punishmentId}
Retrieve the details of a specific punishment by its ID.
Authentication
Requires the X-API-Key header with your server's API key.
X-API-Key: your-api-key-hereRequest
Headers
| Header | Type | Required | Description |
|---|---|---|---|
X-API-Key | string | Yes | Your server's API key. |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
punishmentId | string | Yes | The unique ID of the punishment. |
Example
GET /v1/minecraft/punishments/abc123Response
200 OK
{
"status": 200,
"punishment": {
"id": "abc123",
"type": "Cheating",
"category": "BAN",
"reason": "Use of unauthorized client modifications",
"issuerName": "StaffMember",
"issuedAt": 1699000000000,
"expiration": 1700000000000
}
}Error Responses
| Status Code | Description |
|---|---|
401 | Missing or invalid API key. |
404 | Punishment not found for the given ID. |
429 | Rate limit exceeded. |
500 | Internal server error. |