Permissions

Base: /api/permissions

Manage player permissions

Handler: PermissionHandler
GET /api/permissions/{player}

Show Permissions

Shows all permissions of a player.

Parameters

Name Type Required Description
player string Yes Player name

Response Example

{"player":"Steve","permissions":["hytale.cmd.warp","hytale.cmd.home","hytale.admin"],"groups":["default","moderator"]}

cURL

curl http://localhost:5550/api/permissions/Steve
POST /api/permissions/{player}/add

Add Permission

Adds a permission to a player.

Parameters

Name Type Required Description
player string Yes Player name

Request Body

Field Type Required Description
permission string Yes Permission node (e.g. "hytale.admin")

Response Example

{"success":true,"message":"Permission hytale.admin added to Steve"}

cURL

curl -X POST http://localhost:5550/api/permissions/Steve/add \
  -H 'Content-Type: application/json' \
  -d '{"permission":"hytale.admin"}'
DELETE /api/permissions/{player}/{permission}

Remove Permission

Removes a permission from a player.

Parameters

Name Type Required Description
player string Yes Player name
permission string Yes Permission node

Response Example

{"success":true,"message":"Permission hytale.admin removed from Steve"}

cURL

curl -X DELETE http://localhost:5550/api/permissions/Steve/hytale.admin