This is a read-only copy of the MariaDB Knowledgebase generated on 2025-05-01. For the latest, interactive version please visit https://mariadb.com/kb/.

Configuring MaxScale's REST API

Overview

MaxScale's MaxScale's REST API is used by both MaxCtrl and MaxGUI.

The REST API is enabled by default. However, the default configuration is not optimal for production systems, because:

  • It only allows requests from the local host address by default.
  • It does not use TLS by default.
  • It used a hard-coded user (admin) and password (mariadb) by default.

Configuring MaxScale's REST API for Remote Connections

1. Configure MaxScale's REST API for remote connections by configuring several global parameters in maxscale.cnf.

ParameterDescription
admin_host• This parameter defines the network address that the REST API listens on.
• The default value is 127.0.0.1.
admin_port• This parameter defines the network port that the REST API listens on.
• The default value is 8989.

For example:

[maxscale]
...
admin_host            = 0.0.0.0
admin_port            = 8443

2. Restart the MaxScale instance.

$ sudo systemctl restart maxscale
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.