Skip to content

Instantly share code, notes, and snippets.

@artiga033

artiga033/sing-box.schema.json

Last active March 11, 2026 18:09
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save artiga033/fea992d95ad44dc8d024b229223b1002 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save artiga033/fea992d95ad44dc8d024b229223b1002 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. artiga033 revised this gist Feb 10, 2026. 1 changed file with 86 additions and 86 deletions.
    172 changes: 86 additions & 86 deletions sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -51,7 +51,7 @@
    }
    },
    "$defs": {
    "https://artiga033.github.io/sing-box-schema/types/string-or-array.schema.json": {
    "types/string-or-array.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$comment": "singbox allows using single string for array types if there is only one element.\n\nThis type is to allow the behavior.",
    "oneOf": [
    @@ -66,7 +66,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/certificate.schema.json": {
    "certificate.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -89,7 +89,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/fakeip.schema.json": {
    "dns/fakeip.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -109,7 +109,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/rule_action.schema.json": {
    "dns/rule_action.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "oneOf": [
    @@ -234,7 +234,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/rule.schema.json": {
    "dns/rule.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "oneOf": [
    {
    @@ -539,7 +539,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/legacy.schema.json": {
    "dns/server/legacy.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": ["address"],
    @@ -578,7 +578,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/shared/dial.schema.json": {
    "shared/dial.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "properties": {
    "detour": {
    @@ -662,7 +662,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/local.schema.json": {
    "dns/server/local.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -678,7 +678,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/hosts.schema.json": {
    "dns/server/hosts.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -696,7 +696,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/tcp.schema.json": {
    "dns/server/tcp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -722,7 +722,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/udp.schema.json": {
    "dns/server/udp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -748,7 +748,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/tls-outbound.schema.json": {
    "shared/tls-outbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -899,7 +899,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/tls.schema.json": {
    "dns/server/tls.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -929,7 +929,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/quic.schema.json": {
    "dns/server/quic.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -959,7 +959,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/https.schema.json": {
    "dns/server/https.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1001,7 +1001,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/h3.schema.json": {
    "dns/server/h3.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1043,7 +1043,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/dhcp.schema.json": {
    "dns/server/dhcp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1063,7 +1063,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/fakeip.schema.json": {
    "dns/server/fakeip.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "properties": {
    "type": {
    @@ -1082,7 +1082,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/tailscale.schema.json": {
    "dns/server/tailscale.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": ["endpoint"],
    "properties": {
    @@ -1100,7 +1100,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server/resolved.schema.json": {
    "dns/server/resolved.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": ["service"],
    "properties": {
    @@ -1118,7 +1118,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/dns/server.schema.json": {
    "dns/server.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -1195,7 +1195,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/dns.schema.json": {
    "dns.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1252,7 +1252,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/endpoint/wireguard.schema.json": {
    "endpoint/wireguard.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -1350,7 +1350,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/endpoint/tailscale.schema.json": {
    "endpoint/tailscale.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -1421,7 +1421,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/endpoint.schema.json": {
    "endpoint.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -1451,7 +1451,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/experimental/cache-file.schema.json": {
    "experimental/cache-file.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1481,7 +1481,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/experimental/clash-api.schema.json": {
    "experimental/clash-api.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1544,7 +1544,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/experimental/v2ray-api.schema.json": {
    "experimental/v2ray-api.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1585,7 +1585,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/experimental.schema.json": {
    "experimental.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1603,7 +1603,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/shared/listen.schema.json": {
    "shared/listen.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -1691,7 +1691,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/inbound/direct.schema.json": {
    "inbound/direct.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1724,7 +1724,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/mixed.schema.json": {
    "inbound/mixed.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1764,7 +1764,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/socks.schema.json": {
    "inbound/socks.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -1800,7 +1800,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/dns01_challenge.schema.json": {
    "shared/dns01_challenge.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "oneOf": [
    @@ -1838,7 +1838,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/tls-inbound.schema.json": {
    "shared/tls-inbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -2039,7 +2039,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/inbound/http.schema.json": {
    "inbound/http.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2082,7 +2082,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/tcp-brutal.schema.json": {
    "shared/tcp-brutal.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -2100,7 +2100,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/shared/multiplex-inbound.schema.json": {
    "shared/multiplex-inbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -2117,7 +2117,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/inbound/shadowsocks.schema.json": {
    "inbound/shadowsocks.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2206,7 +2206,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/v2ray-transport.schema.json": {
    "shared/v2ray-transport.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "oneOf": [
    @@ -2329,7 +2329,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/vmess.schema.json": {
    "inbound/vmess.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2378,7 +2378,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/trojan.schema.json": {
    "inbound/trojan.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2450,7 +2450,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/naive.schema.json": {
    "inbound/naive.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2494,7 +2494,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/hysteria.schema.json": {
    "inbound/hysteria.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2573,7 +2573,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/shadowtls.schema.json": {
    "inbound/shadowtls.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2670,7 +2670,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/tuic.schema.json": {
    "inbound/tuic.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2731,7 +2731,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/hysteria2.schema.json": {
    "inbound/hysteria2.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2847,7 +2847,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/vless.schema.json": {
    "inbound/vless.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2897,7 +2897,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/anytls.schema.json": {
    "inbound/anytls.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -2943,7 +2943,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/tun.schema.json": {
    "inbound/tun.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3183,7 +3183,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/redirect.schema.json": {
    "inbound/redirect.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3203,7 +3203,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound/tproxy.schema.json": {
    "inbound/tproxy.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3228,7 +3228,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/inbound.schema.json": {
    "inbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -3321,7 +3321,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/log.schema.json": {
    "log.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -3344,7 +3344,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/ntp.schema.json": {
    "ntp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -3376,7 +3376,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/direct.schema.json": {
    "outbound/direct.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3404,7 +3404,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/outbound/block.schema.json": {
    "outbound/block.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": ["type"],
    "properties": {
    @@ -3417,7 +3417,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/shared/udp-over-tcp.schema.json": {
    "shared/udp-over-tcp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$comment": "The structure can be replaced with a boolean value when the version is not specified.",
    "oneOf": [
    @@ -3440,7 +3440,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/socks.schema.json": {
    "outbound/socks.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3489,7 +3489,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/http.schema.json": {
    "outbound/http.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3539,7 +3539,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/shared/multiplex-outbound.schema.json": {
    "shared/multiplex-outbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -3573,7 +3573,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/outbound/shadowsocks.schema.json": {
    "outbound/shadowsocks.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3648,7 +3648,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/vmess.schema.json": {
    "outbound/vmess.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3723,7 +3723,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/trojan.schema.json": {
    "outbound/trojan.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3769,7 +3769,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/wireguard.schema.json": {
    "outbound/wireguard.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3877,7 +3877,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/hysteria.schema.json": {
    "outbound/hysteria.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -3961,7 +3961,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/vless.schema.json": {
    "outbound/vless.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4017,7 +4017,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/shadowtls.schema.json": {
    "outbound/shadowtls.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4057,7 +4057,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/tuic.schema.json": {
    "outbound/tuic.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4123,7 +4123,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/hysteria2.schema.json": {
    "outbound/hysteria2.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4197,7 +4197,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/anytls.schema.json": {
    "outbound/anytls.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4244,7 +4244,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/tor.schema.json": {
    "outbound/tor.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4284,7 +4284,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/ssh.schema.json": {
    "outbound/ssh.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -4347,7 +4347,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/outbound/dns.schema.json": {
    "outbound/dns.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "deprecated": true,
    "required": ["type"],
    @@ -4361,7 +4361,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/outbound/selector.schema.json": {
    "outbound/selector.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": ["type", "outbounds"],
    "properties": {
    @@ -4389,7 +4389,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/outbound/urltest.schema.json": {
    "outbound/urltest.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": ["type", "outbounds"],
    "properties": {
    @@ -4429,7 +4429,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/outbound.schema.json": {
    "outbound.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
    @@ -4530,7 +4530,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/rule-set/headless-rule.schema.json": {
    "rule-set/headless-rule.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "oneOf": [
    {
    @@ -4701,7 +4701,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/rule-set.schema.json": {
    "rule-set.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "oneOf": [
    @@ -4776,7 +4776,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/route/rule_action.schema.json": {
    "route/rule_action.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "oneOf": [
    @@ -4983,7 +4983,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/route/rule.schema.json": {
    "route/rule.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "oneOf": [
    {
    @@ -5269,7 +5269,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/route.schema.json": {
    "route.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
    @@ -5346,7 +5346,7 @@
    }
    }
    },
    "https://artiga033.github.io/sing-box-schema/service/derp.schema.json": {
    "service/derp.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -5456,7 +5456,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/service/resolved.schema.json": {
    "service/resolved.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -5476,7 +5476,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/service/ssm-api.schema.json": {
    "service/ssm-api.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "allOf": [
    {
    @@ -5510,7 +5510,7 @@
    }
    ]
    },
    "https://artiga033.github.io/sing-box-schema/service.schema.json": {
    "service.schema.json": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "allOf": [
  2. artiga033 revised this gist Feb 10, 2026. 1 changed file with 5546 additions and 3686 deletions.
    9,232 changes: 5,546 additions & 3,686 deletions sing-box.schema.json
    View file
    5,546 additions, 3,686 deletions not shown because the diff is too large. Please use a local Git client to view these changes.
  3. artiga033 revised this gist Dec 4, 2023. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -2282,7 +2282,7 @@
    "method": {
    "type": "string",
    "enum": [
    "022-blake3-aes-128-gcm",
    "2022-blake3-aes-128-gcm",
    "2022-blake3-aes-256-gcm",
    "2022-blake3-chacha20-poly1305",
    "none",
  4. artiga033 revised this gist Dec 4, 2023. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -1005,7 +1005,7 @@
    "description": "Tag of the target dns server."
    },
    "disable_cache": {
    "type": "bool",
    "type": "boolean",
    "description": "Disable cache and save cache in this query."
    },
    "rewrite_ttl": {
  5. artiga033 revised this gist Dec 4, 2023. 1 changed file with 667 additions and 53 deletions.
    720 changes: 667 additions & 53 deletions sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -6,7 +6,7 @@
    "$defs": {
    "listableString": {
    "$comments": "ref:https://github.com/SagerNet/sing-box/blob/b0db869b052aa32ec1716e43f7c1f50d7e491057/option/types.go#L77",
    "description": "allow not hava to be an array when there's single item",
    "description": "allow not having to be an array when there's single item",
    "oneOf": [
    {
    "type": "array",
    @@ -41,10 +41,22 @@
    "type": "boolean",
    "description": "Enable TCP Fast Open."
    },
    "tcp_multi_path": {
    "type": "boolean",
    "description": "Go 1.21 required.\nEnable TCP Multi Path."
    },
    "udp_fragment": {
    "type": "boolean",
    "description": "Enable UDP fragmentation."
    },
    "udp_timeout": {
    "type": "integer",
    "description": "UDP NAT expiration time in seconds, default is 300 (5 minutes)."
    },
    "detour": {
    "type": "string",
    "description": "If set, connections will be forwarded to the specified inbound. Requires target inbound support, see Injectable."
    },
    "sniff": {
    "type": "boolean",
    "description": "Enable sniffing. See Protocol Sniff for details."
    @@ -68,21 +80,9 @@
    ],
    "description": "If set, the requested domain name will be resolved to IP before routing. If sniff_override_destination is in effect, its value will be taken as a fallback."
    },
    "udp_timeout": {
    "type": "number",
    "description": "UDP NAT expiration time in seconds, default is 300 (5 minutes)."
    },
    "proxy_protocol": {
    "type": "boolean",
    "description": "Parse Proxy Protocol in the connection header."
    },
    "proxy_protocol_accept_no_header": {
    "udp_disable_domain_unmapping": {
    "type": "boolean",
    "description": "Accept connections without Proxy Protocol header."
    },
    "detour": {
    "type": "string",
    "description": "If set, connections will be forwarded to the specified inbound. Requires target inbound support, see Injectable."
    "description": "If enabled, for UDP proxy requests addressed to a domain, the original packet address will be sent in the response instead of the mapped domain.\nThis option is used for compatibility with clients that do not support receiving UDP packets with domain addresses, such as Surge."
    }
    },
    "required": [
    @@ -368,6 +368,30 @@
    }
    }
    },
    "ech": {
    "type": "object",
    "properties": {
    "enabled": {
    "type": "boolean"
    },
    "pq_signature_schemes_enabled": {
    "type": "boolean",
    "description": "Enable support for post-quantum peer certificate signature schemes.\nIt is recommended to match the parameters of sing-box generate ech-keypair."
    },
    "dynamic_record_sizing_disabled": {
    "type": "boolean",
    "description": "Disables adaptive sizing of TLS records.\nWhen true, the largest possible TLS record size is always used.\nWhen false, the size of TLS records may be adjusted in an attempt to improve latency."
    },
    "key": {
    "$ref": "#/$defs/listableString",
    "description": "ECH key line array, in PEM format."
    },
    "key_path": {
    "type": "string",
    "description": "The path to ECH key, in PEM format."
    }
    }
    },
    "reality": {
    "type": "object",
    "properties": {
    @@ -469,13 +493,20 @@
    "type": "boolean"
    },
    "pq_signature_schemes_enabled": {
    "type": "boolean"
    "type": "boolean",
    "description": "Enable support for post-quantum peer certificate signature schemes.\nIt is recommended to match the parameters of sing-box generate ech-keypair."
    },
    "dynamic_record_sizing_disabled": {
    "type": "boolean"
    "type": "boolean",
    "description": "Disables adaptive sizing of TLS records.\nWhen true, the largest possible TLS record size is always used.\nWhen false, the size of TLS records may be adjusted in an attempt to improve latency."
    },
    "config": {
    "type": "string"
    "type": "string",
    "description": "ECH key line array, in PEM format.\nIf empty, load from DNS will be attempted."
    },
    "config_path": {
    "type": "string",
    "description": "The path to ECH key, in PEM format.\nIf empty, load from DNS will be attempted."
    }
    }
    },
    @@ -536,7 +567,8 @@
    "http",
    "ws",
    "quic",
    "grpc"
    "grpc",
    "httpupgrade"
    ]
    }
    },
    @@ -553,7 +585,7 @@
    "then": {
    "properties": {
    "host": {
    "type": "array",
    "$ref": "#/$defs/listableString",
    "description": "List of host domain.\nThe client will choose randomly and the server will verify if not empty."
    },
    "path": {
    @@ -567,6 +599,16 @@
    "headers": {
    "type": "object",
    "description": "Extra headers of HTTP request.\nThe server will write in response if not empty."
    },
    "idle_timeout": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "In HTTP2 server:\nSpecifies the time until idle clients should be closed with a GOAWAY frame. PING frames are not considered as activity.\nIn HTTP2 client:\nSpecifies the period of time after which a health check will be performed using a ping frame if no frames have been received on the connection. Please note that a ping response is considered a received frame, so if there is no other traffic on the connection, the health check will be executed every interval. If the value is zero, no health check will be performed.\nZero is used by default."
    },
    "ping_timeout": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "In HTTP2 client:\nSpecifies the timeout duration after sending a PING frame, within which a response must be received. If a response to the PING frame is not received within the specified timeout duration, the connection will be closed. The default timeout duration is 15 seconds."
    }
    }
    }
    @@ -623,13 +665,69 @@
    "service_name": {
    "type": "string",
    "description": "Service name of gRPC."
    },
    "idle_timeout": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "In standard gRPC server/client:\nIf the transport doesn't see any activity after a duration of this time, it pings the client to check if the connection is still active.\nIn default gRPC server/client:\nIt has the same behavior as the corresponding setting in HTTP transport."
    },
    "ping_timeout": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "In standard gRPC server/client:\nThe timeout that after performing a keepalive check, the client will wait for activity. If no activity is detected, the connection will be closed.\nIn default gRPC server/client:\nIt has the same behavior as the corresponding setting in HTTP transport."
    },
    "permit_without_stream": {
    "type": "boolean",
    "description": "In standard gRPC client:\nIf enabled, the client transport sends keepalive pings even with no active connections. If disabled, when there are no active connections, idle_timeout and ping_timeout will be ignored and no keepalive pings will be sent.\nDisabled by default."
    }
    }
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "httpupgrade"
    }
    }
    },
    "then": {
    "properties": {
    "host": {
    "type": "string",
    "description": "Host domain.\nThe server will verify if not empty."
    },
    "path": {
    "type": "string",
    "description": "Path of HTTP request.\nThe server will verify if not empty."
    },
    "headers": {
    "type": "object",
    "description": "Extra headers of HTTP request.\nThe server will write in response if not empty."
    }
    }
    }
    }
    ]
    },
    "multiplexOptions": {
    "tcpBrutal": {
    "type": "object",
    "properties": {
    "enabled": {
    "type": "boolean",
    "description": "Enable TCP Brutal congestion control algorithm。"
    },
    "up_mbps": {
    "type": "integer",
    "description": "Upload bandwidth, in Mbps."
    },
    "down_mbps": {
    "type": "integer",
    "description": "Download bandwidth, in Mbps."
    }
    }
    },
    "outboundMultiplexOptions": {
    "type": "object",
    "properties": {
    "enabled": {
    @@ -655,6 +753,31 @@
    "max_streams": {
    "type": "integer",
    "description": "Maximum multiplexed streams in a connection before opening a new connection.\nConflict with max_connections and min_streams."
    },
    "padding": {
    "type": "boolean",
    "description": "Requires sing-box server version 1.3-beta9 or later.\nEnable padding."
    },
    "brutal": {
    "type": "object",
    "$ref": "#/$defs/tcpBrutal"
    }
    }
    },
    "inboundMultiplexOptions": {
    "type": "object",
    "properties": {
    "enabled": {
    "type": "boolean",
    "description": "Enable multiplex support."
    },
    "padding": {
    "type": "boolean",
    "description": "If enabled, non-padded connections will be rejected."
    },
    "brutal": {
    "type": "object",
    "$ref": "#/$defs/tcpBrutal"
    }
    }
    },
    @@ -697,7 +820,7 @@
    },
    "address": {
    "type": "string",
    "pattern": "local|\\d{1,3}(\\.\\d{1,3}){3}|((tcp|udp|)://\\d{1,3}(\\.\\d{1,3}){3})|(tls|https|quic|h3)://([a-z0-9.-]+)(/.*)?|(rcode://(success|format_error|server_failure|name_error|not_implemented|refused))|dhcp://(auto|en\\d+)",
    "pattern": "local|\\d{1,3}(\\.\\d{1,3}){3}|((tcp|udp|)://\\d{1,3}(\\.\\d{1,3}){3})|(tls|https|quic|h3)://([a-z0-9.-]+)(/.*)?|(rcode://(success|format_error|server_failure|name_error|not_implemented|refused))|dhcp://(auto|en\\d+)|fakeip",
    "description": "The address of the dns server."
    },
    "address_resolver": {
    @@ -728,7 +851,10 @@
    "type": "string",
    "description": "Tag of an outbound for connecting to the dns server."
    }
    }
    },
    "required": [
    "address"
    ]
    },
    "defaultDnsRule": {
    "type": "object",
    @@ -788,16 +914,22 @@
    },
    "geosite": {
    "$ref": "#/$defs/listableString",
    "description": "Match geosite."
    "description": "[Deprecated in sing-box 1.8.0] Match geosite.",
    "deprecated": true
    },
    "source_geoip": {
    "$ref": "#/$defs/listableString",
    "description": "Match source geoip."
    "description": "[Deprecated in sing-box 1.8.0] Match source geoip.",
    "deprecated": true
    },
    "source_ip_cidr": {
    "$ref": "#/$defs/listableString",
    "description": "Match source ip cidr."
    },
    "source_ip_is_private": {
    "type": "boolean",
    "description": "Match non-public source IP."
    },
    "source_port": {
    "$ref": "#/$defs/portNumber",
    "description": "Match source port."
    @@ -848,6 +980,18 @@
    "type": "string",
    "description": "Match Clash mode."
    },
    "wifi_ssid": {
    "$ref": "#/$defs/listableString",
    "description": "Only supported in graphical clients on Android and iOS.\nMatch WiFi SSID."
    },
    "wifi_bssid": {
    "$ref": "#/$defs/listableString",
    "description": "Only supported in graphical clients on Android and iOS.\nMatch WiFi BSSID."
    },
    "rule_set": {
    "$ref": "#/$defs/listableString",
    "description": "Match Rule Set."
    },
    "invert": {
    "type": "boolean",
    "description": "Invert match result."
    @@ -863,6 +1007,10 @@
    "disable_cache": {
    "type": "bool",
    "description": "Disable cache and save cache in this query."
    },
    "rewrite_ttl": {
    "type": "integer",
    "description": "Rewrite TTL in DNS responses."
    }
    },
    "required": [
    @@ -888,24 +1036,26 @@
    "items": {
    "$ref": "#/$defs/defaultDnsRule"
    },
    "description": "Included default rules."
    },
    "invert": {
    "description": "Included rules."
    }
    }
    },
    "fakeIP": {
    "type": "object",
    "properties": {
    "enabled": {
    "type": "boolean",
    "description": "Invert match result."
    "description": "Enable FakeIP service."
    },
    "server": {
    "inet4_range": {
    "type": "string",
    "description": "Tag of the target dns server."
    "description": "IPv4 address range for FakeIP."
    },
    "disable_cache": {
    "type": "bool",
    "description": "Disable cache and save cache in this query."
    "inet6_range": {
    "type": "string",
    "description": "IPv6 address range for FakeIP."
    }
    },
    "required": [
    "server"
    ]
    }
    },
    "dnsOptions": {
    "type": "object",
    @@ -951,6 +1101,17 @@
    "disable_expire": {
    "type": "boolean",
    "description": "Disable dns cache expire."
    },
    "independent_cache": {
    "type": "boolean",
    "description": "Make each DNS server's cache independent for special purposes. If enabled, will slightly degrade performance."
    },
    "reverse_mapping": {
    "type": "boolean",
    "description": "Stores a reverse mapping of IP addresses after responding to a DNS query in order to provide domain names when routing.\nSince this process relies on the act of resolving domain names by an application before making a request, it can be problematic in environments such as macOS, where DNS is proxied and cached by the system."
    },
    "fakeip": {
    "$ref": "#/$defs/fakeIP"
    }
    }
    },
    @@ -1006,6 +1167,8 @@
    "naive",
    "hysteria",
    "shadowtls",
    "tuic",
    "hysteria2",
    "vless",
    "tun",
    "redirect",
    @@ -1510,6 +1673,155 @@
    ]
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "tuic"
    }
    }
    },
    "then": {
    "allOf": [
    {
    "properties": {
    "users": {
    "type": "array",
    "items": {
    "type": "object",
    "properties": {
    "name": {
    "type": "string"
    },
    "uuid": {
    "type": "string",
    "description": "TUIC user uuid."
    },
    "password": {
    "type": "string",
    "description": "TUIC user password."
    }
    },
    "required": [
    "uuid"
    ]
    },
    "description": "TUIC users."
    },
    "congestion_control": {
    "type": "string",
    "enum": [
    "cubic",
    "new_reno",
    "bbr"
    ],
    "description": "QUIC congestion control algorithm.\nOne of: cubic, new_reno, bbr\ncubic is used by default."
    },
    "auth_timeout": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "How long the server should wait for the client to send the authentication command.\n3s is used by default."
    },
    "zero_rtt_handshake": {
    "type": "boolean",
    "description": "Enable 0-RTT QUIC connection handshake on the client side.\nThis is not impacting much on the performance, as the protocol is fully multiplexed.\n\nDisabling this is highly recommended, as it is vulnerable to replay attacks. See Attack of the clones."
    },
    "heartbeat": {
    "type": "string",
    "$ref": "#/$defs/durationStringPattern",
    "description": "Interval for sending heartbeat packets for keeping the connection alive.\n10s is used by default."
    },
    "tls": {
    "$ref": "#/$defs/inboundTlsOptions"
    }
    },
    "required": [
    "users",
    "tls"
    ]
    },
    {
    "$ref": "#/$defs/listenFields"
    }
    ]
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "hysteria2"
    }
    }
    },
    "then": {
    "allOf": [
    {
    "properties": {
    "up_mbps": {
    "type": "number",
    "description": "Max bandwidth, in Mbps.\nNot limited if empty.\nConflict with ignore_client_bandwidth."
    },
    "down_mbps": {
    "type": "number",
    "description": "Max bandwidth, in Mbps.\nNot limited if empty.\nConflict with ignore_client_bandwidth."
    },
    "obfs": {
    "type": "object",
    "properties": {
    "type": {
    "type": "string",
    "enum": [
    "salamander"
    ],
    "description": "QUIC traffic obfuscator type, only available with salamander.\nDisabled if empty."
    },
    "password": {
    "type": "string",
    "description": "QUIC traffic obfuscator password."
    }
    }
    },
    "users": {
    "type": "array",
    "items": {
    "type": "object",
    "properties": {
    "name": {
    "type": "string"
    },
    "password": {
    "type": "string",
    "description": "Authentication password"
    }
    }
    },
    "description": "Hysteria2 users"
    },
    "ignore_client_bandwidth": {
    "type": "boolean",
    "description": "Commands the client to use the BBR flow control algorithm instead of Hysteria CC.\nConflict with up_mbps and down_mbps."
    },
    "tls": {
    "$ref": "#/$defs/inboundTlsOptions"
    },
    "masquerade": {
    "type": "string",
    "description": "HTTP3 server behavior when authentication fails.\nA 404 page will be returned if empty.",
    "pattern": "file:\\/\\/.*|https?:\\/\\/.*"
    },
    "brutal_debug": {
    "type": "boolean",
    "description": "Enable debug information logging for Hysteria Brutal CC."
    }
    }
    },
    {
    "$ref": "#/$defs/listenFields"
    }
    ]
    }
    },
    {
    "if": {
    "properties": {
    @@ -1778,6 +2090,8 @@
    "shadowsocksr",
    "vless",
    "shadowtls",
    "tuic",
    "hysteria2",
    "tor",
    "ssh",
    "dns",
    @@ -2018,7 +2332,7 @@
    },
    "multiplex": {
    "type": "object",
    "$ref": "#/$defs/multiplexOptions"
    "$ref": "#/$defs/outboundMultiplexOptions"
    }
    },
    "required": [
    @@ -2117,7 +2431,7 @@
    },
    "multiplex": {
    "type": "object",
    "$ref": "#/$defs/multiplexOptions"
    "$ref": "#/$defs/outboundMultiplexOptions"
    },
    "transport": {
    "type": "object",
    @@ -2174,7 +2488,7 @@
    },
    "multiplex": {
    "type": "object",
    "$ref": "#/$defs/multiplexOptions"
    "$ref": "#/$defs/outboundMultiplexOptions"
    },
    "transport": {
    "type": "object",
    @@ -2574,6 +2888,158 @@
    ]
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "tuic"
    }
    }
    },
    "then": {
    "allOf": [
    {
    "properties": {
    "server": {
    "type": "string",
    "description": "The server address."
    },
    "server_port": {
    "type": "integer",
    "description": "The server port."
    },
    "uuid": {
    "type": "string",
    "description": "TUIC user uuid"
    },
    "password": {
    "type": "string",
    "description": "TUIC user password"
    },
    "congestion_control": {
    "type": "string",
    "enum": [
    "cubic",
    "new_reno",
    "bbr"
    ],
    "description": "QUIC congestion control algorithm"
    },
    "udp_relay_mode": {
    "type": "string",
    "oneOf": [
    {
    "const": "native",
    "description": "native UDP characteristics"
    },
    {
    "const": "quic",
    "description": "lossless UDP relay using QUIC streams, additional overhead is introduced"
    }
    ],
    "description": "UDP packet relay mode\nConflict with udp_over_stream."
    },
    "udp_over_stream": {
    "type": "boolean",
    "description": "This is the TUIC port of the UDP over TCP protocol, designed to provide a QUIC stream based UDP relay mode that TUIC does not provide. Since it is an add-on protocol, you will need to use sing-box or another program compatible with the protocol as a server.\n\nThis mode has no positive effect in a proper UDP proxy scenario and should only be applied to relay streaming UDP traffic (basically QUIC streams).\n\nConflict with udp_relay_mode."
    },
    "network": {
    "type": "string",
    "enum": [
    "tcp",
    "udp"
    ],
    "description": "Enabled network\nOne of tcp udp.\nBoth is enabled by default."
    },
    "tls": {
    "$ref": "#/$defs/outboundTlsOptions"
    }
    },
    "required": [
    "server",
    "server_port",
    "uuid",
    "password",
    "tls"
    ]
    },
    {
    "$ref": "#/$defs/dialFields"
    }
    ]
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "hysteria2"
    }
    }
    },
    "then": {
    "allOf": [
    {
    "properties": {
    "server": {
    "type": "string",
    "description": "The server address."
    },
    "server_port": {
    "type": "integer",
    "description": "The server port."
    },
    "up_mbps": {
    "type": "number",
    "description": "Max bandwidth, in Mbps.\nIf empty, the BBR congestion control algorithm will be used instead of Hysteria CC."
    },
    "down_mbps": {
    "type": "number",
    "description": "Max bandwidth, in Mbps.\nIf empty, the BBR congestion control algorithm will be used instead of Hysteria CC."
    },
    "obfs": {
    "type": "object",
    "properties": {
    "type": {
    "type": "string",
    "enum": [
    "salamander"
    ],
    "description": "QUIC traffic obfuscator type, only available with salamander.\nDisabled if empty."
    },
    "password": {
    "type": "string",
    "description": "QUIC traffic obfuscator password."
    }
    }
    },
    "password": {
    "type": "string",
    "description": "Authentication password."
    },
    "network": {
    "type": "string",
    "enum": [
    "tcp",
    "udp"
    ],
    "description": "Enabled network\nOne of tcp udp.\nBoth is enabled by default."
    },
    "tls": {
    "$ref": "#/$defs/outboundTlsOptions"
    },
    "brutal_debug": {
    "type": "boolean",
    "description": "Enable debug information logging for Hysteria Brutal CC."
    }
    }
    },
    {
    "$ref": "#/$defs/dialFields"
    }
    ]
    }
    },
    {
    "if": {
    "properties": {
    @@ -2795,6 +3261,13 @@
    6
    ]
    },
    "network": {
    "type": "string",
    "enum": [
    "tcp",
    "udp"
    ]
    },
    "auth_user": {
    "$ref": "#/$defs/listableString",
    "description": "Username, see each inbound for details."
    @@ -2803,13 +3276,6 @@
    "$ref": "#/$defs/listableString",
    "description": "Sniffed protocol, see Sniff for details."
    },
    "network": {
    "type": "string",
    "enum": [
    "tcp",
    "udp"
    ]
    },
    "domain": {
    "$ref": "#/$defs/listableString",
    "description": "Match full domain."
    @@ -2828,24 +3294,35 @@
    },
    "geosite": {
    "$ref": "#/$defs/listableString",
    "description": "Match geosite."
    "description": "[Deprecated in sing-box 1.8.0] Match geosite.",
    "deprecated": true
    },
    "source_geoip": {
    "$ref": "#/$defs/listableString",
    "description": "Match source geoip."
    "description": "[Deprecated in sing-box 1.8.0] Match source geoip.",
    "deprecated": true
    },
    "geoip": {
    "$ref": "#/$defs/listableString",
    "description": "Match geoip."
    "description": "[Deprecated in sing-box 1.8.0] Match geoip.",
    "deprecated": true
    },
    "source_ip_cidr": {
    "$ref": "#/$defs/listableString",
    "description": "Match source ip cidr."
    },
    "source_ip_is_private": {
    "type": "boolean",
    "description": "Match non-public source IP."
    },
    "ip_cidr": {
    "$ref": "#/$defs/listableString",
    "description": "Match ip cidr."
    },
    "ip_is_private": {
    "type": "boolean",
    "description": "Match non-public IP."
    },
    "source_port": {
    "$ref": "#/$defs/portNumber",
    "description": "Match source port."
    @@ -2896,6 +3373,18 @@
    "type": "string",
    "description": "Match Clash mode."
    },
    "wifi_ssid": {
    "$ref": "#/$defs/listableString",
    "description": "Only supported in graphical clients on Android and iOS. Match wifi ssid."
    },
    "wifi_bssid": {
    "$ref": "#/$defs/listableString",
    "description": "Only supported in graphical clients on Android and iOS. Match wifi bssid."
    },
    "rule_set": {
    "$ref": "#/$defs/listableString",
    "description": "Match rule set."
    },
    "invert": {
    "type": "boolean",
    "description": "Invert match result."
    @@ -2943,6 +3432,88 @@
    "outbound"
    ]
    },
    "ruleSet": {
    "type": "object",
    "allOf": [
    {
    "properties": {
    "type": {
    "type": "string",
    "enum": [
    "local",
    "remote"
    ],
    "description": "Type of Rule Set, local or remote"
    },
    "tag": {
    "type": "string",
    "description": "Tag of Rule Set"
    },
    "format": {
    "type": "string",
    "description": "Format of Rule Set, source or binary.",
    "enum": [
    "source",
    "binary"
    ]
    }
    },
    "required": [
    "type",
    "tag",
    "format"
    ]
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "local"
    }
    }
    },
    "then": {
    "properties": {
    "path": {
    "type": "string",
    "description": "File path of Rule Set."
    }
    },
    "required": [
    "path"
    ]
    }
    },
    {
    "if": {
    "properties": {
    "type": {
    "const": "remote"
    }
    }
    },
    "then": {
    "properties": {
    "url": {
    "type": "string",
    "description": "Download URL of Rule Set."
    },
    "download_detour": {
    "type": "string",
    "description": "Tag of the outbound to download rule-set.\nDefault outbound will be used if empty"
    },
    "update_interval": {
    "type": "string",
    "description": "Update interval of Rule Set.\n1d will be used if empty."
    }
    },
    "required": [
    "url"
    ]
    }
    }
    ]
    },
    "routeOptions": {
    "type": "object",
    "properties": {
    @@ -2965,6 +3536,13 @@
    ]
    }
    },
    "rule_set": {
    "type": "array",
    "items": {
    "type": "object",
    "$ref": "#/$defs/ruleSet"
    }
    },
    "final": {
    "type": "string",
    "description": "Default outbound tag. the first outbound will be used if empty."
    @@ -2990,6 +3568,27 @@
    "experimentalOptions": {
    "type": "object",
    "properties": {
    "cache_file": {
    "type": "object",
    "properties": {
    "enabled": {
    "type": "boolean",
    "description": "Enable cache file."
    },
    "path": {
    "type": "string",
    "description": "Path to the cache file.\ncache.db will be used if empty."
    },
    "cache_id": {
    "type": "string",
    "description": "Identifier in cache file.\nIf not empty, configuration specified data will use a separate store keyed by it."
    },
    "store_fakeip": {
    "type": "boolean",
    "description": "Store fakeip in cache file."
    }
    }
    },
    "clash_api": {
    "external_controller": {
    "type": "string",
    @@ -2999,6 +3598,14 @@
    "type": "string",
    "description": "A relative path to the configuration directory or an absolute path to a directory in which you put some static web resource. sing-box will then serve it at http://{{external-controller}}/ui."
    },
    "external_ui_download_url": {
    "type": "string",
    "description": "ZIP download URL for the external UI, will be used if the specified external_ui directory is empty.\nhttps://github.com/MetaCubeX/Yacd-meta/archive/gh-pages.zip will be used if empty."
    },
    "external_ui_download_detour": {
    "type": "string",
    "description": "The tag of the outbound to download the external UI.\nDefault outbound will be used if empty."
    },
    "secret": {
    "type": "string",
    "description": "Secret for the RESTful API (optional) Authenticate by spedifying HTTP header Authorization: Bearer ${secret} ALWAYS set a secret if RESTful API is listening on 0.0.0.0"
    @@ -3007,13 +3614,20 @@
    "type": "string",
    "description": "Default mode in clash, rule will be used if empty.\nThis setting has no direct effect, but can be used in routing and DNS rules via the clash_mode rule item."
    },
    "store_mode": {
    "type": "boolean",
    "description": "[Deprecated in sing-box 1.8.0] Store mode in cache file. Store Clash mode in cache file.",
    "deprecated": true
    },
    "store_selected": {
    "type": "boolean",
    "description": "The tag must be set for target outbounds.\nStore selected outbound for the Selector outbound in cache file."
    "description": "[Deprecated in sing-box 1.8.0] The tag must be set for target outbounds.\nStore selected outbound for the Selector outbound in cache file.",
    "deprecated": true
    },
    "cache_file": {
    "type": "string",
    "description": "Cache file path, cache.db will be used if empty."
    "description": "[Deprecated in sing-box 1.8.0] Cache file path, cache.db will be used if empty.",
    "deprecated": true
    }
    },
    "v2ray_api": {
  6. artiga033 revised this gist Mar 17, 2023. 1 changed file with 1 addition and 2 deletions.
    3 changes: 1 addition & 2 deletions sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -1208,8 +1208,7 @@
    },
    "required": [
    "method",
    "password",
    "listen_port"
    "password"
    ]
    },
    {
  7. artiga033 revised this gist Mar 15, 2023. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion sing-box.schema.json
    View file
    Original file line number Diff line number Diff line change
    @@ -910,7 +910,7 @@
    "dnsOptions": {
    "type": "object",
    "properties": {
    "server": {
    "servers": {
    "type": "array",
    "items": {
    "$ref": "#/$defs/dnsServer"
  8. artiga033 created this gist Mar 12, 2023.
    3,074 changes: 3,074 additions & 0 deletions sing-box.schema.json
    View file
    3,074 additions, 0 deletions not shown because the diff is too large. Please use a local Git client to view these changes.