news 2026/4/29 2:36:54

Huntarr API参考手册：完整接口说明和调用示例

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
Huntarr API参考手册：完整接口说明和调用示例

Huntarr API参考手册：完整接口说明和调用示例

【免费下载链接】Sonarr-HunterAssists Sonarr to check for missing TV Shows项目地址: https://gitcode.com/gh_mirrors/so/Sonarr-Hunter

Huntarr是一款功能强大的Sonarr辅助工具，专为帮助用户检查和管理缺失的电视剧集而设计。本API参考手册提供了Huntarr所有可用接口的详细说明和调用示例，帮助开发者和高级用户充分利用Huntarr的强大功能。

API基础信息

Huntarr API采用REST风格设计，所有接口均以/api/为前缀。API支持GET和POST两种HTTP方法，返回数据格式均为JSON。

基础URL

所有API端点的基础URL为：http://<huntarr-server-ip>:<port>/api/

认证方式

Huntarr API目前采用基于会话的认证机制，用户登录后系统会自动管理认证状态。

核心API接口

获取系统状态

接口信息

  • 端点:/api/health
  • 方法: GET
  • 描述: 获取Huntarr系统健康状态

响应示例

{ "status": "healthy", "version": "1.0.0", "database": "connected", "services": { "sonarr": "connected", "radarr": "disconnected" } }

获取所有配置

接口信息

  • 端点:/api/settings
  • 方法: GET
  • 描述: 获取Huntarr的所有配置设置

响应示例

