Skip to content

tiproxy: info about API access restrictions #21865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+4 −0
Open

tiproxy: info about API access restrictions #21865

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3b671a
tiproxy: info about API access restrictions
dveeden Oct 3, 2025
7a2a7da
Apply suggestion from @gemini-code-assist[bot]
dveeden Oct 3, 2025
75f8cb5
fixup
dveeden Oct 3, 2025
a9c33f1
Update and extend
dveeden Oct 7, 2025
45889f7
Update tiproxy/tiproxy-api.md
dveeden Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions tiproxy/tiproxy-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,7 @@ The output is as follows:
```bash
curl http://127.0.0.1:3080/metrics/
```

## Access control

You can restrict access to the TiProxy API by enabling TLS via [`server-http-tls`](/tiproxy/tiproxy-configuration.md#server-http-tls) and setting the `cert-allowed-cn` setting in the `server-http-tls` subsection that is part of the [`security`](/tiproxy/tiproxy-configuration.md#security) section. TiProxy then uses the common name in the client certificate to [verify the identity of the caller](/enable-tls-between-components.md#verify-component-callers-identity). Alternatively, if you do not use TLS, you can control access using firewall rules.