JXWAF

# API接口

# 调用方式

API调用域名为自己的服务器地址，以下均按 www.jxwaf.com 做为前缀进行示意

所有的API接口只接受JSON格式数据

通用参数为api_key和api_password，这两个参数值需要登录控制台后，在 WAF管理 -> 全局配置 页面获取

# 获取域名列表

API地址:

https://www.jxwaf.com/api/waf_get_domain_list

参数:

{
    "page":1,
    "search":"",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "count":2,
    "message":[
        {
            "cc_attack_ip_protection":"false",
            "domain":"www.test1.com",
            "http":"true",
            "owasp_protection":"true",
            "cc_protection":"false",
            "evil_ip_handle":"false",
            "https":"false"
        },
        {
            "cc_attack_ip_protection":"false",
            "domain":"www.test2.com",
            "http":"true",
            "owasp_protection":"false",
            "cc_protection":"false",
            "evil_ip_handle":"false",
            "https":"false"
        }
    ],
    "now_page":1,
    "num_pages":1,
    "result":true
}

# 获取域名详细信息

API地址:

https://www.jxwaf.com/api/waf_get_domain

参数:

{
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message":{
        "public_key":null,
        "domain":"www.test1.com",
        "http":"true",
        "redirect_https":"false",
        "source_ip":"1.1.1.1",
        "private_key":null,
        "proxy_pass_https":"false",
        "proxy_ip":"",
        "proxy":"false",
        "https":"false",
        "source_http_port":"80"
    },
    "result":true
}

# 删除域名

API地址:

https://www.jxwaf.com/api/waf_del_domain

参数:

{
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message":"del success",
    "result":true
}

# 新建域名

API地址:

https://www.jxwaf.com/api/waf_create_domain

参数:

{
    "source_http_port":"80",
    "proxy_pass_https":"false",
    "proxy":"false",
    "redirect_https":"false",
    "domain":"www.test1.com",
    "proxy_ip":"",
    "source_ip":"1.1.1.1",
    "http":"true",
    "https":"false",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}
参数 描述
domain 域名
http 如果支持http访问，则值为"true"，否则为"false"
https 如果支持https访问，则值为"true"，否则为"false"
source_http_port 源服务器端口（仅支持http回源）
source_ip 回源ip
redirect_https 是否开启http强制跳转https，是则值为"true",否则为"false"
proxy_pass_https 是否使用https回源
proxy WAF是否存在代理，是则值为"true",否则为"false"
proxy_ip 代理地址,支持子网掩码，英文逗号分割

不清楚的可以查看控制台提交的请求参数

结果:

{
    "message": "create success",
    "result": true
}

# 编辑域名

API地址:

https://www.jxwaf.com/api/waf_edit_domain

参数:

{
    "source_http_port":"80",
    "proxy_pass_https":"false",
    "proxy":"false",
    "redirect_https":"false",
    "domain":"www.test1.com",
    "proxy_ip":"",
    "source_ip":"1.1.1.1",
    "http":"true",
    "https":"false",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}
参数 描述
domain 域名
http 如果支持http访问，则值为"true"，否则为"false"
https 如果支持https访问，则值为"true"，否则为"false"
source_http_port 源服务器端口（仅支持http回源）
source_ip 回源ip
redirect_https 是否开启http强制跳转https，是则值为"true",否则为"false"
proxy_pass_https 是否使用https回源
proxy WAF是否存在代理，是则值为"true",否则为"false"
proxy_ip 代理地址,支持子网掩码，英文逗号分割

不清楚的可以查看控制台提交的请求参数

结果:

{
    "message": "edit success",
    "result": true
}

# 获取域名防护配置

API地址:

https://www.jxwaf.com/api/waf_get_protection

参数:

{
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message":{
        "cc_attack_ip_protection":"false",
        "domain":"www.test1.com",
        "owasp_protection":"true",
        "data_mask":"false",
        "custom_protection":"false",
        "cc_protection":"false",
        "rule_engine":"false",
        "evil_ip_handle":"false",
        "page_custom":"false",
        "ip_config":"false"
    },
    "result":true
}

# 修改域名防护配置

API地址:

https://www.jxwaf.com/api/waf_edit_protection

参数:

{
    "cc_attack_ip_protection":"false",
    "domain":"www.test1.com",
    "owasp_protection":"true",
    "data_mask":"false",
    "custom_protection":"false",
    "cc_protection":"false",
    "rule_engine":"false",
    "evil_ip_handle":"false",
    "page_custom":"false",
    "ip_config":"false",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message": "edit success",
    "result": true
}

# 获取CC攻击防护配置

API地址:

https://www.jxwaf.com/api/waf_get_cc_protection

参数:

{
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message":{
        "count":"600",
        "black_ip_time":"60",
        "count_check":"false",
        "emergency_mode_check":"false",
        "ip_qps":"10",
        "domain_qps":"1000",
        "req_freq_handle_mode":"block",
        "emergency_handle_mode":"bot_check",
        "qps_check":"false",
        "ip_expire_qps":"10",
        "bot_check_mode":"standard",
        "domin_qps_handle_mode":"bot_check",
        "req_count_handle_mode":"block",
        "domain_qps_check":"false"
    },
    "result":true
}

# 修改CC攻击防护配置

API地址:

https://www.jxwaf.com/api/waf_edit_cc_protection

参数:

{
    "count":"600",
    "black_ip_time":"60",
    "count_check":"false",
    "emergency_mode_check":"false",
    "ip_qps":"10",
    "domain_qps":"1000",
    "req_freq_handle_mode":"block",
    "emergency_handle_mode":"bot_check",
    "qps_check":"false",
    "ip_expire_qps":"10",
    "bot_check_mode":"standard",
    "domin_qps_handle_mode":"bot_check",
    "req_count_handle_mode":"block",
    "domain_qps_check":"false",
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message": "edit success",
    "result": true
}

# 获取Web攻击防护配置

API地址:

https://www.jxwaf.com/api/waf_get_owasp_check

参数:

{
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message":{
        "sql_check":"block",
        "code_exec_check":"block",
        "command_inject_check":"block",
        "upload_check_rule":"(.jpg|.png)$",
        "sensitive_file_check":"block",
        "upload_check":"close",
        "xss_check":"block",
        "directory_traversal_check":"block",
        "owasp_protection_mode":"block"
    },
    "result":true
}

# 修改Web攻击防护配置

API地址:

https://www.jxwaf.com/api/waf_edit_owasp_check

参数:

{
    "sql_check":"block",
    "code_exec_check":"block",
    "command_inject_check":"block",
    "upload_check_rule":"(.jpg|.png)$",
    "sensitive_file_check":"block",
    "upload_check":"close",
    "xss_check":"block",
    "directory_traversal_check":"block",
    "owasp_protection_mode":"block",
    "domain":"www.test1.com",
    "api_key":"111c2355-de6a-452c-ad59-b440bee962e0",
    "api_password":"7575c387-404a-424b-88dd-715378b4f6f6"
}

结果:

{
    "message": "edit success",
    "result": true
}

←