文档首页
API docs by Redocly

爱快逆向 API - VPN (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

浏览器账密模式 /Action/call 逆向 API，当前分组：VPN。

页面内真实调用仍然走 /Action/call；/Action/call/_operations/* 只是 OpenAPI 展示用路径。

为避免 Redoc 单页一次性加载全部逆向接口导致浏览器 heap 过高，部署版按分类拆分。

会话

登录和会话建立

登录并建立浏览器 Cookie 会话

使用用户名和密码 MD5 登录。登录成功后，后续 /Action/call 依赖同一会话 Cookie。浏览器 API 可走 HTTP 或 HTTPS，实际是否允许 HTTP 取决于设备管理访问配置。

Request Body schema: application/json
required
username
required
string

登录用户名

passwd
required
string

密码 MD5 值

pass
required
string

密码 MD5 值，前端登录同时发送该字段

remember_password
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "passwd": "md5(password)",
  • "pass": "md5(password)",
  • "remember_password": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

通用调用

/Action/call 通用入口

通用 /Action/call 调用入口

所有页面内 API 调用都通过该路径提交 {func_name, action, param}。下方 /Action/call/_operations/* 路径是逐项文档展示路径，实际调用仍固定使用本路径。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string

爱快前端模块函数名

action
required
string

爱快前端动作名

required
object

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wan",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

IKEv2 VPN客户端管理API

来源分类: vpn

获取IKEv2客户端列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/ikev2/clients
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建IKEv2客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/ikev2/clients
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","comment":"codex_test","remote_addr":"vpn.example.com","interface":"wan1","authby":"mschapv2","secret":"codex_Test_123","leftid":"localikev2","rightid":"remoteikev2","username":"codex_test_user","passwd":"codex_Test_123","check_link_mode":2,"check_link_host":"www.baidu.com"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除IKEv2客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/ikev2/clients/{id}
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定IKEv2客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/ikev2/clients/{id}
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用IKEv2客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/ikev2/clients/{id}
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新IKEv2客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/ikev2/clients/{id}
  • 来源文件: vpn/network-ikev2.json
  • func_name: ike_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"id":"99999999","enabled":"no","name":"codex_test","remote_addr":"vpn.example.com","interface":"wan1","authby":"mschapv2","leftid":"localikev2","check_link_mode":1,"check_link_host":"www.baidu.com"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

IKEv2/IPSec服务器管理API

来源分类: vpn

获取IKEv2/IPSec服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/ikev2/services
  • 来源文件: vpn/auth-ikev2-server.json
  • func_name: ike_server
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_server"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_server",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新IKEv2/IPSec服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/ikev2/services
  • 来源文件: vpn/auth-ikev2-server.json
  • func_name: ike_server
  • action: save

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ike_server"

爱快前端模块函数名

action
required
string
Value: "save"

爱快前端动作名

required
object
Default: {"enabled":"no","authby":"mschapv2","addrpool":"10.6.1.0/24","secret":"codex_Test_123","leftid":"vpn.example.com","rightid":"","dns1":"192.0.2.254","dns2":"192.0.2.254","share_deny":0,"mtu":1400,"privatekey":"codex_Test_123","leftcert":"-----BEGIN#CERTIFICATE-----@MIIDWjCCAkKgAwIBAgIJAOikev2LeftCertDemoMA0GCSqGSIb3DQEBCwUAMDcxCzAJ@BgNVBAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgSUtFdjIg@Q0EwHhcNMjYwMjA2MTAzMTEwWhcNMzYwMjA0MTAzMTEwWjA4MQswCQYDVQQGEwJD@TjEOMAwGA1UECgwFaUt1YWkxGTAXBgNVBAMMEHZwbi5leGFtcGxlLmNvbTCCASIw@DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKikev2LeftCertDemoData11111@2222222222222222222222222222222222222222222222222222222222222222@3333333333333333333333333333333333333333333333333333333333333333@AgMBAAGjUDBOMB0GA1UdDgQWBBRikev2LeftCertDemo111111111111111111111@MA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAAaaaabbbbccccdddd@1111111111111111111111111111111111111111111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@-----END#CERTIFICATE-----@"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ike_server",
  • "action": "save",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

IPSEC VPN客户端管理API

来源分类: vpn

获取IPSEC客户端列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/ipsec/clients
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建IPSEC客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/ipsec/clients
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"name":"codex_test","comment":"codex_test","remote_addr":"vpn.ikuai.cn","authby":"secret","leftsubnet":"192.0.2.254","rightsubnet":"192.0.2.254","interface":"wan1","enabled":"no","keyexchange":"ikev2","aggressive":"0","ikelifetime":3,"ike_enc":"aes256","ike_auth":"sha256","ike_dh":"modp2048","secret":"codex_Test_123","lifetime":1,"esp_enc":"aes256","esp_auth":"sha256","dpdaction":"none","compress":"0"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除IPSEC客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/ipsec/clients/{id}
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定IPSEC客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/ipsec/clients/{id}
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用IPSEC客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/ipsec/clients/{id}
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新IPSEC客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/ipsec/clients/{id}
  • 来源文件: vpn/network-ipsec-vpn.json
  • func_name: ipsec-vpn
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "ipsec-vpn"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"id":"99999999","name":"codex_test","comment":"codex_test","remote_addr":"vpn.ikuai.cn","leftsubnet":"192.0.2.254","rightsubnet":"192.0.2.254","interface":"wan1","enabled":"no","keyexchange":"ikev2","aggressive":"0","ikelifetime":3,"ike_enc":"aes256","ike_auth":"sha256","ike_dh":"modp2048","authby":"secret","secret":"codex_Test_123","leftid":"localgateway","rightid":"remotegateway","privatekey":"codex_Test_123","leftcert":"","rightcert":"","lifetime":1,"esp_enc":"aes256","esp_auth":"sha256","compress":"0","dpdaction":"none","dpddelay":30,"dpdtimeout":150}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "ipsec-vpn",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

L2TP VPN客户端管理API

来源分类: vpn

获取L2TP客户端列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/l2tp/clients
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建L2TP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/l2tp/clients
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","comment":"codex_test","server":"vpn.example.com","server_port":1701,"username":"codex_test_user","passwd":"codex_Test_123","ipsec_secret":"ipseckey123","interface":"wan1","leftid":"locall2tp","rightid":"remotel2tp","upload":10000,"download":50000,"mtu":1400,"mru":1400,"check_link_mode":2,"check_link_host":"www.baidu.com","timing_rst_switch":0,"timing_rst_week":"1234567","timing_rst_time":"12:00","cycle_rst_time":0}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除L2TP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/l2tp/clients/{id}
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定L2TP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/l2tp/clients/{id}
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用L2TP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/l2tp/clients/{id}
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新L2TP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/l2tp/clients/{id}
  • 来源文件: vpn/network-l2tp-client.json
  • func_name: l2tp_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"id":"99999999","enabled":"no","name":"codex_test","server":"vpn.example.com","server_port":1701,"username":"codex_test_user","passwd":"codex_Test_123","interface":"wan1","mtu":1400,"mru":1400,"check_link_mode":1,"check_link_host":"www.baidu.com","timing_rst_switch":0,"cycle_rst_time":0,"ipsec_secret":"ipseckey123","leftid":"locall2tp","rightid":"remotel2tp","timing_rst_week":"1234567","timing_rst_time":"12:00","comment":"codex_test"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

L2TP服务器管理API

来源分类: vpn

获取L2TP服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/l2tp/services
  • 来源文件: vpn/auth-l2tp.json
  • func_name: l2tp_server
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_server"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_server",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新L2TP服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/l2tp/services
  • 来源文件: vpn/auth-l2tp.json
  • func_name: l2tp_server
  • action: save

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "l2tp_server"

爱快前端模块函数名

action
required
string
Value: "save"

爱快前端动作名

required
object
Default: {"enabled":"no","server_ip":"10.1.0.1","server_port":1701,"addr_pool":"10.1.0.2-10.1.0.254","dns1":"192.0.2.254","dns2":"192.0.2.254","mtu":1400,"mru":1400,"ipsec_secret":"mysecret","leftid":"vpn.example.com","rightid":"","force_ipsec":1}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "l2tp_server",
  • "action": "save",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

OpenVPN客户端管理API

来源分类: vpn

获取OpenVPN客户端列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/openvpn/clients
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建OpenVPN客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/openvpn/clients
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","comment":"codex_test","remote_addr":"vpn.ikuai.cn","remote_port":1194,"method":0,"username":"codex_test_user","password":"codex_Test_123","interface":"wan1","proto":"udp","dev_type":"tun","cipher":"AES-256-CBC","comp_lzo":"1","tun_mtu":1400,"ca":"-----BEGIN#CERTIFICATE-----@MIIDQTCCAimgAwIBAgIJAMqVcmi6/37xMA0GCSqGSIb3DQEBCwUAMDcxCzAJBgNV@BAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgRGV2aWNlIENB@MB4XDTI2MDIwNjEwMzExMFoXDTM2MDIwNDEwMzExMFowNzELMAkGA1UEBhMCQ04x@DjAMBgNVBAoMBWlLdWFpMRgwFgYDVQQDDA9pS3VhaSBEZXZpY2UgQ0EwggEiMA0G@CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCeCJGD4jX3PY5IdOYRv0gxfYPYikOc@hQkF5XAWQZgFxnuelDEkzl7RCOFVqsnwY/npOzI7VSsyLACPNkOdvyEvO+QGfRli@3zx0EfwRHGhLQbt/TDT0D9IZCab2oswdYjORtXcIe5dT3j2i8M2vv6wnJ7ip8GKu@ahfgJzakBZIRcQyEopTCmNbC5VAdCb/gQ0ezPnogPG6pbxxgE8OJIGH0+IgMFFTv@0wKVOCyHJgZNAZNnzP3yi5SCJvBnfU4wadXDAztGtq5El5l2lBP7s3KH65u0M/46@wo5NHyxZhn+M8S86EE4RkAeHI+1FqJASjW9ivNTRphFZMyW/Q4qbdEtrAgMBAAGj@UDBOMB0GA1UdDgQWBBRYp/q+2podeA2lc3khLBN+RGf+5TAfBgNVHSMEGDAWgBRY@p/q+2podeA2lc3khLBN+RGf+5TAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA@A4IBAQCHj5mxVYnaQcvMpjpWdXBS6XVpdiRpuqzRoqOYEnhzXOwwqnJ/EkJwa0RH@wFZUZrQC9bbxnIz+9kmlQKoTwtzzd9GVZeb3JeU9fcd/1BJdRLRiqqXw1EW0+QOV@7NCP1NqVMUsornypW1Y0JPcNfcvx/+oQXIIsS3EjOn+ye3ZASSRNi6+4zXNX2l53@8revjpAVnww0FS/zDeFGD9c9n6aYxvLxqXaBgNO3eOb2EAQAuNwncOvXZ9hBY8rz@A9jTuDVM1inhzROPguwt+j2moZedLm8DRgQxHjIkVvIOsq/50ApOVlGBCHjGJsay@tj3+p42yHrbmuCKvE6cCc0m2fhpw@-----END#CERTIFICATE-----@","accept_push_route":"0","route":"","timing_rst_switch":"0","check_link_mode":1,"check_link_host":"www.baidu.com","extra_config":""}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除OpenVPN客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/openvpn/clients/{id}
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定OpenVPN客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/openvpn/clients/{id}
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"total,data","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用OpenVPN客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/openvpn/clients/{id}
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新OpenVPN客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/openvpn/clients/{id}
  • 来源文件: vpn/network-openvpn-client.json
  • func_name: openvpn-client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"id":"99999999","enabled":"no","name":"codex_test","remote_addr":"vpn.ikuai.cn","remote_port":1194,"method":0,"interface":"wan1","proto":"udp","dev_type":"tun","cipher":"AES-256-CBC","tun_mtu":1400,"ca":"-----BEGIN#CERTIFICATE-----@MIIDQTCCAimgAwIBAgIJAMqVcmi6/37xMA0GCSqGSIb3DQEBCwUAMDcxCzAJBgNV@BAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgRGV2aWNlIENB@MB4XDTI2MDIwNjEwMzExMFoXDTM2MDIwNDEwMzExMFowNzELMAkGA1UEBhMCQ04x@DjAMBgNVBAoMBWlLdWFpMRgwFgYDVQQDDA9pS3VhaSBEZXZpY2UgQ0EwggEiMA0G@CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCeCJGD4jX3PY5IdOYRv0gxfYPYikOc@hQkF5XAWQZgFxnuelDEkzl7RCOFVqsnwY/npOzI7VSsyLACPNkOdvyEvO+QGfRli@3zx0EfwRHGhLQbt/TDT0D9IZCab2oswdYjORtXcIe5dT3j2i8M2vv6wnJ7ip8GKu@ahfgJzakBZIRcQyEopTCmNbC5VAdCb/gQ0ezPnogPG6pbxxgE8OJIGH0+IgMFFTv@0wKVOCyHJgZNAZNnzP3yi5SCJvBnfU4wadXDAztGtq5El5l2lBP7s3KH65u0M/46@wo5NHyxZhn+M8S86EE4RkAeHI+1FqJASjW9ivNTRphFZMyW/Q4qbdEtrAgMBAAGj@UDBOMB0GA1UdDgQWBBRYp/q+2podeA2lc3khLBN+RGf+5TAfBgNVHSMEGDAWgBRY@p/q+2podeA2lc3khLBN+RGf+5TAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA@A4IBAQCHj5mxVYnaQcvMpjpWdXBS6XVpdiRpuqzRoqOYEnhzXOwwqnJ/EkJwa0RH@wFZUZrQC9bbxnIz+9kmlQKoTwtzzd9GVZeb3JeU9fcd/1BJdRLRiqqXw1EW0+QOV@7NCP1NqVMUsornypW1Y0JPcNfcvx/+oQXIIsS3EjOn+ye3ZASSRNi6+4zXNX2l53@8revjpAVnww0FS/zDeFGD9c9n6aYxvLxqXaBgNO3eOb2EAQAuNwncOvXZ9hBY8rz@A9jTuDVM1inhzROPguwt+j2moZedLm8DRgQxHjIkVvIOsq/50ApOVlGBCHjGJsay@tj3+p42yHrbmuCKvE6cCc0m2fhpw@-----END#CERTIFICATE-----@","comp_lzo":"1","accept_push_route":"0","check_link_mode":1,"check_link_host":"www.baidu.com","timing_rst_switch":"0","tls_auth":"","cert":"-----BEGIN#CERTIFICATE-----@MIIDWjCCAkKgAwIBAgIJAOclientCertDemoMA0GCSqGSIb3DQEBCwUAMDcxCzAJ@BgNVBAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgQ2xpZW50@Q0EwHhcNMjYwMjA2MTAzMTEwWhcNMzYwMjA0MTAzMTEwWjA6MQswCQYDVQQGEwJD@TjEOMAwGA1UECgwFaUt1YWkxGzAZBgNVBAMMEm9wZW52cG4tY2xpZW50LWNlcnQw@ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCclientCertDemoData@1111111111111111111111111111111111111111111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@AgMBAAGjUDBOMB0GA1UdDgQWBBRclientCertDemo1111111111111111111111@MA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAAzzzzyyyyxxxxwwww@1111111111111111111111111111111111111111111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@-----END#CERTIFICATE-----@","key":"-----BEGIN#RSA#PRIVATE#KEY-----@MIIEowIBAAKCAQEAsclientPrivateKeyDemoData1111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@3333333333333333333333333333333333333333333333333333333333333333@AoIBAFclientPrivateKeyDemoPayload444444444444444444444444444444444@5555555555555555555555555555555555555555555555555555555555555555@6666666666666666666666666666666666666666666666666666666666666666@-----END#RSA#PRIVATE#KEY-----@","username":"codex_test_user","password":"codex_Test_123","extra_config":"","route":"","comment":"codex_test","timing_rst_week":"","timing_rst_time":""}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

OpenVPN服务器管理API

来源分类: vpn

获取OpenVPN服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/openvpn/services
  • 来源文件: vpn/auth-openvpn.json
  • func_name: openvpn-server
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-server"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-server",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新OpenVPN服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/openvpn/services
  • 来源文件: vpn/auth-openvpn.json
  • func_name: openvpn-server
  • action: save

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "openvpn-server"

爱快前端模块函数名

action
required
string
Value: "save"

爱快前端动作名

required
object
Default: {"enabled":"no","proto":"udp","port":"1194","subnet":"10.7.7.0","mask":"255.255.255.0","tun_mtu":"1400","cipher":"BF-CBC","comp_lzo":"1","dev_type":"tun","topology":"subnet","method":0,"tls_auth":"-----BEGIN#OpenVPN#Static#key#V1-----@2048#bit#OpenVPN#static#key@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@11111111111111111111111111111111@-----END#OpenVPN#Static#key#V1-----@","ca":"-----BEGIN#CERTIFICATE-----@MIIDQTCCAimgAwIBAgIJAMqVcmi6/37xMA0GCSqGSIb3DQEBCwUAMDcxCzAJBgNV@BAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgRGV2aWNlIENB@MB4XDTI2MDIwNjEwMzExMFoXDTM2MDIwNDEwMzExMFowNzELMAkGA1UEBhMCQ04x@DjAMBgNVBAoMBWlLdWFpMRgwFgYDVQQDDA9pS3VhaSBEZXZpY2UgQ0EwggEiMA0G@CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCeCJGD4jX3PY5IdOYRv0gxfYPYikOc@hQkF5XAWQZgFxnuelDEkzl7RCOFVqsnwY/npOzI7VSsyLACPNkOdvyEvO+QGfRli@3zx0EfwRHGhLQbt/TDT0D9IZCab2oswdYjORtXcIe5dT3j2i8M2vv6wnJ7ip8GKu@ahfgJzakBZIRcQyEopTCmNbC5VAdCb/gQ0ezPnogPG6pbxxgE8OJIGH0+IgMFFTv@0wKVOCyHJgZNAZNnzP3yi5SCJvBnfU4wadXDAztGtq5El5l2lBP7s3KH65u0M/46@wo5NHyxZhn+M8S86EE4RkAeHI+1FqJASjW9ivNTRphFZMyW/Q4qbdEtrAgMBAAGj@UDBOMB0GA1UdDgQWBBRYp/q+2podeA2lc3khLBN+RGf+5TAfBgNVHSMEGDAWgBRY@p/q+2podeA2lc3khLBN+RGf+5TAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUA@A4IBAQCHj5mxVYnaQcvMpjpWdXBS6XVpdiRpuqzRoqOYEnhzXOwwqnJ/EkJwa0RH@wFZUZrQC9bbxnIz+9kmlQKoTwtzzd9GVZeb3JeU9fcd/1BJdRLRiqqXw1EW0+QOV@7NCP1NqVMUsornypW1Y0JPcNfcvx/+oQXIIsS3EjOn+ye3ZASSRNi6+4zXNX2l53@8revjpAVnww0FS/zDeFGD9c9n6aYxvLxqXaBgNO3eOb2EAQAuNwncOvXZ9hBY8rz@A9jTuDVM1inhzROPguwt+j2moZedLm8DRgQxHjIkVvIOsq/50ApOVlGBCHjGJsay@tj3+p42yHrbmuCKvE6cCc0m2fhpw@-----END#CERTIFICATE-----@","cert":"-----BEGIN#CERTIFICATE-----@MIIDWjCCAkKgAwIBAgIJAOserverCertDemoMA0GCSqGSIb3DQEBCwUAMDcxCzAJ@BgNVBAYTAkNOMQ4wDAYDVQQKDAVpS3VhaTEYMBYGA1UEAwwPaUt1YWkgU2VydmVy@Q0EwHhcNMjYwMjA2MTAzMTEwWhcNMzYwMjA0MTAzMTEwWjA6MQswCQYDVQQGEwJD@TjEOMAwGA1UECgwFaUt1YWkxGzAZBgNVBAMMEm9wZW52cG4tc2VydmVyLWNlcnQw@ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCserverCertDemoData@1111111111111111111111111111111111111111111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@AgMBAAGjUDBOMB0GA1UdDgQWBBSserverCertDemo1111111111111111111111@MA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAAaabbbbccccdddd@1111111111111111111111111111111111111111111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@-----END#CERTIFICATE-----@","key":"-----BEGIN#RSA#PRIVATE#KEY-----@MIIEowIBAAKCAQEAsserverPrivateKeyDemoData1111111111111111111111111@2222222222222222222222222222222222222222222222222222222222222222@3333333333333333333333333333333333333333333333333333333333333333@AoIBAFserverPrivateKeyDemoPayload444444444444444444444444444444444@5555555555555555555555555555555555555555555555555555555555555555@6666666666666666666666666666666666666666666666666666666666666666@-----END#RSA#PRIVATE#KEY-----@","push_gateway":"0","push_route":"10.7.0.0/16","push_dns":"8.8.8.8","extra_config":""}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "openvpn-server",
  • "action": "save",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

PPTP VPN客户端管理API

来源分类: vpn

获取PPTP客户端列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/pptp/clients
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建PPTP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/pptp/clients
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","comment":"codex_test","server":"vpn.ikuai.cn","server_port":1723,"username":"codex_test_user","passwd":"codex_Test_123","interface":"wan1","mtu":1400,"mru":1400,"check_link_mode":2,"check_link_host":"www.baidu.com","timing_rst_switch":0,"timing_rst_week":"1234567","timing_rst_time":"12:00","cycle_rst_time":0}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除PPTP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/pptp/clients/{id}
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定PPTP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/pptp/clients/{id}
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用PPTP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/pptp/clients/{id}
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新PPTP客户端

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/pptp/clients/{id}
  • 来源文件: vpn/network-pptp-client.json
  • func_name: pptp_client
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_client"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"id":"99999999","enabled":"no","name":"codex_test","server":"vpn.ikuai.cn","username":"codex_test_user","passwd":"codex_Test_123","interface":"wan1","mtu":1400,"mru":1400,"server_port":1723,"check_link_mode":1,"check_link_host":"www.baidu.com","timing_rst_switch":0,"timing_rst_week":"1234567","timing_rst_time":"12:00","cycle_rst_time":0,"comment":"codex_test"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_client",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

PPTP服务器管理API

来源分类: vpn

获取PPTP服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/pptp/services
  • 来源文件: vpn/auth-pptp.json
  • func_name: pptp_server
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_server"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_server",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新PPTP服务器配置

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/pptp/services
  • 来源文件: vpn/auth-pptp.json
  • func_name: pptp_server
  • action: save

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "pptp_server"

爱快前端模块函数名

action
required
string
Value: "save"

爱快前端动作名

required
object
Default: {"enabled":"no","dns1":"192.0.2.254","dns2":"192.0.2.254","addr_pool":"10.0.0.2-10.0.0.254","open_mppe":2,"server_ip":"10.0.0.1","server_port":1723,"mtu":1400,"mru":1400}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "pptp_server",
  • "action": "save",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

WireGuard管理API

来源分类: vpn

获取WireGuard接口列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/wireguard
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建WireGuard接口

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/wireguard
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","interface":"auto","local_privatekey":"privatekey123","local_publickey":"publickey123","local_address":"10.0.0.1/24","local_listenport":5000,"mtu":1420}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除WireGuard接口

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/wireguard/{wg_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定WireGuard接口

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/wireguard/{wg_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用WireGuard接口

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/wireguard/{wg_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新WireGuard接口

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/wireguard/{wg_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","name":"codex_test","interface":"wan1","local_privatekey":"yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=","local_publickey":"HIgo9xNzJMWLKASShiTqIybxZ0U3wGLiUeJ1PKf8ykw=","local_address":"10.0.0.1/24","local_listenport":5000,"mtu":1420,"wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取WireGuard隧道列表

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/wireguard/{wg_id}/peers
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

创建WireGuard隧道

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: POST /api/v4.0/vpn/wireguard/{wg_id}/peers
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: add

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "add"

爱快前端动作名

required
object
Default: {"enabled":"no","comment":"codex_test","interface":"wan1","peer_publickey":"peerpublickey123","presharedkey":"sharedsecret123","allowips":"192.168.2.0/24","endpoint":"remote.example.com","endpoint_port":5001,"keepalive":10,"wg_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "add",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

删除WireGuard隧道

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: DELETE /api/v4.0/vpn/wireguard/{wg_id}/peers/{peer_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: del

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "del"

爱快前端动作名

required
object
Default: {"wg_id":"99999999","peer_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "del",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

获取指定WireGuard隧道

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: GET /api/v4.0/vpn/wireguard/{wg_id}/peers/{peer_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: show

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "show"

爱快前端动作名

required
object
Default: {"TYPE":"data,total","limit":"0,500","wg_id":"99999999","peer_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "show",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

启用/停用WireGuard隧道

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PATCH /api/v4.0/vpn/wireguard/{wg_id}/peers/{peer_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","wg_id":"99999999","peer_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}

更新WireGuard隧道

这是浏览器账密模式的 /Action/call 映射文档。

  • 实际请求路径: /Action/call
  • 来源文档路径: PUT /api/v4.0/vpn/wireguard/{wg_id}/peers/{peer_id}
  • 来源文件: vpn/network-wireguard.json
  • func_name: wireguard
  • action: edit

此 OpenAPI path 是为了让每个接口在文档中单独展示；调用设备时仍应 POST /Action/call，请求体使用本接口示例中的 JSON。

该接口属于写操作或状态变更操作。批量测试默认不执行写操作。

Authorizations:
IkuaiSessionCookie
Request Body schema: application/json
required
func_name
required
string
Value: "wireguard"

爱快前端模块函数名

action
required
string
Value: "edit"

爱快前端动作名

required
object
Default: {"enabled":"no","peer_publickey":"HIgo9xNzJMWLKASShiTqIybxZ0U3wGLiUeJ1PKf8ykw=","allowips":"192.168.2.0/24","comment":"codex_test","interface":"wan1","keepalive":10,"wg_id":"99999999","peer_id":"99999999"}

传给该 func/action 的参数对象。不同接口的 TYPE 和字段不同。

Responses

Request samples

Content type
application/json
{
  • "func_name": "wireguard",
  • "action": "edit",
  • "param": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "Result": 0,
  • "ErrMsg": "string",
  • "results": { },
  • "Data": { }
}