Logo
tag-v1.32.6
  • About the documentation
  • Introduction
  • Getting Started
  • Configuration reference
  • Operations and administration
  • Extending Envoy for custom use cases
  • API
    • Supported API versions
    • v3 API reference
      • Bootstrap
      • Listeners
      • Clusters
      • HTTP route management
      • Extensions
      • Admin
      • Envoy data
      • Services
      • Common messages
      • Common messages (XDS)
      • Types
        • Common HTTP inputs (proto)
        • Custom Tag (proto)
        • Hash Policy (proto)
        • HTTP (proto)
        • HTTP status codes (proto)
        • HTTP cookie API (proto)
        • Metadata (proto)
        • Filter state matcher (proto)
        • Metadata matcher (proto)
        • Node matcher (proto)
        • Number matcher (proto)
        • Path matcher (proto)
        • Path Transformations API (proto)
        • Percent (proto)
        • Range (proto)
        • Ratelimit Time Unit (proto)
        • Rate Limit Strategies (proto)
        • Regex matcher (proto)
        • Semantic version (proto)
        • String matcher (proto)
        • Struct matcher (proto)
        • Token bucket (proto)
        • Value matcher (proto)
        • Common HTTP Inputs (proto)
    • xDS REST and gRPC protocol
    • Well Known Client Features
  • FAQ
  • Version history
envoy
  • API
  • v3 API reference
  • Types
  • HTTP cookie API (proto)
  • View page source

HTTP cookie API (proto)

type.http.v3.Cookie

[type.http.v3.Cookie proto]

Cookie defines an API for obtaining or generating HTTP cookie.

{
  "name": ...,
  "ttl": {...},
  "path": ...
}
name

(string, REQUIRED) The name that will be used to obtain cookie value from downstream HTTP request or generate new cookie for downstream.

ttl

(Duration) Duration of cookie. This will be used to set the expiry time of a new cookie when it is generated. Set this to 0s to use a session cookie and disable cookie expiration.

path

(string) Path of cookie. This will be used to set the path of a new cookie when it is generated. If no path is specified here, no path will be set for the cookie.

Previous Next

© Copyright 2016-2025, Envoy Project Authors.

Built with Sphinx using a theme provided by Read the Docs.