• 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.

    FieldTypeDescriptionRequired
    providerUrlstringWhere to find the list to check against. This may be omitted for a completely local list.No
    refreshIntervalDurationDetermines how often the provider is polled foran updated listNo
    ttlDurationIndicates 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
    cachingIntervalDurationIndicates the amount of time a caller of this adapter can cache an answerbefore it should ask the adapter again.No
    cachingUseCountint32Indicates the number of times a caller of this adapter can use a cached answerbefore it should ask the adapter again.No
    overridesstring[]List entries that are consulted first, before the list from the serverNo
    entryTypeListEntryTypeDetermines the kind of list entry and overrides.No
    blacklistboolWhether the list operates as a blacklist or a whitelist.No

    Params.ListEntryType

    Determines the type of list that the adapter is consulting.

    NameDescription
    STRINGSList entries are treated as plain strings.
    CASE_INSENSITIVE_STRINGSList entries are treated as case-insensitive strings.
    IP_ADDRESSESList entries are treated as IP addresses and ranges.
    REGEXList entries are treated as re2 regexp. See here for the supported syntax.