List
- Params
- Params.ListEntryType

List

The list adapter makes it possible to perform simple whitelist or blacklistchecks. You can configure the adapter with the list to check, or you can pointit to a URL from where the list should be fetched. Lists can be simple strings,IP addresses, or regex patterns.

This adapter supports the listentry template.

Params

Configuration format for the list adapter.

Field	Type	Description	Required
`providerUrl`	`string`	Where to find the list to check against. This may be omitted for a completely local list.	No
`refreshInterval`	`Duration`	Determines how often the provider is polled foran updated list	No
`ttl`	`Duration`	Indicates how long to keep a list before discarding it.Typically, the TTL value should be set to noticeably longer (> 2x) than therefresh interval to ensure continued operation in the face of transientserver outages.	No
`cachingInterval`	`Duration`	Indicates the amount of time a caller of this adapter can cache an answerbefore it should ask the adapter again.	No
`cachingUseCount`	`int32`	Indicates the number of times a caller of this adapter can use a cached answerbefore it should ask the adapter again.	No
`overrides`	`string[]`	List entries that are consulted first, before the list from the server	No
`entryType`	`ListEntryType`	Determines the kind of list entry and overrides.	No
`blacklist`	`bool`	Whether the list operates as a blacklist or a whitelist.	No

Params.ListEntryType

Determines the type of list that the adapter is consulting.

Name	Description
`STRINGS`	List entries are treated as plain strings.
`CASE_INSENSITIVE_STRINGS`	List entries are treated as case-insensitive strings.
`IP_ADDRESSES`	List entries are treated as IP addresses and ranges.
`REGEX`	List entries are treated as re2 regexp. See here for the supported syntax.