json-rpc-api-schema.json
1{
2 "components": {
3 "schemas": {
4 "difficulty": {
5 "type": "string",
6 "enum": [
7 "peaceful",
8 "easy",
9 "normal",
10 "hard"
11 ]
12 },
13 "game_type": {
14 "type": "string",
15 "enum": [
16 "survival",
17 "creative",
18 "adventure",
19 "spectator"
20 ]
21 },
22 "incoming_ip_ban": {
23 "type": "object",
24 "properties": {
25 "expires": {
26 "type": "string"
27 },
28 "ip": {
29 "type": "string"
30 },
31 "player": {
32 "$ref": "#/components/schemas/player"
33 },
34 "reason": {
35 "type": "string"
36 },
37 "source": {
38 "type": "string"
39 }
40 }
41 },
42 "ip_ban": {
43 "type": "object",
44 "properties": {
45 "expires": {
46 "type": "string"
47 },
48 "ip": {
49 "type": "string"
50 },
51 "reason": {
52 "type": "string"
53 },
54 "source": {
55 "type": "string"
56 }
57 }
58 },
59 "kick_player": {
60 "type": "object",
61 "properties": {
62 "message": {
63 "$ref": "#/components/schemas/message"
64 },
65 "player": {
66 "$ref": "#/components/schemas/player"
67 }
68 }
69 },
70 "message": {
71 "type": "object",
72 "properties": {
73 "literal": {
74 "type": "string"
75 },
76 "translatable": {
77 "type": "string"
78 },
79 "translatableParams": {
80 "type": "array",
81 "items": {
82 "type": "string"
83 }
84 }
85 }
86 },
87 "operator": {
88 "type": "object",
89 "properties": {
90 "bypassesPlayerLimit": {
91 "type": "boolean"
92 },
93 "permissionLevel": {
94 "type": "integer"
95 },
96 "player": {
97 "$ref": "#/components/schemas/player"
98 }
99 }
100 },
101 "player": {
102 "type": "object",
103 "properties": {
104 "id": {
105 "type": "string"
106 },
107 "name": {
108 "type": "string"
109 }
110 }
111 },
112 "server_state": {
113 "type": "object",
114 "properties": {
115 "players": {
116 "type": "array",
117 "items": {
118 "$ref": "#/components/schemas/player"
119 }
120 },
121 "started": {
122 "type": "boolean"
123 },
124 "version": {
125 "$ref": "#/components/schemas/version"
126 }
127 }
128 },
129 "system_message": {
130 "type": "object",
131 "properties": {
132 "message": {
133 "$ref": "#/components/schemas/message"
134 },
135 "overlay": {
136 "type": "boolean"
137 },
138 "receivingPlayers": {
139 "type": "array",
140 "items": {
141 "$ref": "#/components/schemas/player"
142 }
143 }
144 }
145 },
146 "typed_game_rule": {
147 "type": "object",
148 "properties": {
149 "type": {
150 "type": "string",
151 "enum": [
152 "integer",
153 "boolean"
154 ]
155 },
156 "key": {
157 "type": "string"
158 },
159 "value": {
160 "type": "string"
161 }
162 }
163 },
164 "untyped_game_rule": {
165 "type": "object",
166 "properties": {
167 "key": {
168 "type": "string"
169 },
170 "value": {
171 "type": "string"
172 }
173 }
174 },
175 "user_ban": {
176 "type": "object",
177 "properties": {
178 "expires": {
179 "type": "string"
180 },
181 "player": {
182 "$ref": "#/components/schemas/player"
183 },
184 "reason": {
185 "type": "string"
186 },
187 "source": {
188 "type": "string"
189 }
190 }
191 },
192 "version": {
193 "type": "object",
194 "properties": {
195 "name": {
196 "type": "string"
197 },
198 "protocol": {
199 "type": "integer"
200 }
201 }
202 }
203 }
204 },
205 "info": {
206 "title": "Minecraft Server JSON-RPC",
207 "version": "1.0.0"
208 },
209 "methods": [
210 {
211 "description": "Get the allowlist",
212 "name": "minecraft:allowlist",
213 "params": [],
214 "result": {
215 "name": "allowlist",
216 "schema": {
217 "type": "array",
218 "items": {
219 "$ref": "#/components/schemas/player"
220 }
221 }
222 }
223 },
224 {
225 "description": "Set the allowlist",
226 "name": "minecraft:allowlist/set",
227 "params": [
228 {
229 "name": "players",
230 "required": true,
231 "schema": {
232 "type": "array",
233 "items": {
234 "$ref": "#/components/schemas/player"
235 }
236 }
237 }
238 ],
239 "result": {
240 "name": "allowlist",
241 "schema": {
242 "type": "array",
243 "items": {
244 "$ref": "#/components/schemas/player"
245 }
246 }
247 }
248 },
249 {
250 "description": "Add players to allowlist",
251 "name": "minecraft:allowlist/add",
252 "params": [
253 {
254 "name": "add",
255 "required": true,
256 "schema": {
257 "type": "array",
258 "items": {
259 "$ref": "#/components/schemas/player"
260 }
261 }
262 }
263 ],
264 "result": {
265 "name": "allowlist",
266 "schema": {
267 "type": "array",
268 "items": {
269 "$ref": "#/components/schemas/player"
270 }
271 }
272 }
273 },
274 {
275 "description": "Remove players from allowlist",
276 "name": "minecraft:allowlist/remove",
277 "params": [
278 {
279 "name": "remove",
280 "required": true,
281 "schema": {
282 "type": "array",
283 "items": {
284 "$ref": "#/components/schemas/player"
285 }
286 }
287 }
288 ],
289 "result": {
290 "name": "allowlist",
291 "schema": {
292 "type": "array",
293 "items": {
294 "$ref": "#/components/schemas/player"
295 }
296 }
297 }
298 },
299 {
300 "description": "Clear all players in allowlist",
301 "name": "minecraft:allowlist/clear",
302 "params": [],
303 "result": {
304 "name": "allowlist",
305 "schema": {
306 "type": "array",
307 "items": {
308 "$ref": "#/components/schemas/player"
309 }
310 }
311 }
312 },
313 {
314 "description": "Get the ban list",
315 "name": "minecraft:bans",
316 "params": [],
317 "result": {
318 "name": "banlist",
319 "schema": {
320 "type": "array",
321 "items": {
322 "$ref": "#/components/schemas/user_ban"
323 }
324 }
325 }
326 },
327 {
328 "description": "Set the banlist",
329 "name": "minecraft:bans/set",
330 "params": [
331 {
332 "name": "bans",
333 "required": true,
334 "schema": {
335 "type": "array",
336 "items": {
337 "$ref": "#/components/schemas/user_ban"
338 }
339 }
340 }
341 ],
342 "result": {
343 "name": "banlist",
344 "schema": {
345 "type": "array",
346 "items": {
347 "$ref": "#/components/schemas/user_ban"
348 }
349 }
350 }
351 },
352 {
353 "description": "Add players to ban list",
354 "name": "minecraft:bans/add",
355 "params": [
356 {
357 "name": "add",
358 "required": true,
359 "schema": {
360 "type": "array",
361 "items": {
362 "$ref": "#/components/schemas/user_ban"
363 }
364 }
365 }
366 ],
367 "result": {
368 "name": "banlist",
369 "schema": {
370 "type": "array",
371 "items": {
372 "$ref": "#/components/schemas/user_ban"
373 }
374 }
375 }
376 },
377 {
378 "description": "Remove players from ban list",
379 "name": "minecraft:bans/remove",
380 "params": [
381 {
382 "name": "remove",
383 "required": true,
384 "schema": {
385 "type": "array",
386 "items": {
387 "$ref": "#/components/schemas/player"
388 }
389 }
390 }
391 ],
392 "result": {
393 "name": "banlist",
394 "schema": {
395 "type": "array",
396 "items": {
397 "$ref": "#/components/schemas/user_ban"
398 }
399 }
400 }
401 },
402 {
403 "description": "Clear all players in ban list",
404 "name": "minecraft:bans/clear",
405 "params": [],
406 "result": {
407 "name": "banlist",
408 "schema": {
409 "type": "array",
410 "items": {
411 "$ref": "#/components/schemas/user_ban"
412 }
413 }
414 }
415 },
416 {
417 "description": "Get the ip ban list",
418 "name": "minecraft:ip_bans",
419 "params": [],
420 "result": {
421 "name": "banlist",
422 "schema": {
423 "type": "array",
424 "items": {
425 "$ref": "#/components/schemas/ip_ban"
426 }
427 }
428 }
429 },
430 {
431 "description": "Set the ip banlist",
432 "name": "minecraft:ip_bans/set",
433 "params": [
434 {
435 "name": "banlist",
436 "required": true,
437 "schema": {
438 "type": "array",
439 "items": {
440 "$ref": "#/components/schemas/ip_ban"
441 }
442 }
443 }
444 ],
445 "result": {
446 "name": "banlist",
447 "schema": {
448 "type": "array",
449 "items": {
450 "$ref": "#/components/schemas/ip_ban"
451 }
452 }
453 }
454 },
455 {
456 "description": "Add ip to ban list",
457 "name": "minecraft:ip_bans/add",
458 "params": [
459 {
460 "name": "add",
461 "required": true,
462 "schema": {
463 "type": "array",
464 "items": {
465 "$ref": "#/components/schemas/incoming_ip_ban"
466 }
467 }
468 }
469 ],
470 "result": {
471 "name": "banlist",
472 "schema": {
473 "type": "array",
474 "items": {
475 "$ref": "#/components/schemas/ip_ban"
476 }
477 }
478 }
479 },
480 {
481 "description": "Remove ip from ban list",
482 "name": "minecraft:ip_bans/remove",
483 "params": [
484 {
485 "name": "ip",
486 "required": true,
487 "schema": {
488 "type": "array",
489 "items": {
490 "type": "string"
491 }
492 }
493 }
494 ],
495 "result": {
496 "name": "banlist",
497 "schema": {
498 "type": "array",
499 "items": {
500 "$ref": "#/components/schemas/ip_ban"
501 }
502 }
503 }
504 },
505 {
506 "description": "Clear all ips in ban list",
507 "name": "minecraft:ip_bans/clear",
508 "params": [],
509 "result": {
510 "name": "banlist",
511 "schema": {
512 "type": "array",
513 "items": {
514 "$ref": "#/components/schemas/ip_ban"
515 }
516 }
517 }
518 },
519 {
520 "description": "Get all connected players",
521 "name": "minecraft:players",
522 "params": [],
523 "result": {
524 "name": "players",
525 "schema": {
526 "type": "array",
527 "items": {
528 "$ref": "#/components/schemas/player"
529 }
530 }
531 }
532 },
533 {
534 "description": "Kick players",
535 "name": "minecraft:players/kick",
536 "params": [
537 {
538 "name": "kick",
539 "required": true,
540 "schema": {
541 "type": "array",
542 "items": {
543 "$ref": "#/components/schemas/kick_player"
544 }
545 }
546 }
547 ],
548 "result": {
549 "name": "kicked",
550 "schema": {
551 "type": "array",
552 "items": {
553 "$ref": "#/components/schemas/player"
554 }
555 }
556 }
557 },
558 {
559 "description": "Get all oped players",
560 "name": "minecraft:operators",
561 "params": [],
562 "result": {
563 "name": "operators",
564 "schema": {
565 "type": "array",
566 "items": {
567 "$ref": "#/components/schemas/operator"
568 }
569 }
570 }
571 },
572 {
573 "description": "Set all oped players",
574 "name": "minecraft:operators/set",
575 "params": [
576 {
577 "name": "operators",
578 "required": true,
579 "schema": {
580 "type": "array",
581 "items": {
582 "$ref": "#/components/schemas/operator"
583 }
584 }
585 }
586 ],
587 "result": {
588 "name": "operators",
589 "schema": {
590 "type": "array",
591 "items": {
592 "$ref": "#/components/schemas/operator"
593 }
594 }
595 }
596 },
597 {
598 "description": "Op players",
599 "name": "minecraft:operators/add",
600 "params": [
601 {
602 "name": "add",
603 "required": true,
604 "schema": {
605 "type": "array",
606 "items": {
607 "$ref": "#/components/schemas/operator"
608 }
609 }
610 }
611 ],
612 "result": {
613 "name": "operators",
614 "schema": {
615 "type": "array",
616 "items": {
617 "$ref": "#/components/schemas/operator"
618 }
619 }
620 }
621 },
622 {
623 "description": "Deop players",
624 "name": "minecraft:operators/remove",
625 "params": [
626 {
627 "name": "remove",
628 "required": true,
629 "schema": {
630 "type": "array",
631 "items": {
632 "$ref": "#/components/schemas/player"
633 }
634 }
635 }
636 ],
637 "result": {
638 "name": "operators",
639 "schema": {
640 "type": "array",
641 "items": {
642 "$ref": "#/components/schemas/operator"
643 }
644 }
645 }
646 },
647 {
648 "description": "Deop all players",
649 "name": "minecraft:operators/clear",
650 "params": [],
651 "result": {
652 "name": "operators",
653 "schema": {
654 "type": "array",
655 "items": {
656 "$ref": "#/components/schemas/operator"
657 }
658 }
659 }
660 },
661 {
662 "description": "Get server status",
663 "name": "minecraft:server/status",
664 "params": [],
665 "result": {
666 "name": "status",
667 "schema": {
668 "$ref": "#/components/schemas/server_state"
669 }
670 }
671 },
672 {
673 "description": "Save server state",
674 "name": "minecraft:server/save",
675 "params": [
676 {
677 "name": "flush",
678 "required": true,
679 "schema": {
680 "type": "boolean"
681 }
682 }
683 ],
684 "result": {
685 "name": "saving",
686 "schema": {
687 "type": "boolean"
688 }
689 }
690 },
691 {
692 "description": "Stop server",
693 "name": "minecraft:server/stop",
694 "params": [],
695 "result": {
696 "name": "stopping",
697 "schema": {
698 "type": "boolean"
699 }
700 }
701 },
702 {
703 "description": "Send a system message",
704 "name": "minecraft:server/system_message",
705 "params": [
706 {
707 "name": "message",
708 "required": true,
709 "schema": {
710 "$ref": "#/components/schemas/system_message"
711 }
712 }
713 ],
714 "result": {
715 "name": "sent",
716 "schema": {
717 "type": "boolean"
718 }
719 }
720 },
721 {
722 "description": "Get whether automatic world saving is enabled on the server",
723 "name": "minecraft:serversettings/autosave",
724 "params": [],
725 "result": {
726 "name": "enabled",
727 "schema": {
728 "type": "boolean"
729 }
730 }
731 },
732 {
733 "description": "Enable or disable automatic world saving on the server",
734 "name": "minecraft:serversettings/autosave/set",
735 "params": [
736 {
737 "name": "enable",
738 "required": true,
739 "schema": {
740 "type": "boolean"
741 }
742 }
743 ],
744 "result": {
745 "name": "enabled",
746 "schema": {
747 "type": "boolean"
748 }
749 }
750 },
751 {
752 "description": "Get the current difficulty level of the server",
753 "name": "minecraft:serversettings/difficulty",
754 "params": [],
755 "result": {
756 "name": "difficulty",
757 "schema": {
758 "$ref": "#/components/schemas/difficulty"
759 }
760 }
761 },
762 {
763 "description": "Set the difficulty level of the server",
764 "name": "minecraft:serversettings/difficulty/set",
765 "params": [
766 {
767 "name": "difficulty",
768 "required": true,
769 "schema": {
770 "$ref": "#/components/schemas/difficulty"
771 }
772 }
773 ],
774 "result": {
775 "name": "difficulty",
776 "schema": {
777 "$ref": "#/components/schemas/difficulty"
778 }
779 }
780 },
781 {
782 "description": "Get whether allowlist enforcement is enabled (kicks players immediately when removed from allowlist)",
783 "name": "minecraft:serversettings/enforce_allowlist",
784 "params": [],
785 "result": {
786 "name": "enforced",
787 "schema": {
788 "type": "boolean"
789 }
790 }
791 },
792 {
793 "description": "Enable or disable allowlist enforcement (when enabled, players are kicked immediately upon removal from allowlist)",
794 "name": "minecraft:serversettings/enforce_allowlist/set",
795 "params": [
796 {
797 "name": "enforce",
798 "required": true,
799 "schema": {
800 "type": "boolean"
801 }
802 }
803 ],
804 "result": {
805 "name": "enforced",
806 "schema": {
807 "type": "boolean"
808 }
809 }
810 },
811 {
812 "description": "Get whether the allowlist is enabled on the server",
813 "name": "minecraft:serversettings/use_allowlist",
814 "params": [],
815 "result": {
816 "name": "used",
817 "schema": {
818 "type": "boolean"
819 }
820 }
821 },
822 {
823 "description": "Enable or disable the allowlist on the server (controls whether only allowlisted players can join)",
824 "name": "minecraft:serversettings/use_allowlist/set",
825 "params": [
826 {
827 "name": "use",
828 "required": true,
829 "schema": {
830 "type": "boolean"
831 }
832 }
833 ],
834 "result": {
835 "name": "used",
836 "schema": {
837 "type": "boolean"
838 }
839 }
840 },
841 {
842 "description": "Get the maximum number of players allowed to connect to the server",
843 "name": "minecraft:serversettings/max_players",
844 "params": [],
845 "result": {
846 "name": "max",
847 "schema": {
848 "type": "integer"
849 }
850 }
851 },
852 {
853 "description": "Set the maximum number of players allowed to connect to the server",
854 "name": "minecraft:serversettings/max_players/set",
855 "params": [
856 {
857 "name": "max",
858 "required": true,
859 "schema": {
860 "type": "integer"
861 }
862 }
863 ],
864 "result": {
865 "name": "max",
866 "schema": {
867 "type": "integer"
868 }
869 }
870 },
871 {
872 "description": "Get the number of seconds before the game is automatically paused when no players are online",
873 "name": "minecraft:serversettings/pause_when_empty_seconds",
874 "params": [],
875 "result": {
876 "name": "seconds",
877 "schema": {
878 "type": "integer"
879 }
880 }
881 },
882 {
883 "description": "Set the number of seconds before the game is automatically paused when no players are online",
884 "name": "minecraft:serversettings/pause_when_empty_seconds/set",
885 "params": [
886 {
887 "name": "seconds",
888 "required": true,
889 "schema": {
890 "type": "integer"
891 }
892 }
893 ],
894 "result": {
895 "name": "seconds",
896 "schema": {
897 "type": "integer"
898 }
899 }
900 },
901 {
902 "description": "Get the number of seconds before idle players are automatically kicked from the server",
903 "name": "minecraft:serversettings/player_idle_timeout",
904 "params": [],
905 "result": {
906 "name": "seconds",
907 "schema": {
908 "type": "integer"
909 }
910 }
911 },
912 {
913 "description": "Set the number of seconds before idle players are automatically kicked from the server",
914 "name": "minecraft:serversettings/player_idle_timeout/set",
915 "params": [
916 {
917 "name": "seconds",
918 "required": true,
919 "schema": {
920 "type": "integer"
921 }
922 }
923 ],
924 "result": {
925 "name": "seconds",
926 "schema": {
927 "type": "integer"
928 }
929 }
930 },
931 {
932 "description": "Get whether flight is allowed for players in Survival mode",
933 "name": "minecraft:serversettings/allow_flight",
934 "params": [],
935 "result": {
936 "name": "allowed",
937 "schema": {
938 "type": "boolean"
939 }
940 }
941 },
942 {
943 "description": "Allow or disallow flight for players in Survival mode",
944 "name": "minecraft:serversettings/allow_flight/set",
945 "params": [
946 {
947 "name": "allow",
948 "required": true,
949 "schema": {
950 "type": "boolean"
951 }
952 }
953 ],
954 "result": {
955 "name": "allowed",
956 "schema": {
957 "type": "boolean"
958 }
959 }
960 },
961 {
962 "description": "Get the server's message of the day displayed to players",
963 "name": "minecraft:serversettings/motd",
964 "params": [],
965 "result": {
966 "name": "message",
967 "schema": {
968 "type": "string"
969 }
970 }
971 },
972 {
973 "description": "Set the server's message of the day displayed to players",
974 "name": "minecraft:serversettings/motd/set",
975 "params": [
976 {
977 "name": "message",
978 "required": true,
979 "schema": {
980 "type": "string"
981 }
982 }
983 ],
984 "result": {
985 "name": "message",
986 "schema": {
987 "type": "string"
988 }
989 }
990 },
991 {
992 "description": "Get the spawn protection radius in blocks (only operators can edit within this area)",
993 "name": "minecraft:serversettings/spawn_protection_radius",
994 "params": [],
995 "result": {
996 "name": "radius",
997 "schema": {
998 "type": "integer"
999 }
1000 }
1001 },
1002 {
1003 "description": "Set the spawn protection radius in blocks (only operators can edit within this area)",
1004 "name": "minecraft:serversettings/spawn_protection_radius/set",
1005 "params": [
1006 {
1007 "name": "radius",
1008 "required": true,
1009 "schema": {
1010 "type": "integer"
1011 }
1012 }
1013 ],
1014 "result": {
1015 "name": "radius",
1016 "schema": {
1017 "type": "integer"
1018 }
1019 }
1020 },
1021 {
1022 "description": "Get whether players are forced to use the server's default game mode",
1023 "name": "minecraft:serversettings/force_game_mode",
1024 "params": [],
1025 "result": {
1026 "name": "forced",
1027 "schema": {
1028 "type": "boolean"
1029 }
1030 }
1031 },
1032 {
1033 "description": "Enable or disable forcing players to use the server's default game mode",
1034 "name": "minecraft:serversettings/force_game_mode/set",
1035 "params": [
1036 {
1037 "name": "force",
1038 "required": true,
1039 "schema": {
1040 "type": "boolean"
1041 }
1042 }
1043 ],
1044 "result": {
1045 "name": "forced",
1046 "schema": {
1047 "type": "boolean"
1048 }
1049 }
1050 },
1051 {
1052 "description": "Get the server's default game mode",
1053 "name": "minecraft:serversettings/game_mode",
1054 "params": [],
1055 "result": {
1056 "name": "mode",
1057 "schema": {
1058 "$ref": "#/components/schemas/game_type"
1059 }
1060 }
1061 },
1062 {
1063 "description": "Set the server's default game mode",
1064 "name": "minecraft:serversettings/game_mode/set",
1065 "params": [
1066 {
1067 "name": "mode",
1068 "required": true,
1069 "schema": {
1070 "$ref": "#/components/schemas/game_type"
1071 }
1072 }
1073 ],
1074 "result": {
1075 "name": "mode",
1076 "schema": {
1077 "$ref": "#/components/schemas/game_type"
1078 }
1079 }
1080 },
1081 {
1082 "description": "Get the server's view distance in chunks",
1083 "name": "minecraft:serversettings/view_distance",
1084 "params": [],
1085 "result": {
1086 "name": "distance",
1087 "schema": {
1088 "type": "integer"
1089 }
1090 }
1091 },
1092 {
1093 "description": "Set the server's view distance in chunks",
1094 "name": "minecraft:serversettings/view_distance/set",
1095 "params": [
1096 {
1097 "name": "distance",
1098 "required": true,
1099 "schema": {
1100 "type": "integer"
1101 }
1102 }
1103 ],
1104 "result": {
1105 "name": "distance",
1106 "schema": {
1107 "type": "integer"
1108 }
1109 }
1110 },
1111 {
1112 "description": "Get the server's simulation distance in chunks",
1113 "name": "minecraft:serversettings/simulation_distance",
1114 "params": [],
1115 "result": {
1116 "name": "distance",
1117 "schema": {
1118 "type": "integer"
1119 }
1120 }
1121 },
1122 {
1123 "description": "Set the server's simulation distance in chunks",
1124 "name": "minecraft:serversettings/simulation_distance/set",
1125 "params": [
1126 {
1127 "name": "distance",
1128 "required": true,
1129 "schema": {
1130 "type": "integer"
1131 }
1132 }
1133 ],
1134 "result": {
1135 "name": "distance",
1136 "schema": {
1137 "type": "integer"
1138 }
1139 }
1140 },
1141 {
1142 "description": "Get whether the server accepts player transfers from other servers",
1143 "name": "minecraft:serversettings/accept_transfers",
1144 "params": [],
1145 "result": {
1146 "name": "accepted",
1147 "schema": {
1148 "type": "boolean"
1149 }
1150 }
1151 },
1152 {
1153 "description": "Enable or disable accepting player transfers from other servers",
1154 "name": "minecraft:serversettings/accept_transfers/set",
1155 "params": [
1156 {
1157 "name": "accept",
1158 "required": true,
1159 "schema": {
1160 "type": "boolean"
1161 }
1162 }
1163 ],
1164 "result": {
1165 "name": "accepted",
1166 "schema": {
1167 "type": "boolean"
1168 }
1169 }
1170 },
1171 {
1172 "description": "Get the interval in seconds between server status heartbeats",
1173 "name": "minecraft:serversettings/status_heartbeat_interval",
1174 "params": [],
1175 "result": {
1176 "name": "seconds",
1177 "schema": {
1178 "type": "integer"
1179 }
1180 }
1181 },
1182 {
1183 "description": "Set the interval in seconds between server status heartbeats",
1184 "name": "minecraft:serversettings/status_heartbeat_interval/set",
1185 "params": [
1186 {
1187 "name": "seconds",
1188 "required": true,
1189 "schema": {
1190 "type": "integer"
1191 }
1192 }
1193 ],
1194 "result": {
1195 "name": "seconds",
1196 "schema": {
1197 "type": "integer"
1198 }
1199 }
1200 },
1201 {
1202 "description": "Get default operator permission level",
1203 "name": "minecraft:serversettings/operator_user_permission_level",
1204 "params": [],
1205 "result": {
1206 "name": "level",
1207 "schema": {
1208 "type": "integer"
1209 }
1210 }
1211 },
1212 {
1213 "description": "Set default operator permission level",
1214 "name": "minecraft:serversettings/operator_user_permission_level/set",
1215 "params": [
1216 {
1217 "name": "level",
1218 "required": true,
1219 "schema": {
1220 "type": "integer"
1221 }
1222 }
1223 ],
1224 "result": {
1225 "name": "level",
1226 "schema": {
1227 "type": "integer"
1228 }
1229 }
1230 },
1231 {
1232 "description": "Get whether the server hides online player information from status queries",
1233 "name": "minecraft:serversettings/hide_online_players",
1234 "params": [],
1235 "result": {
1236 "name": "hidden",
1237 "schema": {
1238 "type": "boolean"
1239 }
1240 }
1241 },
1242 {
1243 "description": "Enable or disable hiding online player information from status queries",
1244 "name": "minecraft:serversettings/hide_online_players/set",
1245 "params": [
1246 {
1247 "name": "hide",
1248 "required": true,
1249 "schema": {
1250 "type": "boolean"
1251 }
1252 }
1253 ],
1254 "result": {
1255 "name": "hidden",
1256 "schema": {
1257 "type": "boolean"
1258 }
1259 }
1260 },
1261 {
1262 "description": "Get whether the server responds to connection status requests",
1263 "name": "minecraft:serversettings/status_replies",
1264 "params": [],
1265 "result": {
1266 "name": "enabled",
1267 "schema": {
1268 "type": "boolean"
1269 }
1270 }
1271 },
1272 {
1273 "description": "Enable or disable the server responding to connection status requests",
1274 "name": "minecraft:serversettings/status_replies/set",
1275 "params": [
1276 {
1277 "name": "enable",
1278 "required": true,
1279 "schema": {
1280 "type": "boolean"
1281 }
1282 }
1283 ],
1284 "result": {
1285 "name": "enabled",
1286 "schema": {
1287 "type": "boolean"
1288 }
1289 }
1290 },
1291 {
1292 "description": "Get the entity broadcast range as a percentage",
1293 "name": "minecraft:serversettings/entity_broadcast_range",
1294 "params": [],
1295 "result": {
1296 "name": "percentage_points",
1297 "schema": {
1298 "type": "integer"
1299 }
1300 }
1301 },
1302 {
1303 "description": "Set the entity broadcast range as a percentage",
1304 "name": "minecraft:serversettings/entity_broadcast_range/set",
1305 "params": [
1306 {
1307 "name": "percentage_points",
1308 "required": true,
1309 "schema": {
1310 "type": "integer"
1311 }
1312 }
1313 ],
1314 "result": {
1315 "name": "percentage_points",
1316 "schema": {
1317 "type": "integer"
1318 }
1319 }
1320 },
1321 {
1322 "description": "Get the available game rule keys and their current values",
1323 "name": "minecraft:gamerules",
1324 "params": [],
1325 "result": {
1326 "name": "gamerules",
1327 "schema": {
1328 "type": "array",
1329 "items": {
1330 "$ref": "#/components/schemas/typed_game_rule"
1331 }
1332 }
1333 }
1334 },
1335 {
1336 "description": "Update game rule value",
1337 "name": "minecraft:gamerules/update",
1338 "params": [
1339 {
1340 "name": "gamerule",
1341 "required": true,
1342 "schema": {
1343 "$ref": "#/components/schemas/untyped_game_rule"
1344 }
1345 }
1346 ],
1347 "result": {
1348 "name": "gamerule",
1349 "schema": {
1350 "$ref": "#/components/schemas/typed_game_rule"
1351 }
1352 }
1353 },
1354 {
1355 "description": "Server started",
1356 "name": "minecraft:notification/server/started",
1357 "params": []
1358 },
1359 {
1360 "description": "Server shutting down",
1361 "name": "minecraft:notification/server/stopping",
1362 "params": []
1363 },
1364 {
1365 "description": "Server save started",
1366 "name": "minecraft:notification/server/saving",
1367 "params": []
1368 },
1369 {
1370 "description": "Server save completed",
1371 "name": "minecraft:notification/server/saved",
1372 "params": []
1373 },
1374 {
1375 "description": "Player joined",
1376 "name": "minecraft:notification/players/joined",
1377 "params": [
1378 {
1379 "name": "player",
1380 "required": true,
1381 "schema": {
1382 "$ref": "#/components/schemas/player"
1383 }
1384 }
1385 ]
1386 },
1387 {
1388 "description": "Player left",
1389 "name": "minecraft:notification/players/left",
1390 "params": [
1391 {
1392 "name": "player",
1393 "required": true,
1394 "schema": {
1395 "$ref": "#/components/schemas/player"
1396 }
1397 }
1398 ]
1399 },
1400 {
1401 "description": "Player was oped",
1402 "name": "minecraft:notification/operators/added",
1403 "params": [
1404 {
1405 "name": "player",
1406 "required": true,
1407 "schema": {
1408 "$ref": "#/components/schemas/operator"
1409 }
1410 }
1411 ]
1412 },
1413 {
1414 "description": "Player was deoped",
1415 "name": "minecraft:notification/operators/removed",
1416 "params": [
1417 {
1418 "name": "player",
1419 "required": true,
1420 "schema": {
1421 "$ref": "#/components/schemas/operator"
1422 }
1423 }
1424 ]
1425 },
1426 {
1427 "description": "Player was added to allowlist",
1428 "name": "minecraft:notification/allowlist/added",
1429 "params": [
1430 {
1431 "name": "player",
1432 "required": true,
1433 "schema": {
1434 "$ref": "#/components/schemas/player"
1435 }
1436 }
1437 ]
1438 },
1439 {
1440 "description": "Player was removed from allowlist",
1441 "name": "minecraft:notification/allowlist/removed",
1442 "params": [
1443 {
1444 "name": "player",
1445 "required": true,
1446 "schema": {
1447 "$ref": "#/components/schemas/player"
1448 }
1449 }
1450 ]
1451 },
1452 {
1453 "description": "Ip was added to ip ban list",
1454 "name": "minecraft:notification/ip_bans/added",
1455 "params": [
1456 {
1457 "name": "player",
1458 "required": true,
1459 "schema": {
1460 "$ref": "#/components/schemas/ip_ban"
1461 }
1462 }
1463 ]
1464 },
1465 {
1466 "description": "Ip was removed from ip ban list",
1467 "name": "minecraft:notification/ip_bans/removed",
1468 "params": [
1469 {
1470 "name": "player",
1471 "required": true,
1472 "schema": {
1473 "type": "string"
1474 }
1475 }
1476 ]
1477 },
1478 {
1479 "description": "Player was added to ban list",
1480 "name": "minecraft:notification/bans/added",
1481 "params": [
1482 {
1483 "name": "player",
1484 "required": true,
1485 "schema": {
1486 "$ref": "#/components/schemas/user_ban"
1487 }
1488 }
1489 ]
1490 },
1491 {
1492 "description": "Player was removed from ban list",
1493 "name": "minecraft:notification/bans/removed",
1494 "params": [
1495 {
1496 "name": "player",
1497 "required": true,
1498 "schema": {
1499 "$ref": "#/components/schemas/player"
1500 }
1501 }
1502 ]
1503 },
1504 {
1505 "description": "Gamerule was changed",
1506 "name": "minecraft:notification/gamerules/updated",
1507 "params": [
1508 {
1509 "name": "gamerule",
1510 "required": true,
1511 "schema": {
1512 "$ref": "#/components/schemas/typed_game_rule"
1513 }
1514 }
1515 ]
1516 },
1517 {
1518 "description": "Server status heartbeat",
1519 "name": "minecraft:notification/server/status",
1520 "params": [
1521 {
1522 "name": "status",
1523 "required": true,
1524 "schema": {
1525 "$ref": "#/components/schemas/server_state"
1526 }
1527 }
1528 ]
1529 }
1530 ],
1531 "openrpc": "1.3.2"
1532}