Add or Set Query Parameters

Adds or sets query parameters on the incoming request.

Configuration#

{
  "name": "my-set-query-params-inbound-policy",
  "policyType": "set-query-params-inbound",
  "handler": {
    "export": "SetQueryParamsInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "params": [
        {
          "name": "PARAM_NAME",
          "value": "PARAM_VALUE",
          "overwrite": true
        }
      ]
    }
  }
}

Options#

  • name the name of your policy instance. This is used as a reference in your routes.
  • policyType the identifier of the policy. This is used by the Zuplo UI. Value should be set-query-params-inbound.
  • handler/export The name of the exported type. Value should be SetQueryParamsInboundPolicy.
  • handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
  • handler/options The options for this policy:
    • params

      An array of object, with a name and value property (and optional override boolean)

Was this article helpful?

Do you have any questions?Contact us
Check out ourproduct changelog