> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/maxscale/maxscale-management/configuring-maxscales-rest-api.md).

# Configuring MaxScale's REST API

## Overview

MaxScale's MaxScale's REST API is used by both [MaxCtrl](/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl.md) and [MaxGUI](/docs/maxscale/maxscale-management/maxgui.md).

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](/docs/maxscale/maxscale-management/maxgui/configuring-maxscale-for-maxgui.md) for remote connections by configuring several global parameters in maxscale.cnf.

| Parameter                                                                                                                              | Description                                                                                                 |
| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [admin\_host](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#admin_host) | • This parameter defines the network address that the REST API listens on.• The default value is 127.0.0.1. |
| [admin\_port](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#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
```

<sub>*This page is: Copyright © 2025 MariaDB. All rights reserved.*</sub>

{% @marketo/form formId="4316" %}