Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
GET/api/v1/bans/{id}

Retrieve a single ban by its ID.

Requires the Bans:View permission.

Path parameters

idstring· uuidrequired
The ban ID.

Ban object

idstring· uuidrequired
The ban ID.
playerUsernamestring
Banned player’s name (present if banned by username).
playerUuidstring· uuid
Banned player’s UUID (only if banned by username).
ipAddressstring
Banned IP address (present if banned by IP).
reasonstringrequired
Reason for the ban.
expiresAtstring· date-time
Ban expiry timestamp; null means permanent.
isActivebooleanrequired
Whether the ban is currently in effect.
createdAtstring· date-timerequired
Creation timestamp.
updatedAtstring· date-timerequired
Last update timestamp.