Redirect Policy for Custom Response (proto)

This extension has the qualified name envoy.http.custom_response.redirect_policy


This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.


This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:


This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.


[extensions.http.custom_response.redirect_policy.v3.RedirectPolicy proto]

Custom response policy to internally redirect the original response to a different upstream.

  "uri": ...,
  "redirect_action": {...},
  "status_code": {...},
  "response_headers_to_add": [],
  "request_headers_to_add": [],
  "modify_request_headers_action": {...}

(string) The Http URI to redirect the original request to, to get the custom response. It should be a full FQDN with protocol, host and path.



Precisely one of uri, redirect_action must be set.


(config.route.v3.RedirectAction) Specify elements of the redirect url individually. Note: Do not specify the response_code field in redirect_action, use status_code instead. The following fields in redirect_action are currently not supported, and specifying them will cause the config to be rejected: - prefix_rewrite - regex_rewrite

Precisely one of uri, redirect_action must be set.


(UInt32Value) The new response status code if specified. This is used to override the status code of the response from the new upstream if it is not an error status.


(repeated config.core.v3.HeaderValueOption) HTTP headers to add to the response. This allows the response policy to append, to add or to override headers of the original response for local body, or the custom response from the remote body, before it is sent to a downstream client. Note that these are not applied if the redirected response is an error response.


(repeated config.core.v3.HeaderValueOption) HTTP headers to add to the request before it is internally redirected.


(config.core.v3.TypedExtensionConfig) Custom action to modify request headers before selection of the redirected route.