api

package

Go to main page

Versions in this module

v1

v1.1.4

Apr 2, 2026

Changes in this version

+ const MaxConsecutiveFailures

+ func IsAPIFailure(err error) bool

v1.1.3

Mar 23, 2026

v1.1.2

Feb 23, 2026

Changes in this version

type API

+ GetExemptUsers func() (exemptUsers []ExemptUser, err error)

+ type ExemptUser struct

+ ExemptRuleIDs []int

+ GlobalExempt bool

+ UID int

v1.1.1

Feb 22, 2026

v1.1.0

Jan 25, 2026

Changes in this version

type API

+ ReportMediaCheckResultForNode func(nodeID int, result string) error

v1.0.9

Jan 22, 2026

Changes in this version

type API

+ GetMediaCheckConfig func() (config *MediaCheckConfig, err error)

+ ReportMediaCheckResult func(result string) error

+ type MediaCheckConfig struct

+ CheckInterval int

+ Enabled bool

v1.0.8

Jan 6, 2026

v1.0.7

Dec 23, 2025

Changes in this version

type API

+ GetXrayRCertConfig func() (certConfig *XrayRCertConfig, err error)

+ type XrayRCertConfig struct

+ DNSEnv map[string]string

+ Email string

+ Provider string

v1.0.6

Dec 15, 2025

v1.0.5

Dec 10, 2025

Changes in this version

type Hysteria2Config

+ PortHopEnabled bool

+ PortHopPorts string

type NodeInfo

+ SNI string

v1.0.4

Dec 6, 2025

Changes in this version

type NodeInfo

+ TuicConfig *TuicConfig

+ type TuicConfig struct

+ ALPN []string

+ CongestionControl string

+ Heartbeat int

+ UDPRelayMode string

+ ZeroRTTHandshake bool

v1.0.3

Nov 26, 2025

v1.0.2

Nov 17, 2025

v1.0.1

Nov 16, 2025

Changes in this version

+ type AnyTLSConfig struct

+ PaddingScheme []string

type NodeInfo

+ AnyTLSConfig *AnyTLSConfig

v1.0.0

Nov 15, 2025

Changes in this version

+ type Hysteria2Config struct

+ DownMbps int

+ IgnoreClientBandwidth bool

+ Obfs string

+ ObfsPassword string

+ UpMbps int

type NodeInfo

+ Hysteria2Config *Hysteria2Config

v0

v0.9.9

Oct 23, 2025

Changes in this version

type DetectResult

+ IP string

v0.9.8

Oct 23, 2025

v0.9.7

Oct 21, 2025

Changes in this version

+ const NodeNotModified

+ const RuleNotModified

+ const UserNotModified

+ type API interface

+ Debug func()

+ Describe func() ClientInfo

+ GetNodeInfo func() (nodeInfo *NodeInfo, err error)

+ GetNodeRule func() (ruleList *[]DetectRule, err error)

+ GetUserList func() (userList *[]UserInfo, err error)

+ ReportIllegal func(detectResultList *[]DetectResult) (err error)

+ ReportNodeOnlineUsers func(onlineUser *[]OnlineUser) (err error)

+ ReportNodeStatus func(nodeStatus *NodeStatus) (err error)

+ ReportUserTraffic func(userTraffic *[]UserTraffic) (err error)

+ type ClientInfo struct

+ APIHost string

+ Key string

+ NodeID int

+ NodeType string

+ type Config struct

+ APIHost string

+ DeviceLimit int

+ DisableCustomConfig bool

+ EnableVless bool

+ Key string

+ NodeID int

+ NodeType string

+ RuleListPath string

+ SpeedLimit float64

+ Timeout int

+ VlessFlow string

+ type DetectResult struct

+ RuleID int

+ UID int

+ type DetectRule struct

+ ID int

+ Pattern *regexp.Regexp

+ type NodeInfo struct

+ AcceptProxyProtocol bool

+ AlterID uint16

+ Authority string

+ CypherMethod string

+ Dest string

+ EnableREALITY bool

+ EnableSniffing bool

+ EnableTFO bool

+ EnableTLS bool

+ EnableVless bool

+ FakeType string

+ Flow string

+ Header json.RawMessage

+ Headers map[string]string

+ Host string

+ HttpHeaders map[string]*conf.StringList

+ Key string

+ MaxClientVer string

+ MaxTimeDiff uint64

+ Method string

+ MinClientVer string

+ NameServerConfig []*conf.NameServerConfig

+ NodeID int

+ NodeType string

+ Path string

+ Port uint32

+ PrivateKey string

+ ProxyProtocolVer uint64

+ REALITYConfig *REALITYConfig

+ RejectUnknownSni bool

+ RouteOnly bool

+ Security string

+ ServerKey string

+ ServerNames []string

+ ServiceName string

+ ShortIds []string

+ Show bool

+ SpeedLimit uint64

+ TransportProtocol string

+ VlessFlow string

+ Xver uint64

+ type NodeStatus struct

+ CPU float64

+ Disk float64

+ Mem float64

+ Uptime uint64

+ type OnlineUser struct

+ IP string

+ UID int

+ type REALITYConfig struct

+ Dest string

+ MaxClientVer string

+ MaxTimeDiff uint64

+ MinClientVer string

+ PrivateKey string

+ ProxyProtocolVer uint64

+ ServerNames []string

+ ShortIds []string

+ type UserInfo struct

+ AlterID uint16

+ DeviceLimit int

+ Email string

+ Method string

+ Passwd string

+ Port uint32

+ SpeedLimit uint64

+ UID int

+ UUID string

+ type UserTraffic struct

+ Download int64

+ Email string

+ UID int

+ Upload int64

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL