Preview Punishment Preview a punishment's calculated severity and points before issuing.
Preview the calculated severity, offense level, and points for a punishment before issuing it. This allows staff to see what the outcome of a punishment would be based on the player's history and the server's configured point thresholds.
Requires the X-API-Key header with your server's API key.
Header Type Required Description X-API-Keystring Yes Your server's API key.
Parameter Type Required Description playerUuidstring Yes The UUID of the player to preview the punishment for. typeOrdinalinteger Yes The punishment type ordinal (0-14).
GET /v1/minecraft/punishments/preview?playerUuid=069a79f4-44e9-4726-a5be-fca90e38aaf5&typeOrdinal=7 { "status" : 200 , "success" : true , "socialStatus" : "Tier 1" , "gameplayStatus" : "Tier 2" , "socialPoints" : 3 , "gameplayPoints" : 8 , "offenseLevel" : "low" , "singleSeverity" : { "action" : "ban" , "duration" : 604800000 }, "lenient" : { "action" : "ban" , "duration" : 259200000 }, "regular" : { "action" : "ban" , "duration" : 604800000 }, "aggravated" : { "action" : "ban" , "duration" : 1209600000 } } Field Type Description statusinteger HTTP status code. successboolean Whether the preview was generated successfully. socialStatusstring The player's current social offender tier. gameplayStatusstring The player's current gameplay offender tier. socialPointsinteger The player's accumulated social offense points. gameplayPointsinteger The player's accumulated gameplay offense points. offenseLevelstring The calculated offense level (e.g., "low", "medium", "high"). singleSeverityobject The default punishment outcome. lenientobject The punishment outcome if lenient severity is selected. regularobject The punishment outcome if regular severity is selected. aggravatedobject The punishment outcome if aggravated severity is selected.
Status Code Description 400Missing or invalid query parameters. 401Missing or invalid API key. 404Player not found.