Logo
tag-v1.21.4
  • 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
      • Types
        • Hash Policy
        • HTTP
        • HTTP status codes
        • Percent
        • Range
        • Ratelimit Time Unit
        • Semantic Version
        • Token bucket
        • Http cookie API
        • Path Transformations API
        • Metadata matcher
        • Node matcher
        • Number matcher
        • Path matcher
        • Regex matcher
        • String matcher
        • Struct matcher
        • Value matcher
        • Common HTTP Inputs
        • Metadata
        • Custom Tag
    • xDS REST and gRPC protocol
    • Well Known Client Features
  • FAQ
  • Version history
envoy
  • »
  • API »
  • v3 API reference »
  • Types »
  • Http cookie API
  • View page source

Http cookie API¶

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 0 to use a session cookie.

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-2022, Envoy Project Authors.

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