Configuring MaxScale's REST API

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.

    Parameter

    Description

    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.

    On operating systems that use systemd:

    $ sudo systemctl restart maxscale
    

    On systems that use Upstart:

    $ sudo service maxscale restart