Listeners

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

admin.v3.Listeners

[admin.v3.Listeners proto]

Admin endpoint uses this wrapper for /listeners to display listener status information. See /listeners for more information.

{
  "listener_statuses": []
}
listener_statuses

(repeated admin.v3.ListenerStatus) List of listener statuses.

admin.v3.ListenerStatus

[admin.v3.ListenerStatus proto]

Details an individual listener’s current status.

{
  "name": "...",
  "local_address": "{...}"
}
name

(string) Name of the listener

local_address

(config.core.v3.Address) The actual local address that the listener is listening on. If a listener was configured to listen on port 0, then this address has the port that was allocated by the OS.