Manage administrative access to MaxScale. Learn to create, update, and delete admin users and manage their credentials for the REST API and MaxCtrl.
Admin users represent administrative users that are able to query and change MaxScale's configuration.
Get a single network user. The :name in the URI must be a valid network user name.
Status: 200 OK
Get all network users.
Status: 200 OK
Get all administrative users.
Status: 200 OK
Create a new network user. The request body must define at least the following fields.
data.id
The username.
data.attributes.password
Here is an example request body defining the network user my-user with the password my-password that is allowed to execute only read-only operations.
The :name part of the URI must be a valid user name.
Update network user. The following fields can be modified:
data.attributes.password
Changes the password for this user.
data.attributes.role or data.attributes.account
Modifying a user requires administrative privileges.
Here is an example request body that updates the password.
This page is licensed: CC BY-SA / Gnu FDL
data.attributes.role or data.attributes.account
The role that this user account uses. The set of available roles can be retrieved with GET /v1/roles. The old fixed set of roles that older versions of MaxScale used are also read from the account field, if used. If both the role and the account field are present, the value of the role field is used.
Changes the role for this user. If both fields are defined, the value of role is used.
GET /v1/users/:name
GET /v1/users/inet/:name{
"data": {
"attributes": {
"account": "admin",
"created": "Fri, 25 Jul 2025 15:43:46 GMT",
"last_login": "Fri, 25 Jul 2025 15:44:03 GMT",
"last_update": null,
"name": "admin",
"permissions": [
"admin",
"edit",
"view",
"sql"
]
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/admin/"
},
"type": "users"
},
"links": {
"self": "http://localhost:8989/v1/users/admin/"
}
}GET /v1/users
GET /v1/users/inet{
"data": [
{
"attributes": {
"account": "admin",
"created": "Fri, 25 Jul 2025 15:43:46 GMT",
"last_login": "Fri, 25 Jul 2025 15:44:03 GMT",
"last_update": null,
"name": "admin",
"permissions": [
"admin",
"edit",
"view",
"sql"
]
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/admin/"
},
"type": "users"
}
],
"links": {
"self": "http://localhost:8989/v1/users/"
}
}GET /v1/users{
"data": [
{
"attributes": {
"account": "admin",
"created": "Fri, 25 Jul 2025 15:43:46 GMT",
"last_login": "Fri, 25 Jul 2025 15:44:03 GMT",
"last_update": null,
"name": "admin",
"permissions": [
"admin",
"edit",
"view",
"sql"
]
},
"id": "admin",
"links": {
"self": "http://localhost:8989/v1/users/admin/"
},
"type": "users"
}
],
"links": {
"self": "http://localhost:8989/v1/users/"
}
}POST /v1/users
POST /v1/users/inet{
"data": {
"id": "my-user", // The user to create
"attributes": {
"password": "my-password", // The password to use for the user
"role": "admin" // The type of the account
}
}
}Status: 204 No ContentDELETE /v1/users/:name
DELETE /v1/users/inet/:nameStatus: 204 No ContentPATCH /v1/users/:name
PATCH /v1/users/inet/:name{
"data": {
"attributes": {
"password": "new-password"
}
}
}Status: 204 No Content