Skip to content

Commit ddf97b7

Browse files
Management plugin: document management.http.max_body_size
1 parent b6f7383 commit ddf97b7

File tree

3 files changed

+56
-4
lines changed

3 files changed

+56
-4
lines changed

docs/management/index.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ core RabbitMQ features and do not require or rely on this plugin.
4545

4646
This guide covers:
4747

48-
* [Basic usage](#usage) of management UI and [HTTP API](#http-api)
48+
* [Basic usage](#usage) of management UI
49+
* The [HTTP API](#http-api) provided by the management plugin
4950
* General plugin [configuration](#configuration)
5051
* [Reverse proxy (Nginx or Apache)](#http-api-proxy) in front of the HTTP API
5152
* How to [enable HTTPS for management UI](#single-listener-https) and its underlying API
@@ -411,7 +412,7 @@ Given above configuration, when a user visits the management UI, the following t
411412
:::
412413

413414
:::warning
414-
`management.oauth_metadata_url` and `management.oauth_resource_servers.$id.oauth_metadata_url` are deprecated. You should configure the OpenId Discovery endpoint's path as it is explained [here](./oauth2#discovery-endpoint-params).
415+
`management.oauth_metadata_url` and `management.oauth_resource_servers.$id.oauth_metadata_url` are deprecated. You should configure the OpenId Discovery endpoint's path as it is explained [here](./oauth2#discovery-endpoint-params).
415416
These two settings will no longer exist in RabbitMQ 4.2.0. In the meantime, RabbitMQ will support them until you update your configuration.
416417
:::
417418

@@ -698,6 +699,22 @@ Some API endpoints return a lot of information. The volume can be reduced
698699
by filtering what columns are returned by `HTTP GET` requests. See
699700
<a href={`https://rawcdn.githack.com/rabbitmq/rabbitmq-server/${RabbitMQServerGitTag()}/deps/rabbitmq_management/priv/www/api/index.html`}>latest HTTP API documentation</a> for details.
700701

702+
### Maximum HTTP Request Body Limit {#http-body-size-limit}
703+
704+
A few RabbitMQ HTTP API endpoints can potentially receive large payloads,
705+
most notably the endpoint used for [definition import](./definitions/).
706+
707+
The default HTTP request body limit is 20 MiB. If such large definition
708+
files are not used in a cluster, the limit can be reduced:
709+
710+
``` ini
711+
# lowers the maximum HTTP request body size that will be accepted
712+
# to 1 MiB
713+
management.http.max_body_size = 1000000
714+
```
715+
716+
When a client issues requests with a body that exceeds the limit, a `400 Bad Request` response will be returned.
717+
701718
### Using a Reverse Proxy in front of the HTTP API {#http-api-proxy}
702719

703720
It may be necessary to put a reverse proxy in front of a RabbitMQ cluster. Reverse proxy setup for RabbitMQ

versioned_docs/version-3.13/management/index.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ core RabbitMQ features and do not require or rely on this plugin.
4545

4646
This guide covers:
4747

48-
* [Basic usage](#usage) of management UI and [HTTP API](#http-api)
48+
* [Basic usage](#usage) of management UI
49+
* The [HTTP API](#http-api) provided by the management plugin
4950
* General plugin [configuration](#configuration)
5051
* [Reverse proxy (Nginx or Apache)](#http-api-proxy) in front of the HTTP API
5152
* How to [enable HTTPS for management UI](#single-listener-https) and its underlying API
@@ -664,6 +665,23 @@ Some API endpoints return a lot of information. The volume can be reduced
664665
by filtering what columns are returned by `HTTP GET` requests. See
665666
<a href={`https://rawcdn.githack.com/rabbitmq/rabbitmq-server/${RabbitMQServerGitTag()}/deps/rabbitmq_management/priv/www/api/index.html`}>latest HTTP API documentation</a> for details.
666667

668+
### Maximum HTTP Request Body Limit {#http-body-size-limit}
669+
670+
A few RabbitMQ HTTP API endpoints can potentially receive large payloads,
671+
most notably the endpoint used for [definition import](./definitions/).
672+
673+
The default HTTP request body limit is 20 MiB. If such large definition
674+
files are not used in a cluster, the limit can be reduced:
675+
676+
``` ini
677+
# lowers the maximum HTTP request body size that will be accepted
678+
# to 1 MiB
679+
management.http.max_body_size = 1000000
680+
```
681+
682+
When a client issues requests with a body that exceeds the limit, a `400 Bad Request` response will be returned.
683+
684+
667685
### Using a Reverse Proxy in front of the HTTP API {#http-api-proxy}
668686

669687
It may be necessary to put a reverse proxy in front of a RabbitMQ cluster. Reverse proxy setup for RabbitMQ

versioned_docs/version-4.0/management/index.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ core RabbitMQ features and do not require or rely on this plugin.
4545

4646
This guide covers:
4747

48-
* [Basic usage](#usage) of management UI and [HTTP API](#http-api)
48+
* [Basic usage](#usage) of management UI
49+
* The [HTTP API](#http-api) provided by the management plugin
4950
* General plugin [configuration](#configuration)
5051
* [Reverse proxy (Nginx or Apache)](#http-api-proxy) in front of the HTTP API
5152
* How to [enable HTTPS for management UI](#single-listener-https) and its underlying API
@@ -664,6 +665,22 @@ Some API endpoints return a lot of information. The volume can be reduced
664665
by filtering what columns are returned by `HTTP GET` requests. See
665666
<a href={`https://rawcdn.githack.com/rabbitmq/rabbitmq-server/${RabbitMQServerGitTag()}/deps/rabbitmq_management/priv/www/api/index.html`}>latest HTTP API documentation</a> for details.
666667

668+
### Maximum HTTP Request Body Limit {#http-body-size-limit}
669+
670+
A few RabbitMQ HTTP API endpoints can potentially receive large payloads,
671+
most notably the endpoint used for [definition import](./definitions/).
672+
673+
The default HTTP request body limit is 20 MiB. If such large definition
674+
files are not used in a cluster, the limit can be reduced:
675+
676+
``` ini
677+
# lowers the maximum HTTP request body size that will be accepted
678+
# to 1 MiB
679+
management.http.max_body_size = 1000000
680+
```
681+
682+
When a client issues requests with a body that exceeds the limit, a `400 Bad Request` response will be returned.
683+
667684
### Using a Reverse Proxy in front of the HTTP API {#http-api-proxy}
668685

669686
It may be necessary to put a reverse proxy in front of a RabbitMQ cluster. Reverse proxy setup for RabbitMQ

0 commit comments

Comments
 (0)