WebSocket Size Limit Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The WebSocket Size Limit plugin is compatible with the following protocols:

ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case websocket-size-limit.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example websocket-size-limit_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|SERVICE_ID/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ROUTE_ID/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/CONSUMER_NAME|CONSUMER_ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • client_max_payload

    integer between: 1 33554432

    Maximum size (in bytes) of client-originated WebSocket messages. Must be greater than 0 and less than 33554432 (32 MiB)

  • upstream_max_payload

    integer between: 1 33554432

    Maximum size (in bytes) of upstream-originated WebSocket messages. Must be greater than 0 and less than 33554432 (32 MiB)