Ambassador · Schema
MappingSpec
Specification for an Ambassador Mapping
API DevelopmentGatewaysIngressKubernetesMock ServersMocksPlatformTesting
Properties
| Name | Type | Description |
|---|---|---|
| hostname | string | Hostname to match for this Mapping. Use '*' to match all hostnames. |
| prefix | string | URL prefix to match for routing |
| prefix_regex | boolean | Whether the prefix should be interpreted as a regular expression |
| prefix_exact | boolean | Whether the prefix should be matched exactly rather than as a prefix |
| service | string | Target service to route to, in the format service-name.namespace:port or a full URL |
| rewrite | string | Prefix rewrite rule applied to the URL before forwarding to the backend service. Set to empty string to disable rewriting. |
| method | string | HTTP method to match |
| method_regex | boolean | Whether the method value is a regular expression |
| headers | object | HTTP headers that must be present on the request for this Mapping to match. Values can be exact strings or regular expressions. |
| query_parameters | object | Query parameters that must be present for this Mapping to match |
| host | string | Deprecated. Use hostname instead. |
| host_regex | boolean | Deprecated. Whether host is a regular expression. |
| timeout_ms | integer | Request timeout in milliseconds |
| idle_timeout_ms | integer | Idle timeout for streaming connections in milliseconds |
| connect_timeout_ms | integer | Upstream connection timeout in milliseconds |
| cluster_idle_timeout_ms | integer | Idle timeout for upstream connections in the cluster in milliseconds |
| weight | integer | Weight for traffic splitting when multiple Mappings match the same prefix. Used in canary deployments. |
| bypass_auth | boolean | Whether to bypass the external authentication service for this Mapping |
| circuit_breakers | array | Circuit breaker configurations for the upstream cluster |
| labels | object | Rate limiting labels to apply to requests matching this Mapping. Labels are sent to the rate limiting service for evaluation. |
| add_request_headers | object | Headers to add to the request before forwarding to the upstream |
| add_response_headers | object | Headers to add to the response before sending to the client |
| remove_request_headers | array | Header names to remove from the request |
| remove_response_headers | array | Header names to remove from the response |
| allow_upgrade | array | Protocols to allow upgrade to, such as websocket |
| grpc | boolean | Whether the upstream service uses gRPC |
| enable_ipv4 | boolean | Whether to enable IPv4 DNS lookups for the upstream service |
| enable_ipv6 | boolean | Whether to enable IPv6 DNS lookups for the upstream service |
| ambassador_id | array | List of Ambassador IDs that should apply this Mapping. Used to partition a single Kubernetes cluster among multiple Ambassador instances. |