Skip to content

Add note about payload size considerations in API docs #51732

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

Merged
amoghrajesh merged 2 commits into from
Jun 16, 2025
Merged

Add note about payload size considerations in API docs #51732

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6229e4b
Add note about payload size considerations in API docs
amoghrajesh Jun 14, 2025
6198ddf
fixing build docs
amoghrajesh Jun 16, 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
7 changes: 7 additions & 0 deletions airflow-core/docs/security/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,10 @@ Page size limit
To protect against requests that may lead to application instability, the stable API has a limit of items in response.
The default is 100 items, but you can change it using ``maximum_page_limit`` option in ``[api]``
section in the ``airflow.cfg`` file.

Request Payload Considerations
------------------------------

When using REST APIs that accept data payloads (such as the Variables API), be mindful of the payload size.
Large payloads (out of ordinary size, like a million bytes) can impact the performance of the Airflow webserver.
It's recommended to implement appropriate size limits at the proxy layer for your deployment.