扫描 API

创建和管理扫描任务

扫描 API 用于创建和管理威胁扫描任务。

创建扫描任务

POST /v1/scans

请求体

{
  "domain": "example.com",
  "type": "ct_log"
}

扫描类型

类型	描述
`ct_log`	CT Log 证书透明度扫描
`dns`	DNS 相似域名扫描
`google_search`	Google 搜索扫描

响应示例

{
  "data": {
    "id": "scan_xxx",
    "domain": "example.com",
    "type": "ct_log",
    "status": "pending",
    "created_at": "2024-01-20T10:30:00Z"
  }
}

获取扫描状态

GET /v1/scans/:id

响应示例

{
  "data": {
    "id": "scan_xxx",
    "domain": "example.com",
    "type": "ct_log",
    "status": "completed",
    "progress": 100,
    "result": {
      "total_checked": 1250,
      "threats_found": 3
    },
    "created_at": "2024-01-20T10:30:00Z",
    "completed_at": "2024-01-20T10:35:00Z"
  }
}

扫描状态

状态	描述
`pending`	等待执行
`running`	执行中
`completed`	已完成
`failed`	执行失败

获取扫描列表

GET /v1/scans

查询参数

参数	类型	描述
`domain`	string	按域名筛选
`type`	string	按类型筛选
`status`	string	按状态筛选
`page`	number	页码
`per_page`	number	每页数量

取消扫描

POST /v1/scans/:id/cancel

响应示例

{
  "data": {
    "id": "scan_xxx",
    "status": "cancelled"
  }
}

只有状态为 pending 或 running 的扫描任务可以取消。

docs.threatsApi docs.whitelistConfig