大多数接口需要先通过 Web 登录,浏览器会自动携带会话 Cookie。第三方脚本可先调用登录接口获取会话。
WanOS Open API
系统能力与 API 接口
WanOS 后端开放了文件、存储、分享、应用、网络、Docker、计划任务等接口。你可以用这些接口对接自己的脚本、面板、自动化工具或第三方应用。
http://设备IP/api/statusCookie: wanos_session=...接入方式
GET 接口使用 query 参数;POST 接口通常使用 JSON,文件上传使用 multipart/form-data。
接口主要返回 JSON。下载、导出和预览类接口会返回文件流或代理内容。
curl -b "wanos_session=你的会话" http://设备IP/api/status
curl -b "wanos_session=你的会话" "http://设备IP/api/list?path=/"
常用能力
读取设备状态
/api/status获取 CPU、内存、运行状态等基础信息,用于监控面板或自动化巡检。
列出存储目录
/api/list?path=/mnt/sda1读取目录、文件和存储入口,适合接入自定义文件管理器。
上传文件
/api/upload通过 multipart/form-data 上传文件,常用于备份、同步和资料投递。
创建分享
/api/share/create把指定文件或目录生成分享链接,可用于外部工作流。
第三方内网穿透
/api/tunnel/start填写 NPC/NPS 服务端地址和 key,启用第三方穿透服务。
应用商店安装
/api/store/install按应用 ID 安装应用,可用于定制装机流程。
Docker 容器管理
/api/docker/containers读取和管理容器,扩展轻量服务编排。
计划任务
/api/cron/tasks查看和管理计划任务,实现定时脚本、备份和自动化。
完整接口清单
以下列表由当前 WanOS 后端路由生成。带 /api/remote/ 的远程兼容别名未重复列出,对应短路径接口可直接在本机使用。
认证与系统
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/backup/export | backup / export | 需要 Web 登录会话 Cookie |
| GET | /api/backup/import | backup / import | 需要 Web 登录会话 Cookie |
| POST | /api/backup/start | backup / start | 需要 Web 登录会话 Cookie |
| GET | /api/backup/status | backup / status | 需要 Web 登录会话 Cookie |
| GET | /api/backup/volumes | backup / volumes | 需要 Web 登录会话 Cookie |
| GET | /api/dashboard | dashboard | 需要 Web 登录会话 Cookie |
| POST | /api/diagnostics | diagnostics | 需要 Web 登录会话 Cookie |
| GET | /api/diagnostics/export | diagnostics / export | 需要 Web 登录会话 Cookie |
| GET | /api/health | health | 需要 Web 登录会话 Cookie |
| POST | /api/login | 登录 | 登录前可用/会话接口 |
| POST | /api/logout | 退出登录 | 登录前可用/会话接口 |
| GET | /api/me | 当前登录与设备资料 | 登录前可用/会话接口 |
| GET | /api/media | media | 需要 Web 登录会话 Cookie |
| GET | /api/media-player/ | media player / | 需要 Web 登录会话 Cookie |
| POST | /api/power | power | 需要 Web 登录会话 Cookie |
| GET/POST | /api/settings | settings | 需要 Web 登录会话 Cookie |
| POST | /api/settings/wallpaper | settings / wallpaper | 需要 Web 登录会话 Cookie |
| GET | /api/status | 系统状态 | 需要 Web 登录会话 Cookie |
| POST | /api/system | system | 需要 Web 登录会话 Cookie |
| GET | /api/system/cleanup/preview | system / cleanup / preview | 需要 Web 登录会话 Cookie |
| POST | /api/system/cleanup/run | system / cleanup / run | 需要 Web 登录会话 Cookie |
| POST | /api/system/command | system / command | 需要 Web 登录会话 Cookie |
| POST | /api/system/reset | system / reset | 需要 Web 登录会话 Cookie |
文件与存储
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| POST | /api/cloud-mount/apply | cloud mount / apply | 需要 Web 登录会话 Cookie |
| GET | /api/cloud-mount/status | cloud mount / status | 需要 Web 登录会话 Cookie |
| POST | /api/cloud-mount/unmount | cloud mount / unmount | 需要 Web 登录会话 Cookie |
| POST | /api/copy | copy | 需要 Web 登录会话 Cookie |
| POST | /api/delete | delete | 需要 Web 登录会话 Cookie |
| POST | /api/disk/eject | disk / eject | 需要 Web 登录会话 Cookie |
| POST | /api/disk/format-ext4 | disk / format ext4 | 需要 Web 登录会话 Cookie |
| POST | /api/disk/format-partition-ext4 | disk / format partition ext4 | 需要 Web 登录会话 Cookie |
| POST | /api/disk/mount | disk / mount | 需要 Web 登录会话 Cookie |
| GET | /api/disk/operation/status | disk / operation / status | 需要 Web 登录会话 Cookie |
| POST | /api/disk/partition | disk / partition | 需要 Web 登录会话 Cookie |
| POST | /api/disk/partition-layout | disk / partition layout | 需要 Web 登录会话 Cookie |
| POST | /api/disk/repair | disk / repair | 需要 Web 登录会话 Cookie |
| GET | /api/disk/sleep/apply | disk / sleep / apply | 需要 Web 登录会话 Cookie |
| GET | /api/disk/sleep/install-tool | disk / sleep / install tool | 需要 Web 登录会话 Cookie |
| GET | /api/disk/sleep/status | disk / sleep / status | 需要 Web 登录会话 Cookie |
| POST | /api/disk/unmount | disk / unmount | 需要 Web 登录会话 Cookie |
| GET | /api/disks | 磁盘列表 | 需要 Web 登录会话 Cookie |
| GET | /api/download | 下载文件 | 需要 Web 登录会话 Cookie |
| POST | /api/downloads/add | downloads / add | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/details | downloads / details | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/reannounce | downloads / reannounce | 需要 Web 登录会话 Cookie |
| POST | /api/downloads/remove | downloads / remove | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/start | downloads / start | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/stop | downloads / stop | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/tasks | downloads / tasks | 需要 Web 登录会话 Cookie |
| POST | /api/downloads/trackers | downloads / trackers | 需要 Web 登录会话 Cookie |
| GET | /api/downloads/verify | downloads / verify | 需要 Web 登录会话 Cookie |
| GET | /api/extract | extract | 需要 Web 登录会话 Cookie |
| GET | /api/file/content | file / content | 需要 Web 登录会话 Cookie |
| GET | /api/list | 目录列表 | 需要 Web 登录会话 Cookie |
| POST | /api/mkdir | mkdir | 需要 Web 登录会话 Cookie |
| POST | /api/move | move | 需要 Web 登录会话 Cookie |
| GET | /api/rename | rename | 需要 Web 登录会话 Cookie |
| POST | /api/search | 搜索文件 | 需要 Web 登录会话 Cookie |
| GET | /api/thumbnail | thumbnail | 需要 Web 登录会话 Cookie |
| POST | /api/touch | touch | 需要 Web 登录会话 Cookie |
| POST | /api/upload | 上传文件 | 需要 Web 登录会话 Cookie |
| GET | /api/volumes | 存储入口 | 需要 Web 登录会话 Cookie |
分享与媒体
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/music | music | 需要 Web 登录会话 Cookie |
| GET | /api/music/file/ | music / file / | 需要 Web 登录会话 Cookie |
| POST | /api/share/create | 创建分享 | 需要 Web 登录会话 Cookie |
| POST | /api/share/delete | share / delete | 需要 Web 登录会话 Cookie |
| GET | /api/share/download | share / download | 需要 Web 登录会话 Cookie |
| POST | /api/share/info | share / info | 需要 Web 登录会话 Cookie |
| GET | /api/share/list | share / list | 需要 Web 登录会话 Cookie |
| POST | /api/share/verify | share / verify | 需要 Web 登录会话 Cookie |
下载与计划任务
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| POST | /api/aria2/ | aria2 / | 需要 Web 登录会话 Cookie |
| POST | /api/aria2/jsonrpc | aria2 / jsonrpc | 需要 Web 登录会话 Cookie |
| POST | /api/aria2/start | aria2 / start | 需要 Web 登录会话 Cookie |
| POST | /api/cron/delete | cron / delete | 需要 Web 登录会话 Cookie |
| GET/POST | /api/cron/tasks | 计划任务列表 | 需要 Web 登录会话 Cookie |
| POST | /api/cron/toggle | cron / toggle | 需要 Web 登录会话 Cookie |
网络与远程访问
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/backend/apply | backend / apply | 需要 Web 登录会话 Cookie |
| GET | /api/backend/restart | backend / restart | 需要 Web 登录会话 Cookie |
| GET | /api/backend/start | backend / start | 需要 Web 登录会话 Cookie |
| GET | /api/backend/status | backend / status | 需要 Web 登录会话 Cookie |
| GET | /api/backend/stop | backend / stop | 需要 Web 登录会话 Cookie |
| POST | /api/network/heal | network / heal | 需要 Web 登录会话 Cookie |
| GET/POST | /api/network/mac | network / mac | 需要 Web 登录会话 Cookie |
| GET/POST | /api/network/overview | network / overview | 需要 Web 登录会话 Cookie |
| GET/POST | /api/network/status | network / status | 需要 Web 登录会话 Cookie |
| GET/POST | /api/network/watchdog | network / watchdog | 需要 Web 登录会话 Cookie |
| GET | /api/pro/devices | pro / devices | 需要 Web 登录会话 Cookie |
| POST | /api/pro/order | pro / order | 需要 Web 登录会话 Cookie |
| GET | /api/pro/order/status | pro / order / status | 需要 Web 登录会话 Cookie |
| GET | /api/pro/status | pro / status | 需要 Web 登录会话 Cookie |
| POST | /api/samba/apply | samba / apply | 需要 Web 登录会话 Cookie |
| GET | /api/samba/status | samba / status | 需要 Web 登录会话 Cookie |
| POST | /api/site/apply | site / apply | 需要 Web 登录会话 Cookie |
| GET | /api/site/status | site / status | 需要 Web 登录会话 Cookie |
| POST | /api/terminal/ | terminal / | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/custom-domain | tunnel / custom domain | 需要 Web 登录会话 Cookie |
| GET/POST | /api/tunnel/diagnose | tunnel / diagnose | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/order | tunnel / order | 需要 Web 登录会话 Cookie |
| GET | /api/tunnel/order/status | tunnel / order / status | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/plans | tunnel / plans | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/start | 启用第三方 NPC/NPS 穿透 | 需要 Web 登录会话 Cookie |
| GET | /api/tunnel/status | 内网穿透状态 | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/stop | tunnel / stop | 需要 Web 登录会话 Cookie |
| POST | /api/tunnel/test | 测试 NPC/NPS 服务端 | 需要 Web 登录会话 Cookie |
| POST | /api/wifi/connect | wifi / connect | 需要 Web 登录会话 Cookie |
| POST | /api/wifi/disable | wifi / disable | 需要 Web 登录会话 Cookie |
| GET/POST | /api/wifi/scan | wifi / scan | 需要 Web 登录会话 Cookie |
| GET/POST | /api/wifi/status | WiFi 状态 | 需要 Web 登录会话 Cookie |
应用与服务
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/alist | alist | 需要 Web 登录会话 Cookie |
| GET | /api/alist/ | alist / | 需要 Web 登录会话 Cookie |
| POST | /api/alist/start | alist / start | 需要 Web 登录会话 Cookie |
| GET | /api/apps | apps | 需要 Web 登录会话 Cookie |
| GET | /api/apps/save | apps / save | 需要 Web 登录会话 Cookie |
| GET | /api/apps/script/install | apps / script / install | 需要 Web 登录会话 Cookie |
| GET | /api/apps/script/status | apps / script / status | 需要 Web 登录会话 Cookie |
| GET | /api/apps/script/uninstall | apps / script / uninstall | 需要 Web 登录会话 Cookie |
| POST | /api/docker/action | docker / action | 需要 Web 登录会话 Cookie |
| GET | /api/docker/compose | docker / compose | 需要 Web 登录会话 Cookie |
| GET | /api/docker/compose-projects | docker / compose projects | 需要 Web 登录会话 Cookie |
| POST | /api/docker/config | docker / config | 需要 Web 登录会话 Cookie |
| POST | /api/docker/container-action | docker / container action | 需要 Web 登录会话 Cookie |
| GET | /api/docker/container-logs | docker / container logs | 需要 Web 登录会话 Cookie |
| GET | /api/docker/containers | Docker 容器 | 需要 Web 登录会话 Cookie |
| POST | /api/docker/image-action | docker / image action | 需要 Web 登录会话 Cookie |
| GET | /api/docker/images | docker / images | 需要 Web 登录会话 Cookie |
| POST | /api/docker/install | docker / install | 需要 Web 登录会话 Cookie |
| GET | /api/docker/logs | docker / logs | 需要 Web 登录会话 Cookie |
| POST | /api/docker/network-action | docker / network action | 需要 Web 登录会话 Cookie |
| GET | /api/docker/networks | docker / networks | 需要 Web 登录会话 Cookie |
| GET | /api/docker/registry-search | docker / registry search | 需要 Web 登录会话 Cookie |
| POST | /api/docker/run | docker / run | 需要 Web 登录会话 Cookie |
| GET | /api/docker/status | docker / status | 需要 Web 登录会话 Cookie |
| GET | /api/store/apps | 应用商店列表 | 需要 Web 登录会话 Cookie |
| GET | /api/store/casaos/apps | store / casaos / apps | 需要 Web 登录会话 Cookie |
| GET | /api/store/casaos/install | store / casaos / install | 需要 Web 登录会话 Cookie |
| GET | /api/store/casaos/uninstall | store / casaos / uninstall | 需要 Web 登录会话 Cookie |
| GET | /api/store/home-assistant/import | store / home assistant / import | 需要 Web 登录会话 Cookie |
| GET | /api/store/home-assistant/status | store / home assistant / status | 需要 Web 登录会话 Cookie |
| GET | /api/store/home-assistant/upload | store / home assistant / upload | 需要 Web 登录会话 Cookie |
| GET | /api/store/import/register | store / import / register | 需要 Web 登录会话 Cookie |
| GET | /api/store/import/start | store / import / start | 需要 Web 登录会话 Cookie |
| GET | /api/store/import/status | store / import / status | 需要 Web 登录会话 Cookie |
| GET | /api/store/import/upload | store / import / upload | 需要 Web 登录会话 Cookie |
| GET | /api/store/install | 安装应用 | 需要 Web 登录会话 Cookie |
| GET | /api/store/start | store / start | 需要 Web 登录会话 Cookie |
| GET | /api/store/stop | store / stop | 需要 Web 登录会话 Cookie |
| GET | /api/store/uninstall | store / uninstall | 需要 Web 登录会话 Cookie |
| GET | /api/store/update | store / update | 需要 Web 登录会话 Cookie |
其他接口
| 方法 | 接口 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/mobile/discover | mobile / discover | 需要 Web 登录会话 Cookie |
| POST | /api/scrape | scrape | 需要 Web 登录会话 Cookie |
| POST | /api/setup | setup | 需要 Web 登录会话 Cookie |
| POST | /api/task-manager | task manager | 需要 Web 登录会话 Cookie |
| POST | /api/task-manager/kill | task manager / kill | 需要 Web 登录会话 Cookie |
| POST | /api/trash/empty | trash / empty | 需要 Web 登录会话 Cookie |
| GET | /api/trash/list | trash / list | 需要 Web 登录会话 Cookie |
| POST | /api/trash/restore | trash / restore | 需要 Web 登录会话 Cookie |
| POST | /api/update/apply | update / apply | 需要 Web 登录会话 Cookie |
| POST | /api/update/check | update / check | 需要 Web 登录会话 Cookie |
| POST | /api/update/upload | update / upload | 需要 Web 登录会话 Cookie |