Clash
  • Clash
  • RESTful API
    • Common
    • Proxies
    • Config
Powered by GitBook
On this page
  • 获得当前的基础设置
  • 增量修改配置
  • 重新加载配置文件
  • 获取所有已经解析的规则
  1. RESTful API

Config

获得当前的基础设置

GET /configs

{
    "port": 7890,
    "socket-port": 7891,
    "redir-port": 0,
    "allow-lan": true,
    "mode": "Rule",
    "log-level": "info"
}

增量修改配置

PATCH /configs

传入需要修改的配置即可

Request Body

Name
Type
Description

port

integer

HTTP 代理端口

socks-port

integer

Socks5 代理端口

redir-port

string

Redir 代理端口

allow-lan

boolean

是否把代理监听地址放到 0.0.0.0

mode

string

代理模式 ( Global | Rule | Direct )

log-level

string

设置 TTY 日志等级 ( info | warning | error | debug )


重新加载配置文件

PUT /configs

这个接口不会影响 external-controller 和 secret 的值

Query Parameters

Name
Type
Description

force

boolean

改变端口等信息

Request Body

Name
Type
Description

path

string

配置文件完整路径

获取所有已经解析的规则

GET /rules

{
    "rules": [
        { "type": "DomainSuffix", "payload": "google.com", "proxy": "Proxy" },
        { "type": "DomainKeyword", "payload": "google", "proxy": "Proxy" },
        { "type": "GEOIP", "payload": "CN", "proxy": "DIRECT" },
        { "type": "IPCIDR", "payload": "91.108.4.0/22", "proxy": "Proxy" },
        { "type": "FINAL", "payload": "", "proxy": "Proxy" }
    ]
}
PreviousProxies

Last updated 6 years ago