Skip to content
Kong Logo | Kong Docs Logo
search
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
2.6.x
  • Home icon
  • Kong Gateway
  • PDK
  • kong.service.request
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.5.x (latest)
  • 3.4.x
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • kong.service.request
    • kong.service.request.enable_buffering()
    • kong.service.request.set_scheme(scheme)
    • kong.service.request.set_path(path)
    • kong.service.request.set_raw_query(query)
    • kong.service.request.set_method(method)
    • kong.service.request.set_query(args)
    • kong.service.request.set_header(header, value)
    • kong.service.request.add_header(header, value)
    • kong.service.request.clear_header(header)
    • kong.service.request.set_headers(headers)
    • kong.service.request.set_raw_body(body)
    • kong.service.request.set_body(args[, mimetype])
    • kong.service.request.disable_tls()
You are browsing documentation for an outdated version. See the latest documentation here.

kong.service.request

kong.service.request

Manipulation of the request to the Service

kong.service.request.enable_buffering()

Enables buffered proxying that allows plugins to access service body and response headers at the same time

Phases

  • rewrite, access

Returns

  • Nothing

Usage

kong.service.request.enable_buffering()

Back to top

kong.service.request.set_scheme(scheme)

Sets the protocol to use when proxying the request to the Service.

Phases

  • access

Parameters

  • scheme (string): The scheme to be used. Supported values are "http" or "https"

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_scheme("https")

Back to top

kong.service.request.set_path(path)

Sets the path component for the request to the service.

The input accepts any valid normalized URI (including UTF-8 characters) and this API will perform necessary escaping according to the RFC to make the request valid.

Input should not include the querystring.

Phases

  • access

Parameters

  • path (string): The path string. Special characters and UTF-8 characters are allowed. Example: “/v2/movies” or “/foo/😀”

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_path("/v2/movies")

Back to top

kong.service.request.set_raw_query(query)

Sets the querystring of the request to the Service. The query argument is a string (without the leading ? character), and will not be processed in any way.

For a higher-level function to set the query string from a Lua table of arguments, see kong.service.request.set_query().

Phases

  • rewrite, access

Parameters

  • query (string): The raw querystring. Example: “foo=bar&bla&baz=hello%20world”

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_raw_query("zzz&bar=baz&bar=bla&bar&blo=&foo=hello%20world")

Back to top

kong.service.request.set_method(method)

Sets the HTTP method for the request to the service.

Phases

  • rewrite, access

Parameters

  • method (string): The method string, which should be given in all uppercase. Supported values are: "GET", "HEAD", "PUT", "POST", "DELETE", "OPTIONS", "MKCOL", "COPY", "MOVE", "PROPFIND", "PROPPATCH", "LOCK", "UNLOCK", "PATCH", "TRACE".

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_method("DELETE")

Back to top

kong.service.request.set_query(args)

Set the querystring of the request to the Service.

Unlike kong.service.request.set_raw_query(), the query argument must be a table in which each key is a string (corresponding to an arguments name), and each value is either a boolean, a string or an array of strings or booleans. Additionally, all string values will be URL-encoded.

The resulting querystring will contain keys in their lexicographical order. The order of entries within the same key (when values are given as an array) is retained.

If further control of the querystring generation is needed, a raw querystring can be given as a string with kong.service.request.set_raw_query().

Phases

  • rewrite, access

Parameters

  • args (table): A table where each key is a string (corresponding to an argument name), and each value is either a boolean, a string or an array of strings or booleans. Any string values given are URL-encoded.

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_query({
  foo = "hello world",
  bar = {"baz", "bla", true},
  zzz = true,
  blo = ""
})
-- Will produce the following query string:
-- bar=baz&bar=bla&bar&blo=&foo=hello%20world&zzz

Back to top

kong.service.request.set_header(header, value)

Sets a header in the request to the Service with the given value. Any existing header with the same name will be overridden.

If the header argument is "host" (case-insensitive), then this is will also set the SNI of the request to the Service.

Phases

  • rewrite, access

Parameters

  • header (string): The header name. Example: “X-Foo”
  • value (string boolean number): The header value. Example: “hello world”

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_header("X-Foo", "value")

Back to top

kong.service.request.add_header(header, value)

Adds a request header with the given value to the request to the Service. Unlike kong.service.request.set_header(), this function will not remove any existing headers with the same name. Instead, several occurrences of the header will be present in the request. The order in which headers are added is retained.

Phases

  • rewrite, access

Parameters

  • header (string): The header name. Example: “Cache-Control”
  • value (string number boolean): The header value. Example: “no-cache”

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.add_header("Cache-Control", "no-cache")
kong.service.request.add_header("Cache-Control", "no-store")

Back to top

kong.service.request.clear_header(header)

Removes all occurrences of the specified header in the request to the Service.

Phases

  • rewrite, access

Parameters

  • header (string): The header name. Example: “X-Foo”

Returns

  • Nothing; throws an error on invalid inputs. The function does not throw an error if no header was removed.

Usage

kong.service.request.set_header("X-Foo", "foo")
kong.service.request.add_header("X-Foo", "bar")
kong.service.request.clear_header("X-Foo")
-- from here onwards, no X-Foo headers will exist in the request

Back to top

kong.service.request.set_headers(headers)

Sets the headers of the request to the Service. Unlike kong.service.request.set_header(), the headers argument must be a table in which each key is a string (corresponding to a header’s name), and each value is a string, or an array of strings.

The resulting headers are produced in lexicographical order. The order of entries with the same name (when values are given as an array) is retained.

This function overrides any existing header bearing the same name as those specified in the headers argument. Other headers remain unchanged.

If the "Host" header is set (case-insensitive), then this is will also set the SNI of the request to the Service.

Phases

  • rewrite, access

Parameters

  • headers (table): A table where each key is a string containing a header name and each value is either a string or an array of strings.

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_header("X-Foo", "foo1")
kong.service.request.add_header("X-Foo", "foo2")
kong.service.request.set_header("X-Bar", "bar1")
kong.service.request.set_headers({
  ["X-Foo"] = "foo3",
  ["Cache-Control"] = { "no-store", "no-cache" },
  ["Bla"] = "boo"
})

-- Will add the following headers to the request, in this order:
-- X-Bar: bar1
-- Bla: boo
-- Cache-Control: no-store
-- Cache-Control: no-cache
-- X-Foo: foo3

Back to top

kong.service.request.set_raw_body(body)

Sets the body of the request to the Service.

The body argument must be a string and will not be processed in any way. This function also sets the Content-Length header appropriately. To set an empty body, one can give an empty string "" to this function.

For a higher-level function to set the body based on the request content type, see kong.service.request.set_body().

Phases

  • rewrite, access

Parameters

  • body (string): The raw body

Returns

  • Nothing; throws an error on invalid inputs.

Usage

kong.service.request.set_raw_body("Hello, world!")

Back to top

kong.service.request.set_body(args[, mimetype])

Sets the body of the request to the Service. Unlike kong.service.request.set_raw_body(), the args argument must be a table, and will be encoded with a MIME type. The encoding MIME type can be specified in the optional mimetype argument, or if left unspecified, will be chosen based on the Content-Type header of the client’s request.

If the MIME type is application/x-www-form-urlencoded:

  • Encodes the arguments as form-encoded: keys are produced in lexicographical order. The order of entries within the same key (when values are given as an array) is retained. Any string values given are URL-encoded.

If the MIME type is multipart/form-data:

  • Encodes the arguments as multipart form data.

If the MIME type is application/json:

  • Encodes the arguments as JSON (same as kong.service.request.set_raw_body(json.encode(args)))
  • Lua types are converted to matching JSON types.mej

If none of the above, returns nil and an error message indicating the body could not be encoded.

The optional argument mimetype can be one of:

  • application/x-www-form-urlencoded
  • application/json
  • multipart/form-data

If the mimetype argument is specified, the Content-Type header will be set accordingly in the request to the Service.

If further control of the body generation is needed, a raw body can be given as a string with kong.service.request.set_raw_body().

Phases

  • rewrite, access

Parameters

  • args (table): A table with data to be converted to the appropriate format and stored in the body.
  • mimetype (string, optional): can be one of:

Returns

  1. boolean|nil true on success, nil otherwise

  2. string|nil nil on success, an error message in case of error. Throws an error on invalid inputs.

Usage

kong.service.set_header("application/json")
local ok, err = kong.service.request.set_body({
  name = "John Doe",
  age = 42,
  numbers = {1, 2, 3}
})

-- Produces the following JSON body:
-- { "name": "John Doe", "age": 42, "numbers":[1, 2, 3] }

local ok, err = kong.service.request.set_body({
  foo = "hello world",
  bar = {"baz", "bla", true},
  zzz = true,
  blo = ""
}, "application/x-www-form-urlencoded")

-- Produces the following body:
-- bar=baz&bar=bla&bar&blo=&foo=hello%20world&zzz

Back to top

kong.service.request.disable_tls()

Disables the TLS handshake to upstream for ngx_stream_proxy_module. Effectively this overrides proxy_ssl directive to off setting for the current stream session.

Note that once this function has been called it is not possible to re-enable TLS handshake for the current session.

Phases

  • preread, balancer

Returns

  1. boolean|nil true if the operation succeeded, nil if an error occurred

  2. string|nil An error message describing the error if there was one.

Usage

local ok, err = kong.service.request.disable_tls()
if not ok then
  -- do something with error
end

Back to top

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Gateway Enterprise Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2023