Skip to content

docs: add stream proxy example for limit-conn plugin (#4933) #13052

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
ashruthg wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −0
Open

docs: add stream proxy example for limit-conn plugin (#4933) #13052

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions docs/en/latest/plugins/limit-conn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,3 +425,22 @@ Response: 429
```

This shows the two routes configured in different APISIX instances share the same quota.

## Use limit-conn in Stream Proxy

The `limit-conn` plugin can also be used in stream proxy mode.

Example configuration for stream proxy:

```json
Copy link
Contributor

@Baoyuantop Baoyuantop Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be best to provide a complete curl example.

{
"plugins": {
"limit-conn": {
"conn": 1,
"burst": 0,
"default_conn_delay": 0.1,
"key": "remote_addr"
}
}
}
When used in stream proxy mode, only remote_addr and server_addr can be used as the key.
Loading