{ "general": { "timezone": "Asia/Shanghai", "language": "zh-CN", "check_for_updates": true, "effective_timezone": "Asia/Shanghai" }, "sonarr": { "api_url": "http://localhost:8989", "api_key": "your_sonarr_api_key", "enabled": true }, // 其他应用配置... }

图1: Huntarr主界面展示了API配置和系统状态信息

获取功能标志

接口信息

  • 端点:/api/settings/feature-flags
  • 方法: GET
  • 描述: 获取Huntarr的功能标志设置

响应示例

{ "enable_requestarr": true, "enable_media_hunt": true, "enable_third_party_apps": true, "dev_mode": false }

保存通用设置

接口信息

  • 端点:/api/settings/general
  • 方法: POST
  • 描述: 更新Huntarr的通用设置

请求体示例

{ "timezone": "Asia/Shanghai", "auth_mode": "local_bypass", "check_for_updates": true, "stateful_management_hours": 24 }

响应示例

{ "success": true, "message": "General settings saved successfully" }

应用相关接口

获取已配置应用

接口信息

  • 端点:/api/configured-apps
  • 方法: GET
  • 描述: 获取所有已配置的应用列表

响应示例

["sonarr", "radarr", "lidarr", "readarr"]

获取应用状态

接口信息

  • 端点:/api/status/<app_name>
  • 方法: GET
  • 描述: 获取指定应用的连接状态

URL参数

  • app_name: 应用名称，如"sonarr"、"radarr"等

响应示例

{ "status": "connected", "version": "3.0.6.1342", "last_sync": "2023-11-15T10:30:45Z" }

图2: Huntarr媒体搜索界面，展示了通过API获取的媒体信息

获取应用设置

接口信息

  • 端点:/api/settings/<app_name>
  • 方法: GET
  • 描述: 获取指定应用的详细设置

URL参数

  • app_name: 应用名称，如"sonarr"、"radarr"等

响应示例

{ "api_url": "http://localhost:8989", "api_key": "your_sonarr_api_key", "enabled": true, "search_frequency": 30, "quality_profile": "HD-1080p" }

更新应用设置

接口信息

  • 端点:/api/settings/<app_name>
  • 方法: POST
  • 描述: 更新指定应用的设置

URL参数

  • app_name: 应用名称，如"sonarr"、"radarr"等

请求体示例

{ "api_url": "http://newhost:8989", "api_key": "new_api_key", "search_frequency": 60 }

响应示例

{ "success": true, "message": "Sonarr settings updated successfully" }

高级功能接口

获取周期状态

接口信息

  • 端点:/api/cycle/status
  • 方法: GET
  • 描述: 获取所有应用的周期状态信息

响应示例

{ "sonarr": { "last_run": "2023-11-15T09:45:12Z", "next_run": "2023-11-15T10:15:12Z", "status": "idle" }, "radarr": { "last_run": "2023-11-15T09:30:05Z", "next_run": "2023-11-15T10:00:05Z", "status": "idle" } }

重置应用周期

接口信息

  • 端点:/api/cycle/reset/<app_name>
  • 方法: POST
  • 描述: 重置指定应用的周期计时器

URL参数

  • app_name: 应用名称，如"sonarr"、"radarr"等

响应示例

{ "success": true, "message": "Sonarr cycle reset successfully", "next_run": "2023-11-15T09:50:23Z" }

图3: NZBHunt功能界面，展示了通过API获取和管理的下载任务

获取统计信息

接口信息

  • 端点:/api/stats
  • 方法: GET
  • 描述: 获取Huntarr系统统计信息

响应示例

{ "total_searches": 1245, "successful_downloads": 876, "failed_downloads": 56, "apps": { "sonarr": { "searches": 845, "downloads": 620 }, "radarr": { "searches": 400, "downloads": 256 } } }

实用工具接口

测试通知

接口信息

  • 端点:/api/test-notification
  • 方法: POST
  • 描述: 测试通知配置

请求体示例

{ "provider": "email", "recipient": "user@example.com" }

响应示例

{ "success": true, "message": "Test notification sent successfully" }

健康检查

接口信息

  • 端点:/ping
  • 方法: GET
  • 描述: 简单的健康检查接口

响应示例

{ "status": "ok", "timestamp": "2023-11-15T10:00:00Z" }

API使用示例

以下是使用Python请求Huntarr API的简单示例：

import requests BASE_URL = "http://localhost:5000/api" # 获取系统状态 response = requests.get(f"{BASE_URL}/health") print(response.json()) # 获取Sonarr设置 response = requests.get(f"{BASE_URL}/settings/sonarr") sonarr_settings = response.json() print(f"Sonarr URL: {sonarr_settings['api_url']}") # 更新Sonarr搜索频率 new_settings = { "search_frequency": 45 } response = requests.post(f"{BASE_URL}/settings/sonarr", json=new_settings) print(response.json())

图4: 请求管理界面，展示了通过API创建和管理的媒体请求

错误处理

Huntarr API使用标准HTTP状态码表示请求结果：

  • 200: 请求成功
  • 400: 请求参数错误
  • 401: 未授权
  • 404: 资源不存在
  • 500: 服务器内部错误

错误响应格式：

{ "success": false, "error": "错误描述信息", "code": "ERROR_CODE" }

总结

本手册详细介绍了Huntarr的API接口，包括系统状态、配置管理、应用控制和高级功能等方面。通过这些API，开发者可以轻松集成Huntarr的功能到自己的应用或脚本中，实现自动化管理和扩展Huntarr的能力。

如需了解更多关于Huntarr的信息，请参考项目文档：docs/

【免费下载链接】Sonarr-HunterAssists Sonarr to check for missing TV Shows项目地址: https://gitcode.com/gh_mirrors/so/Sonarr-Hunter

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

版权声明: 本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若内容造成侵权/违法违规/事实不符，请联系邮箱：809451989@qq.com进行投诉反馈，一经查实，立即删除！
网站建设 2026/4/11 7:09:11

GLM-4V-9B保姆级安装教程：Docker一键部署，支持多轮对话

GLM-4V-9B保姆级安装教程&#xff1a;Docker一键部署&#xff0c;支持多轮对话 1. 环境准备与快速部署 1.1 系统要求 操作系统&#xff1a;Linux (推荐Ubuntu 20.04)显卡&#xff1a;NVIDIA GPU (显存≥24GB)驱动&#xff1a;NVIDIA驱动≥515.65.01Docker&#xff1a;19.03C…

作者头像 李华
网站建设 2026/4/11 7:08:14

LVGL实战：手把手教你从零封装一个圆形时钟控件（附完整源码）

LVGL实战&#xff1a;从零构建高精度圆形时钟控件的完整指南 在嵌入式UI开发领域&#xff0c;LVGL&#xff08;Light and Versatile Graphics Library&#xff09;因其轻量级和高度可定制性而广受欢迎。本文将带您深入探索如何从零开始构建一个功能完备的圆形时钟控件&#xff…

作者头像 李华
网站建设 2026/4/17 2:19:24

像素时装锻造坊创意玩法：用AI设计独一无二的像素游戏角色服装

像素时装锻造坊创意玩法&#xff1a;用AI设计独一无二的像素游戏角色服装 1. 项目介绍 像素时装锻造坊是一款基于Stable Diffusion与Anything-v5的图像生成工作站&#xff0c;专为游戏开发者和像素艺术爱好者打造。它将AI图像生成技术与复古日系RPG的视觉风格完美结合&#x…

作者头像 李华
网站建设 2026/4/11 7:06:28

go-mysql-server事件调度器：自动化数据库任务管理的完整指南

go-mysql-server事件调度器&#xff1a;自动化数据库任务管理的完整指南 【免费下载链接】go-mysql-server A MySQL-compatible relational database with a storage agnostic query engine. Implemented in Go. 项目地址: https://gitcode.com/gh_mirrors/go/go-mysql-serve…

作者头像 李华
网站建设 2026/4/11 7:05:39

PynamoDB事务处理指南：确保数据一致性的终极方案

PynamoDB事务处理指南&#xff1a;确保数据一致性的终极方案 【免费下载链接】PynamoDB A pythonic interface to Amazons DynamoDB 项目地址: https://gitcode.com/gh_mirrors/py/PynamoDB PynamoDB作为Python开发者操作Amazon DynamoDB的高效工具&#xff0c;提供了强…

作者头像 李华
网站建设 2026/4/12 13:58:50

Coraza WAF：如何用Go语言构建企业级Web安全防护的终极方案

Coraza WAF&#xff1a;如何用Go语言构建企业级Web安全防护的终极方案 【免费下载链接】coraza OWASP Coraza WAF is a golang modsecurity compatible web application firewall library 项目地址: https://gitcode.com/gh_mirrors/co/coraza OWASP Coraza WAF是一款用…

作者头像 李华