kong.service.response
Returns the HTTP status code of the response from the Service as a Lua number.
Phases
Returns
number|nil
the status code from the response from the Service, ornil
if the request was not proxied (i.e.kong.response.get_source()
returned anything other than"service"
.
Usage
Returns a Lua table holding the headers from the response from the Service. Keys are header names. Values are either a string with the header value, or an array of strings if a header was sent multiple times. Header names in this table are case-insensitive and dashes (-
) can be written as underscores (_
); that is, the header X-Custom-Header
can also be retrieved as x_custom_header
.
Unlike kong.response.get_headers()
, this function will only return headers that were present in the response from the Service (ignoring headers added by Kong itself). If the request was not proxied to a Service (e.g. an authentication plugin rejected a request and produced an HTTP 401 response), then the returned headers
value might be , since no response from the Service has been received.
By default, this function returns up to 100 headers. The optional max_headers
argument can be specified to customize this limit, but must be greater than 1 and not greater than 1000.
Phases
header_filter
,body_filter
,log
Parameters
- max_headers (number, optional): customize the headers to parse
table
the response headers in table formstring
err If more headers thanmax_headers
were present, a string with the error"truncated"
.
Usage
Returns the value of the specified response header.
Unlike kong.response.get_header()
, this function will only return a header if it was present in the response from the Service (ignoring headers added by Kong itself).
Phases
header_filter
,body_filter
,log
Parameters
Header names in are case-insensitive and are normalized to lowercase, and dashes () can be written as underscores (_
); that is, the header X-Custom-Header
can also be retrieved as x_custom_header
.
Returns
string|nil
The value of the header, ornil
if a header withname
was not found in the response. If a header with the same name is present multiple times in the response, this function will return the value of the first occurrence of this header.
Returns the raw buffered body.
Phases
header_filter
,body_filter
,log
Returns
string
body The raw buffered body
Usage
Returns the decoded buffered body.
Phases
header_filter
,body_filter
,
Parameters
- mimetype (string, optional): the MIME type
- mimetype (string, optional): the MIME type
Returns
string
body The raw buffered body