Docs Config Common Proxy Group Fields

Common Proxy Group Fields

A proxy group wraps a batch of nodes into a single unit, which rules can then reference just like a single node. All 6 types (select/url-test/fallback/load-balance/relay, etc.) share this set of fields.

Example Config

config.yaml YAML

proxy-groups:
  - name: "proxy"
    type: select
    proxies:
      - DIRECT
      - ss
    use:
      - provider1
    url: 'https://www.gstatic.com/generate_204'
    interval: 300
    lazy: true
    filter: "(?i)港|hk|hongkong|hong kong"
    exclude-filter: "美|日"
    exclude-type: "Shadowsocks|Http"

Basic Fields

nameRequired

The proxy group's name — wrap it in quotes if it contains special characters.

typeRequired

The proxy group type: select/url-test/fallback/load-balance/relay.

proxiesOptional

The outbound proxies or other proxy groups to include, listed in array order.

useOptional

Includes one or more proxy providers (see proxy-providers).

Health Check

urlOptional

The health check test URL. Note: this only checks proxies listed in the proxies field — it does not check nodes brought in via use from a proxy provider (those are handled by the provider's own health-check).

intervalOptional

The health check interval, in seconds; enables periodic testing when non-zero.

lazyDefault: true

Lazy mode — skips testing when the group isn't currently selected/in use, saving resources.

timeoutOptional

The health check timeout, in milliseconds.

max-failed-timesDefault: 5

The maximum number of failures before triggering a forced health check.

expected-statusDefault: *

The expected HTTP response status code — once set, a node is only considered available if its response code matches. Supports / to match multiple codes and - for a range, which can be combined, e.g. 200/302/400-503.

Bulk Inclusion & Filtering

include-all / include-all-proxies / include-all-providersOptional

Includes every outbound proxy and/or every proxy provider (sorted by name), excluding proxy groups themselves; include-all-providers overrides the use field.

filter / exclude-filterOptional

Filter or exclude nodes by keyword/regex, applying only to included proxy providers and bulk-included proxies; separate multiple regexes with `.

exclude-typeOptional

Doesn't support regex — separate with | to exclude by type, applying only to included outbound proxies.

Other Fields

Field	Description
`default-selected`	The default selected node; defaults to the first node if empty or if the node doesn't exist
`empty-fallback`	The fallback outbound used when the group has no nodes; defaults to `COMPATIBLE` — must be a proxy name, not a proxy group
`disable-udp`	Disables UDP for this proxy group
`hidden`	Makes the API report a hidden status, letting a compatible frontend hide this proxy group from display
`icon`	Makes the API report a custom icon string, for display in a compatible dashboard

Manual Selection (select) Automatic Selection (url-test) Fallback Load Balancing (load-balance) Chained Proxy (relay)