Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Suspend a player and end their sessions

POST/api/admin/players/{id}/ban
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Request body
requiredapplication/json
reasonstring
expiresAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
Responses
200

Success

okbooleanrequired
400

Response for status 400

errorstringrequired
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST '/api/admin/players/string/ban' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}'
Response
{
  "ok": true
}

Was this page helpful?