> 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/administrative-tools-for-mariadb-maxscale-maxctrl/connecting-to-maxscale-using-tls-with-maxctrl.md).

# Connecting to MaxScale using TLS with MaxCtrl

## Overview

\_MaxCtrl is a command-line utility that can perform administrative tasks using [MaxScale's REST API](/docs/maxscale/reference/maxscale-rest-api.md). It is possible to connect to MaxScale using TLS with MaxCtrl.

## Connecting to MaxScale using TLS

1. [Create a basic](/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/creating-a-rest-api-user-for-maxscale-with-maxctrl.md#creating-a-basic-user) or [admin user](/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/creating-a-rest-api-user-for-maxscale-with-maxctrl.md#creating-an-admin-user), depending on what kind of user you need:

```bash
$ maxctrl create user "maxscale_rest_admin" "maxscale_rest_admin_password" --type=admin
```

Replace `maxscale\_rest\_admin` and `maxscale\_rest\_admin\_password` with the desired user and password.

2. If you want to use MaxCtrl remotely, [configure the REST API for remote connections](/docs/maxscale/maxscale-management/configuring-maxscales-rest-api.md#configuring-maxscales-rest-api-for-remote-connections). Several global parameters must be configured 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:

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

3. [Enable TLS for MaxScale's REST API](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#tlsssl-encryption) Several global parameters must be configured in maxscale.cnf.

| Parameter                                                                                                                                              | Description                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
| [admin\_ssl\_key](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#admin_ssl_key)          | \* This parameter defines the private key used by the REST API.                     |
| [admin\_ssl\_cert](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#admin_ssl_cert)        | \* This parameter defines the certificate used by the REST API.                     |
| [admin\_ssl\_ca\_cert](/docs/maxscale/maxscale-management/deployment/installation-and-configuration/maxscale-configuration-guide.md#admin_ssl_ca_cert) | \*This parameter defines the CA certificate that signed the REST API's certificate. |

For example:

```ini
[maxscale]
...
admin_ssl_key=/certs/server-key.pem
admin_ssl_cert=/certs/server-cert.pem
admin_ssl_ca_cert=/certs/ca-cert.pem
```

4. Ensure that the client also has a TLS certificate, a private key, and the CA certificate.
5. Use [MaxCtrl](/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl.md) to connect with TLS:

```ini
$ maxctrl --secure
   --user=maxscale_rest_admin
   --password=maxscale_rest_admin_password
   --hosts=192.0.2.100:8443
   --tls-key=/certs/client-key.pem
   --tls-cert=/certs/client-cert.pem
   --tls-ca-cert=/certs/ca.pem
```

Replace `maxscale_rest_admin` and `maxscale_rest_admin_password` with the actual user and password.

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

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mariadb.com/docs/maxscale/maxscale-management/administrative-tools-for-mariadb-maxscale-maxctrl/connecting-to-maxscale-using-tls-with-maxctrl.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.