Skip to content

Commit bb73823

Browse files
committed
docs(gateway): document kong.request.get_raw_headers and sandbox allowlist
1 parent 2c49565 commit bb73823

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

app/_references/gateway/pdk/reference/3.14/kong.request.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,33 @@ headers["X-Another"][2] -- "baz"
645645

646646

647647

648+
## kong.request.get_raw_headers()
649+
650+
Returns request headers parsed from the raw HTTP header block.
651+
652+
This function reads `ngx.req.raw_header(true)` and parses it into a Lua
653+
table. Header names are normalized to lowercase. If a header appears
654+
multiple times, the value is an array preserving the original order.
655+
656+
This API is only available for HTTP/1.x. For HTTP/2 or unknown versions,
657+
it returns `nil` and an error message.
658+
659+
Unlike `kong.request.get_headers()`, this function does not provide
660+
dash/underscore normalization on lookup; use lowercase header names.
661+
662+
663+
**Phases**
664+
665+
* rewrite, access, header_filter, response, body_filter, log, admin_api
666+
667+
**Returns**
668+
669+
1. `table|nil`: Parsed request headers table, or `nil` when unavailable.
670+
671+
1. `nil|string`: Error message when raw headers are unavailable.
672+
673+
674+
648675
## kong.request.get_raw_body()
649676

650677
Returns the plain request body.
@@ -819,4 +846,3 @@ Returns the unique request ID for the current request.
819846
* `string`: The unique request ID.
820847

821848

822-

app/gateway/sandboxing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ kong.request.get_port
218218
kong.request.get_query
219219
kong.request.get_query_arg
220220
kong.request.get_raw_body
221+
kong.request.get_raw_headers
221222
kong.request.get_raw_path
222223
kong.request.get_raw_query
223224
kong.request.get_scheme

0 commit comments

Comments
 (0)