Server Users

API usage instructions for listing, creating, updating, and deleting server users.

GET List Server Users

/api/v1/server-users?server=SERVER_UUID

To list all the server users on a server, send a GET request to /api/v1/server-users?server=SERVER_UUID.

GET Retrieve an Existing Server User

/api/v1/server-users/SERVER_USER_UUID

To retrieve information about an existing server user, send a GET request to /api/v1/server-users/SERVER_USER_UUID.

POST Create a Server User

/api/v1/server-users

To create a new server user, send a POST request to /api/v1/server-users. Username must start with a lowercase letter, then lowercase letters, digits, hyphens, or underscores, max 32 characters. The password is never returned.

isSudo is optional and defaults to false.

PATCH Update a Server User

/api/v1/server-users/SERVER_USER_UUID

To update a server user, send a PATCH request to /api/v1/server-users/SERVER_USER_UUID with password and/or isSudo. Username cannot be changed.

DELETE Delete a Server User

/api/v1/server-users/SERVER_USER_UUID

To delete a server user, send a DELETE request to /api/v1/server-users/SERVER_USER_UUID.