REST API端点
RESTAPI提供对可用资源（如主机和会话）的访问。目前，您可以请求资源列表（带有索引请求）或单个资源的详细信息（带有显示请求），该资源由ID标识。
工作区
您可以创建工作区索引请求或工作区显示请求。
工作空间索引请求
返回Metasploit服务器上所有工作空间的列表。
URI
1.
/ rest_api / v2 /工作区
实例
1.
https://localhost:3790/rest_api/v2/workspaces
参数
调用这个端点需要以下参数:
- 没有一个
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
工作区显示请求
按ID返回工作区。
URI
1.
/rest_api/v2/workspaces/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1
参数
调用这个端点需要以下参数:
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 的名字
- 边界
- 描述
- 所有者id
- 将\u限制到\u网络
- 创建于
- 更新地址
主机
您可以创建主机索引请求或主机显示请求。
主机指数请求
返回特定工作区的主机列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts
参数
调用这个端点需要以下参数:
- workspace_id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
主机显示请求
按ID返回主机。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- workspace_id
- 住址
- 雨衣
- 通讯
- 的名字
- 状态
- os_名称
- 奥苏风味
- 奥斯乌sp
- 欧斯朗
- 拱
- 目的
- 信息
- 评论
- 范围
- 虚拟主机
- note_count
- 瓦伦计数
- service_count
- host_detail_count
- 利用\u尝试\u计数
- cred_count
- nexpose\u数据\u资产\u id
- 历史计数
- detected_arch
- 创建于
- 更新地址
笔记
您可以创建notes索引请求或notes显示请求。
笔记索引请求
返回特定主机的注释列表。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/notes
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/notes
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
请注意显示请求
根据ID返回一个注释。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/notes/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/notes/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- ntype
- workspace_id
- vuln_id
- service_id
- 主机id
- 至关重要的
- 看到
- 数据
- 创建于
- 更新地址
会话
您可以创建会话索引请求或会话显示请求。
会话索引请求
返回特定主机的会话列表。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/sessions
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/sessions
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
会话显示请求
根据ID返回一个会话。
URI
1.
/ rest_api / v2 /工作区:workspace_id /主机/:host_id /会议/:id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/sessions/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 主机id
- stype
- 利用漏洞
- 通过有效载荷
- desc
- 港口城市
- 平台
- 数据存储
- 关闭原因
- local_id
- 模块运行id
- 最后一次见面
- 活动编号
- opened_at
- 关闭于
服务
您可以创建服务索引请求或服务显示请求。
索引服务请求
返回特定主机的服务列表。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/services
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
服务展示请求
根据ID返回服务。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/services/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 主机id
- 港口城市
- 状态
- 的名字
- 信息
- 创建于
- 更新地址
Vulns
您可以创建vuln索引请求或vuln显示请求。
脆弱性指数请求
返回特定主机的漏洞列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/vulns
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/vulns
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
漏洞显示请求
通过ID返回一个漏洞。
URI
1.
/ rest_api / v2 /工作区:workspace_id /主机/:host_id /服务/:service_id / vulns: id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/vulns/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- id的整数
- service_id
- 主机id
- 的名字
- 信息
- exploited_at
- vuln_detail_count
- vuln\u尝试\u计数
- nexpose_数据_vuln_def_id
- 创建于
- 更新地址
网站
您可以创建网站索引请求或网站显示请求。
网站索引请求
返回特定工作区的网站列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u站点
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
网站上显示的要求
按ID返回网站。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u sites/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- service_id
- 虚拟主机
- 评论
- 选项
- 创建于
- 更新地址
网络表单
您可以创建一个web表单索引请求或web表单显示请求。
Web表单索引请求
返回web表单的列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u sites/：web\u site\u id/web\u forms
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_forms
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
Web表单显示请求
按ID返回web表单。
URI
1.
/ rest_api / v2 /工作区:workspace_id /主机/:host_id /服务/:service_id / web_sites: web_site_id / web_forms: id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_forms/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 网站id
- 路径
- 方法
- params
- 查询
- 创建于
- 更新地址
网页
您可以创建网页索引请求或网页显示请求。
网页索引请求
返回特定工作区的网页列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u sites/：web\u site\u id/web\u pages
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_pages
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
网页显示请求
按ID返回网页。
URI
1.
/ rest_api / v2 /工作区:workspace_id /主机/:host_id /服务/:service_id / web_sites: web_site_id / web_pages: id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_pages/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 网站id
- 路径
- 查询
- 密码
- 曲奇
- 认证
- ctype
- 时间
- 位置
- 标题数组
- 身体
- 请求
- 创建于
- 更新地址
Web Vulns
您可以创建web漏洞索引请求或web漏洞显示请求。
Web漏洞索引请求
返回特定工作区的web漏洞列表。
URI
1.
/rest\u api/v2/workspaces/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u sites/：web\u site\u id/web\u vulns
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_pages/web_vulns
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
响应
对这个端点的成功调用将返回一个200 OK响应和一个JSON对象。
Web漏洞显示请求
按ID返回web漏洞。
URI
1.
/rest\u api/v2/workspace/：workspace\u id/hosts/：host\u id/services/：service\u id/web\u sites/：web\u site\u id/web\u vulns/：id
实例
1.
https://localhost:3790/rest_api/v2/workspaces/1/hosts/1/services/1/web_sites/1/web_pages/web_vulns/1
参数
调用这个端点需要以下参数:
- workspace_id
- 主机id
- service_id
- 网站id
- 身份证件
响应
对这个端点的成功调用将返回一个200 OK响应和以下字段:
- 身份证件
- 网站id
- 路径
- 方法
- params
- pname
- 风险
- 的名字
- 查询
- 遗产类别
- 信心
- 描述
- 责备
- 请求
- 物主
- 有效载荷
- request_id
- 类别识别码
- 创建于
- 更新地址
RESTAPI示例
使用基于REST的API的简单示例。
红宝石
1.
开始
2.
要求“json”#提供与JSON格式之间的Ruby数据结构序列化
3.
要求“rest客户端”#超级-友好的HTTP访问
4.
救援装载错误
5.
把“请安装deps: \ n”
6.
把“gem安装json”
7.
把“gem安装rest客户端”
8.
终止
9
10
班MetasploitRestClient
11
属性读取器:令牌
12
13
def初始化(选择)
14
@代币=选择.获取(:令牌)
15
终止
16
17
def得到(网址,标题={},params={})
18
RestClient.得到(网址,标题.合并({令牌:令牌}))
19
终止
20
终止
21
22
令牌=ARGV[0]
23
客户=MetasploitRestClient.刚出现的(令牌:令牌)
24
25
#注:在里面生产,主办/港口城市/方案应“https/：3790”
26
网址=“http://localhost: 3000 / rest_api / v1 / social_engineering / campaigns.json”
27
活动=JSON.解析客户端.得到(网址)
28
p运动