MSLX 守护进程端 - API文档
MSLX 官网
MSLX 官网
    • 欢迎来到MSLX守护进程端API文档!
    • 基础信息
      • 守护进程端更新
        • 查询守护进程端更新信息
        • 获取守护进程端更新地址
        • 发起守护进程端自动更新
        • 监听守护进程端更新日志
      • 设置
        • 查询系统偏好设置
        • 修改系统偏好设置
        • 获取个人信息
        • 更新个人信息
        • 获取面板样式设置
        • 更新面板样式设置
      • MSL OAuth 登录到面板
        • 获取 MSL 登录地址(用于登录/绑定面板账号)
        • 绑定 MSL 账号
        • 通过 MSL 账号登录面板
        • 解绑 MSL 账号登录
      • 查询守护进程端基础信息
        GET
      • 查询面板自定义样式配置
        GET
      • 更新面板自定义样式
        POST
    • 服务端实例
      • 服务端创建与删除
        • 创建服务端实例
        • 获取创建服务端实例的进度
        • 删除服务端实例
        • 取消实例部署
      • 服务端实例控制
        • 玩家管理
          • 白名单管理
            • 获取白名单列表
            • 新增白名单用户
            • 移除白名单用户
          • 管理员管理
            • 获取管理员列表
            • 添加管理员
            • 移除管理员
          • 封禁玩家管理
            • 查询封禁玩家列表
            • 添加封禁玩家
            • 移除封禁玩家
          • 封禁IP管理
            • 封禁IP
            • 查询封禁IP列表
            • 解封IP
          • 获取在线玩家
          • 获取历史玩家缓存列表
        • 启动/停止服务端实例 & 备份服务端实例存档
        • 监听服务端实例日志 & 发送指令
      • 查询服务器实例信息
        • 查询服务器实例列表
        • 查询单个服务器实例信息
        • 获取服务端实例ICON
      • 服务器实例设置
        • 获取服务端实例通用设置信息
        • 更新服务端实例设置
        • 监听更新服务端实例进度
      • 定时任务管理
        • 创建定时任务
        • 更新定时任务
        • 获取全部定时任务
        • 获取特定实例的定时任务
        • 删除定时任务
      • 服务端备份管理
        • 获取指定实例的备份文件列表
        • 删除指定实例的指定备份文件
        • 下载指定备份文件
        • 获取全部实例的备份文件列表
      • 世界地图渲染
        • 获取世界出生点坐标
        • 获取瓦片渲染图
      • 查询电脑上的Java列表
        GET
    • Frp隧道
      • 创建隧道实例
        POST
      • 获取Frp隧道列表
        GET
      • 启动/结束Frp进程
        POST
      • 获取单个隧道实例信息
        GET
      • 删除隧道实例
        POST
      • 监听Frp实例日志
        SIGNALR
      • 修改Frp自启动隧道列表
        POST
      • 查询Frp自启动列表
        GET
    • 上传文件
      • 初始化文件上传
        POST
      • 上传分片文件
        POST
      • 完成文件上传
        POST
      • 删除上传的临时文件
        POST
      • 查询上传的压缩包包含的Jar包列表
        GET
    • 文件管理系统
      • 压缩 & 解压
        • 创建压缩任务
        • 获取压缩任务进度
        • 创建解压任务
        • 获取解压任务进度
      • 模组/插件管理
        • 获取目标实例的模组/插件列表
        • 对 模组/插件 进行 启用/禁用
      • 公共静态资源
        • 访问公共静态资源图片
        • 上传静态图片资源到公共文件夹
      • 离线下载
        • 新增离线下载任务
        • 查询离线下载任务状态
      • 守护进程本地文件列表
        • 获取本地文件列表
        • 获取挂载点/盘符
      • 查询实例的文件列表
      • 获取文件内容
      • 新建/编辑文件
      • 重命名文件夹/文件
      • 删除文件/文件夹
      • 上传文件
      • 下载文件
      • 新建文件夹
      • 移动文件
      • 复制文件
    • 用户管理
      • 管理用户列表
        • 获取用户列表
        • 更新用户信息
        • 创建新用户
        • 删除用户
      • 登录
    • 插件系统
      • 获取已加载的插件列表
      • 远程下载插件
      • 查询下载插件进度
    • 主从节点
      • 流量走向与请求路由指南
    • Docker 镜像管理
      • Docker 环境探测
      • 获取本地镜像列表
      • 获取 MSLX 内置预设镜像清单
      • 获取镜像详细元数据
      • 提交异步拉取镜像任务
      • 查询镜像拉取任务进度
      • 删除本地镜像
      • 清理悬空镜像 (Prune)
      • 为镜像打标签 (Tag)
      • 检测镜像 Remote 更新
    • 分布式子节点
      • 主节点专有接口 (Master)
        • 链接新子节点 (Link)
        • 获取集群节点列表
        • 解绑并删除指定节点
        • 修改节点信息并同步
        • 子节点鉴权用户 Token (Verify Token)
        • 子节点性能指标上报 (Report Stats)
      • 子节点专有接口 (Slave)
        • 接受主节点链接 (Accept Link)
        • 同步主节点配置 (Update Link)
    • 数据模型
      • DockerEnvStatus
      • LinkNodeRequest
      • DockerImageUsage
      • VerifyTokenRequest
      • DockerImageInfo
      • NodeStatsPayload
      • DockerPresetImage
      • AcceptLinkRequest
      • DockerImageDetail
      • UpdateLinkRequest
      • DockerPullRequest
      • SlaveNodeConfig
      • DockerPullTaskStatus
      • VerifyTokenResponseData
      • DockerImageDeleteRequest
      • AcceptLinkResponseData
      • DockerImageTagRequest
      • ApiResponseLinkNodeSuccess
      • DockerOperationResult
      • ApiResponseGetNodeListAdmin
      • DockerImageCheckUpdateRequest
      • ApiResponseVerifyToken
      • DockerImageCheckUpdateItem
      • ApiResponseAcceptLink
      • ApiResponse<DockerEnvStatus>
      • ApiResponseCommon
      • ApiResponse<List<DockerImageInfo>>
      • ApiResponse<List<DockerPresetImage>>
      • ApiResponse<DockerImageDetail>
      • ApiResponse<PullTaskSubmitted>
      • ApiResponse<DockerPullTaskStatus>
      • ApiResponse<DockerOperationResult>
      • ApiResponseImageInUseConflict
      • ApiResponse<List<DockerImageCheckUpdateItem>>

    欢迎来到MSLX守护进程端API文档!

    简介#

    这里是 MSLX 守护进程端完整 API 文档,欢迎以此进行二开内容!
    也欢迎提交资源到这里:MSLX 社区资源

    请求方法#

    MSLX API均使用 GET / POST 方法通讯。
    实时通讯部分采用 SignalR (需要安装SDK才可以调用)。

    鉴权方式#

    一般推荐使用 APIKey 完成鉴权流程。
    需要携带 Headers x-api-key 完成鉴权。
    也支持使用 Query 参数 x-api-key 完成鉴权。(为安全考虑,仅建议在 SignalR 时将 APIKey 放在查询参数)。
    修改于 2026-07-12 12:55:22
    下一页
    查询守护进程端更新信息
    Built with