Edit File: local.yaml
ip-list local list: help: List item(-s) in local ip-list return_type: IPListLocalAgentResponse cli: users: - root type: dict schema: by_ip: help: Filters output by abuser's IP or by subnet in CIDR notation. Example --by-ip 1.2.3.0/24. type: ip coerce: ip_discard_host_bits check_with: - enforce64min_subnet_mask_for_ipv6 purpose: help: IP List purpose can be `white` - do not block these IPs. `drop` - deny access on the network level (DROP packets via iptables, and respond with 403 on web ports even when the request comes through a proxy). `captcha` - deny access on the network level for all non-web ports, show a Splash Screen challenge page on web ports. `splashscreen` - check the visitor's browser before allowing access to websites. type: list schema: type: string by_country_code: help: Filters output by country code. Requires valid country code as argument. Find valid country codes here www.nationsonline.org/oneworld/country_code_list.htm in column ISO ALPHA-2 CODE. type: string by_comment: help: Filters output by comment. type: string manual: help: Show only items that have been added manually. type: boolean limit: help: limits the output with specified number of incidents. Must be a number greater than zero. type: integer coerce: int default: 50 offset: help: Offset for pagination. type: integer coerce: int default: 0 order_by: help: List of fields to sort the results by. Each field must be followed by "+" for descending order or "-" for ascending order (e.g., --order-by ip+ or --order-by purpose-) type: list schema: type: order_by coerce: order_by nullable: true no_splash_screen: help: (internal) type: boolean default: false by_type: help: Filters output by item tipe [country | ip] type: string allowed: - ip - country ip-list local add: help: Add item(-s) from local ip-list return_type: NoItemsAgentResponse cli: users: - root type: dict schema: items: help: IP which would be provided to opted list type: list schema: type: ip coerce: ip check_with: - enforce64min_subnet_mask_for_ipv6 required: true positional: true purpose: help: IP List purpose can be `white` - do not block these IPs. `drop` - deny access on the network level (DROP packets via iptables, and respond with 403 on web ports even when the request comes through a proxy). `captcha` - deny access on the network level for all non-web ports, show a Splash Screen challenge page on web ports. `splashscreen` - check the visitor's browser before allowing access to websites. type: string allowed: - white - drop - captcha expiration: help: allows specifying expiration time for the listed IP (in seconds since epoch) type: integer default: 0 check_with: - expiration coerce: int comment: help: allows to add comment to the item type: string scope: help: Allows to set the scope to Global/Local. Accepts two values local (a default value, means "add IP on this server only") and group (means "add IP for the whole group in which this server is"). type: string allowed: - local - group full_access: help: Allow access to all blocked ports as well type: boolean ip-list local delete: help: Remove item(-s) from local ip-list return_type: NoItemsAgentResponse cli: users: - root type: dict schema: items: help: IP which would be removed from opted list type: list schema: type: ip coerce: ip check_with: - enforce64min_subnet_mask_for_ipv6 required: true positional: true purpose: help: IP List purpose can be `white` - do not block these IPs. `drop` - deny access on the network level (DROP packets via iptables, and respond with 403 on web ports even when the request comes through a proxy). `captcha` - deny access on the network level for all non-web ports, show a Splash Screen challenge page on web ports. `splashscreen` - check the visitor's browser before allowing access to websites. type: string allowed: - white - drop - captcha - splashscreen
Back to File Manager