Skip to content

Commit 9d9c4c5

Browse files
[v3-0-test] Add note about payload size considerations in API docs (#51732) (#51768)
(cherry picked from commit 69da3f7) Co-authored-by: Amogh Desai <amoghrajesh1999@gmail.com>
1 parent 1c7b629 commit 9d9c4c5

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

airflow-core/docs/security/api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,10 @@ Page size limit
9393
To protect against requests that may lead to application instability, the stable API has a limit of items in response.
9494
The default is 100 items, but you can change it using ``maximum_page_limit`` option in ``[api]``
9595
section in the ``airflow.cfg`` file.
96+
97+
Request Payload Considerations
98+
------------------------------
99+
100+
When using REST APIs that accept data payloads (such as the Variables API), be mindful of the payload size.
101+
Large payloads (out of ordinary size, like a million bytes) can impact the performance of the Airflow webserver.
102+
It's recommended to implement appropriate size limits at the proxy layer for your deployment.

0 commit comments

Comments
 (0)