On this page
HeaderManipulation
HeaderManipulation API reference.
Proto: header_manipulation.proto
Package: trafficcontrol.policy.gloo.solo.io
Types:
- HeaderManipulationPolicyReport
- HeaderManipulationPolicyReport.WorkspacesEntry
- HeaderManipulationPolicySpec
- HeaderManipulationPolicySpec.Config
- HeaderManipulationPolicySpec.Config.AppendRequestHeadersEntry
- HeaderManipulationPolicySpec.Config.AppendResponseHeadersEntry
- HeaderManipulationPolicyStatus
HeaderManipulationPolicyReport
| Field | Description |
|---|---|
workspaces | (repeated HeaderManipulationPolicyReport.WorkspacesEntry)The status of the resource in each workspace that it exists in. |
selectedRoutes | (repeated common.gloo.solo.io.RouteReference)A list of references to all routes selected by the policy. |
HeaderManipulationPolicyReport.WorkspacesEntry
| Field | Description |
|---|---|
key | (string) |
value | (common.gloo.solo.io.Report) |
HeaderManipulationPolicySpec
HeaderManipulationPolicy is used to transform HTTP requests and responses matching selected routes. TransformationPolicies are applied at the Route level. If no selectors are provided, will apply to all routes in the workspace.
| Field | Description |
|---|---|
applyToRoutes | (repeated common.gloo.solo.io.RouteSelector)select the routes where the policy will be applied |
config | (HeaderManipulationPolicySpec.Config)The details of the transformation policy to apply to the selected routes or destinations for a given route. |
applyToRouteDestinations | (repeated common.gloo.solo.io.RouteDestinationSelector)Select routes’ destinations where the policy will be applied. This field is intended for when the config should be applied to a forwardTo route only when it is forwarded to a subset of the route’s backing destinations. |
HeaderManipulationPolicySpec.Config
| Field | Description |
|---|---|
removeResponseHeaders | (repeated string)HTTP headers to remove before returning a response to the caller. |
appendResponseHeaders | (repeated HeaderManipulationPolicySpec.Config.AppendResponseHeadersEntry)Additional HTTP headers to add before returning a response to the caller. |
removeRequestHeaders | (repeated string)HTTP headers to remove before forwarding a request to the destination service. |
appendRequestHeaders | (repeated HeaderManipulationPolicySpec.Config.AppendRequestHeadersEntry)Additional HTTP headers to add before forwarding a request to the destination service. |
HeaderManipulationPolicySpec.Config.AppendRequestHeadersEntry
| Field | Description |
|---|---|
key | (string) |
value | (string) |
HeaderManipulationPolicySpec.Config.AppendResponseHeadersEntry
| Field | Description |
|---|---|
key | (string) |
value | (string) |
HeaderManipulationPolicyStatus
| Field | Description |
|---|---|
common | (common.gloo.solo.io.Status) |
numSelectedRoutes | (uint32)The number of routes selected by this policy. |