IBM QRadar API 示例项目教程

IBM QRadar API 示例项目教程

api-samples Samples code that uses QRadar API's 项目地址: https://gitcode.com/gh_mirrors/api/api-samples

1. 项目的目录结构及介绍

IBM/api-samples
├── asset_model
├── custom_actions
├── custom_properties
├── data_classification
├── domain_management
├── extension_management
├── introduction
├── modules
├── qvm
├── reference_data
├── servers
├── siem
├── tenant
├── .gitignore
├── LICENSE
├── apiclient.md
├── apiclient.py
├── readme.md

目录结构介绍

• asset_model: 包含与资产模型相关的API示例代码。
• custom_actions: 包含自定义操作相关的API示例代码。
• custom_properties: 包含自定义属性相关的API示例代码。
• data_classification: 包含数据分类相关的API示例代码。
• domain_management: 包含域管理相关的API示例代码。
• extension_management: 包含扩展管理相关的API示例代码。
• introduction: 包含API使用的入门示例代码。
• modules: 包含共享模块的代码。
• qvm: 包含Ariel相关的API示例代码。
• reference_data: 包含参考数据相关的API示例代码。
• servers: 包含服务器相关的API示例代码。
• siem: 包含SIEM相关的API示例代码。
• tenant: 包含租户相关的API示例代码。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证文件。
• apiclient.md: API客户端的Markdown文档。
• apiclient.py: API客户端的Python代码。
• readme.md: 项目的主README文件。

2. 项目的启动文件介绍

启动文件

• apiclient.py: 这是项目的启动文件，用于从命令行访问QRadar API。

启动步骤

1. 导航到项目根目录。
2. 运行以下命令启动API客户端：

   python apiclient.py
   

   如果您的系统上Python 3的二进制文件名称不同，请替换为相应的名称。

3. 项目的配置文件介绍

配置文件

• config.ini: 这是项目的配置文件，用于存储API访问的配置信息。

配置文件内容

[DEFAULT]
server_ip = [IP ADDRESS]
auth_token = [AUTH TOKEN] (Optional)
username = [USERNAME] (Optional)
password = [PASSWORD] (Optional)
certificate_file = [CERTIFICATE FILE] (Optional)

配置文件说明

• server_ip: QRadar安装的IP地址或域名。
• auth_token: 授权服务令牌（可选）。
• username: 用户名（可选）。
• password: 密码（可选）。
• certificate_file: TLS证书文件路径（可选）。

配置文件使用

• 首次运行示例脚本时，系统会提示您输入配置详细信息。
• 如果您选择将配置保存到磁盘，配置信息将以明文形式存储在config.ini文件中。
• 如果您选择不保存配置，每次运行示例脚本时都需要手动输入配置信息。

注意事项

• IBM建议不要将敏感凭据存储在配置文件中。
• 如果您的系统使用自签名TLS证书，必须提供TLS证书文件。

api-samples Samples code that uses QRadar API's 项目地址: https://gitcode.com/gh_mirrors/api/api-samples