W5 SOAR 文档

Appearance

Return to top
On this page

WebHook

API : /api/v1/w5/webhook

Method : POST

Headers：

参数值必填备注
Content-Typeapplication/json是声明 POST 类型为 JSON

Request：

json
// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
    "data":"WEBHOOK 测试"
}
参数值必填备注
key988BE26B18B20729806FE5C3DF7388EB是API KEY，系统管理处生成
uuid980b90b0-36d9-11eb-846f-dde86bba0048是WEBHOOK UUID
dataWEBHOOK 测试是剧本接收内容

Request：

json
// 返回例子
{   
    "code": 9018,
    "msg": "KEY 不正确"
}

今日执行统计

API : /api/v1/w5/get/workflow_exec

Method : POST

Headers：

参数值必填备注
Content-Typeapplication/json是声明 POST 类型为 JSON

Request：

json
// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}
参数值必填备注
key988BE26B18B20729806FE5C3DF7388EB是API KEY，系统管理处生成
uuid980b90b0-36d9-11eb-846f-dde86bba0048是剧本 UUID

Request：

json
// 返回例子
{
    "code": 0,
    "data": [
        {
            "time": "00",
            "value": 0
        },
        {
            "time": "01",
            "value": 0
        },
        {
            "time": "02",
            "value": 0
        },
        ...
    ],
    "msg": "Success"
}

剧本成功失败统计

API : /api/v1/w5/get/workflow_success_fail

Method : POST

Headers：

参数值必填备注
Content-Typeapplication/json是声明 POST 类型为 JSON

Request：

json
// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}
参数值必填备注
key988BE26B18B20729806FE5C3DF7388EB是API KEY，系统管理处生成
uuid980b90b0-36d9-11eb-846f-dde86bba0048是剧本 UUID

Request：

json
// 返回例子
{
    "code": 0,
    "data": {
        "fail_sum": 0,
        "success_sum": 3
    },
    "msg": "Success"
}

剧本执行日记 TOP 100

API : /api/v1/w5/get/workflow_logs

Method : POST

Headers：

参数值必填备注
Content-Typeapplication/json是声明 POST 类型为 JSON

Request：

json
// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}
参数值必填备注
key988BE26B18B20729806FE5C3DF7388EB是API KEY，系统管理处生成
uuid980b90b0-36d9-11eb-846f-dde86bba0048是剧本 UUID

Request：

json
// 返回例子
{
    "code": 0,
    "data": [
        {
            "app_name": "开始",
            "args": "",
            "create_time": "Sun, 17 Jan 2021 17:05:19 GMT",
            "id": 6696,
            "name": "未命名",
            "only_id": "202101171705189702431856",
            "result": "剧本开始执行",
            "status": 0,
            "uuid": "a5b211ea-58a2-11eb-9081-acbc32c7842d"
        },
        ....
    ],
    "msg": "Success"
}
参数备注
app_nameAPP 名称
argsAPP 参数
id自增长ID
name剧本名称
only_id执行批次号
result执行结果
status执行状态
uuid剧本 UUID

正在执行

API : /api/v1/w5/get/executing

Method : POST

Headers：

参数值必填备注
Content-Typeapplication/json是声明 POST 类型为 JSON

Request：

json
// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}
参数值必填备注
key988BE26B18B20729806FE5C3DF7388EB是API KEY，系统管理处生成
uuid980b90b0-36d9-11eb-846f-dde86bba0048否剧本 UUID，不填写 查看全部

Request：

json
// 返回例子
{
    "code": 0,
    "data": {
        "sum": "12"
    },
    "msg": "Success"
}

错误码

codemsg
0Success
9014WebHook 内容不能为空
9015WebHook UUID 不能为空
9016WebHook UUID 不正确
9017kEY 不能为空
9018KEY 不正确
9020工作流状态不可用