Minecraft JSON-RPC API文档
    Minecraft JSON-RPC API文档
    • JSON-RPC API说明
    • 白名单管理
      • 获取白名单
        POST
      • 设置白名单
        POST
      • 添加玩家到白名单
        POST
      • 从白名单移除玩家
        POST
      • 清空白名单
        POST
    • 封禁管理
      • 获取封禁列表
        POST
      • 设置封禁列表
        POST
      • 添加玩家到封禁列表
        POST
      • 从封禁列表移除玩家
        POST
      • 清空封禁列表
        POST
      • 获取IP封禁列表
        POST
      • 设置IP封禁列表
        POST
      • 添加IP到封禁列表
        POST
      • 从封禁列表移除IP
        POST
      • 清空IP封禁列表
        POST
    • 玩家管理
      • 获取在线玩家
        POST
      • 踢出玩家
        POST
    • 管理员权限
      • 获取管理员列表
        POST
      • 设置管理员列表
        POST
      • 添加管理员权限
        POST
      • 移除管理员权限
        POST
      • 清空管理员列表
        POST
    • 服务器控制
      • 获取服务器状态
        POST
      • 保存服务器世界
        POST
      • 停止服务器
        POST
      • 发送系统消息
        POST
      • 获取自动保存设置
        POST
      • 设置自动保存
        POST
      • 获取服务器难度
        POST
      • 设置服务器难度
        POST
      • 获取强制白名单设置
        POST
      • 设置强制白名单
        POST
      • 获取白名单启用状态
        POST
      • 设置白名单启用状态
        POST
      • 获取最大玩家数
        POST
      • 设置最大玩家数
        POST
      • 获取空服暂停时间
        POST
      • 设置空服暂停时间
        POST
      • 获取玩家挂机超时时间
        POST
      • 设置玩家挂机超时时间
        POST
      • 获取飞行权限设置
        POST
      • 设置飞行权限
        POST
      • 获取服务器欢迎信息
        POST
      • 设置服务器欢迎信息
        POST
      • 获取出生点保护半径
        POST
      • 设置出生点保护半径
        POST
      • 获取强制游戏模式设置
        POST
      • 设置强制游戏模式
        POST
      • 获取默认游戏模式
        POST
      • 设置默认游戏模式
        POST
      • 获取视距设置
        POST
      • 设置视距
        POST
      • 获取模拟距离设置
        POST
      • 设置模拟距离
        POST
      • 获取服务器传送设置
        POST
      • 设置服务器传送
        POST
      • 获取状态心跳间隔
        POST
      • 设置状态心跳间隔
        POST
      • 获取管理员权限等级
        POST
      • 设置管理员权限等级
        POST
      • 获取隐藏在线玩家设置
        POST
      • 设置隐藏在线玩家
        POST
      • 获取状态回复设置
        POST
      • 设置状态回复
        POST
      • 获取实体广播范围
        POST
      • 设置实体广播范围
        POST
    • 游戏规则
      • 获取游戏规则
      • 更新游戏规则
    • 数据模型
      • Schemas
        • untyped_game_rule
        • incoming_ip_ban
        • system_message
        • kick_player
        • ip_ban
        • typed_game_rule
        • user_ban
        • message
        • version
        • server_state
        • operator
        • player
        • JsonRpcRequest
        • JsonRpcResponse
        • JsonRpcError
        • WebSocketNotification

    JSON-RPC API说明

    ⚠️请注意:本文档因WebSocket类型接口不方便编写,以HTTP请求方式展示接口,请自行以规范形式调用
    Minecraft JSON-RPC API是一个在Snapshot-25w35a引入的基于WebSocket的服务器管理协议
    新增JSON-RPC - 双向实时通信
    客户端 ────请求────→ 服务器
    客户端 ←────响应──── 服务器
    客户端 ←──实时通知─── 服务器

    连接步骤#

    1.
    建立WebSocket连接:ws://your-server-host:port
    2.
    发送JSON-RPC请求
    3.
    接收响应和实时通知

    服务器配置#

    在 server.properties 中启用管理API:
    该 API 遵循 JSON-RPC 2.0 规范
    修改于 2025-08-26 18:48:06
    下一页
    获取白名单
    Built with