POST
/api/v1/server/logs
Request
Response
201
Created
The player's Roblox ID is looked up from their username. A ban also completes the player's active ban BOLO.
To make a ban temporary, send type: 2, tempBan: true and an unbanAt up to a year away:
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Body
createdBystringrequiredMember ID of the staff member creating the log.
textstringrequiredReason, up to 2048 characters.
typeintegerrequiredLog type:
0 Warning, 1 Kick, 2 Ban, 3 Ban BOLO, 4 Note or 5 Custom. Your custom types are listed by List Log Types.usernamestringrequiredRoblox username of the player, 3-20 letters, numbers or underscores.
descriptionstring | nullExtra details, up to 2048 characters. Needs premium.
dontCountbooleanLeave the log out of punishment counts.
resetPunishmentsCountbooleanReset the player's punishment count. Notes only.
tempBanbooleanMake a ban temporary. Needs
unbanAt.typeIdstring | nullCustom log type ID. Required when
type is 5.unbanAtinteger | nullWhen a temporary ban ends, up to a year away.
Response
201 Created
createdAtintegerrequiredWhen it was created.
createdBystringrequiredMember ID of the staff member who created it, or
SYSTEM.editedBystring[]requiredMember IDs of everyone who edited it.
idstringrequiredUnique ID.
proofstring[]requiredProof file keys.
serverIdstringrequiredServer ID.
textstringrequiredReason.
typeintegerrequiredLog type:
0 Warning, 1 Kick, 2 Ban, 3 Ban BOLO, 4 Note or 5 Custom.usernamestringrequiredRoblox username of the player.
banBoloCreatedbooleanrequiredWhether this log pushed the player over the automatic ban BOLO threshold.
dmDisabledbooleanrequiredWhether the player turned off moderation DMs.
completedBystring | nullFor ban BOLOs, member ID of who completed it.
deniedBystring | nullFor ban BOLOs, member ID of who denied it.
descriptionstring | nullExtra details.
dontCountboolean | nullWhether it's left out of punishment counts.
expiredboolean | nullWhether it has expired.
expiredAtinteger | nullWhen it expired.
expiredBystring | nullMember ID of who expired it.
hiddenboolean | nullWhether it's hidden from the player.
hiddenBystring | nullMember ID of who hid it.
robloxIdstring | nullRoblox user ID of the player.
tempBanboolean | nullWhether the ban is temporary.
typeIdstring | nullCustom log type ID, when
type is 5.unbanAtinteger | nullWhen a temporary ban ends.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | Premium is required, or createdBy lacks permission |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |
502 | next did not confirm the write. Check whether it applied before retrying. |
503 | Write endpoints are not configured on this deployment |