latest--rate_limiting_advanced-plugin-schema

Type	object
Schema URL	https://catalog.lintel.tools/schemas/schemastore/dwp-exchange-gateway/_shared/latest--rate_limiting_advanced-plugin-schema.json
Parent schema	dwp-exchange-gateway

Type: object

Rate limit how many HTTP requests can be made in a given period of seconds, minutes, hours, days, months, or years. If the underlying Service/Route (or deprecated API entity) has no authentication layer, the Client IP address will be used; otherwise, the Consumer will be used if an authentication plugin has been configured.

Properties

per_second number

The number of HTTP requests that can be made per second

min=1

per_minute number

The number of HTTP requests that can be made per minute

min=1

per_hour number

The number of HTTP requests that can be made per hour

min=1

per_day number

The number of HTTP requests that can be made per day

min=1

per_consumer object[]

configure separate rates for different consumers

hide_client_headers boolean

Optionally hide informative response headers

redis object

13 nested properties

host string

Host to use for Redis connection when the redis strategy is defined. This parameter accepts a hostname or an IP address as a value.

cluster_addresses string[]

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis cluster. Each string element must consist of a hostname (or IP address) and port. The minimum length of the array is 1 element.

port number

min=0max=65535

server_name string

ssl boolean

ssl_verify boolean

connect_timeout number

min=1

read_timeout number

min=1

send_timeout number

min=1

database number

auth_enabled boolean

Default: true

username string

pattern=^(\{vault://|[^{]).*$

password string

pattern=^(\{vault://|[^{]).*$

Any of

1. variant

2. variant

3. variant

4. variant

5. variant