सार्वजनिक API
दस्तावेज़ अनुक्रमणिका पर वापस जाएं
पैनल के बाहर से सर्वर की स्थिति प्राप्त करने के लिए एक छोटा, केवल-पढ़ने योग्य HTTP API: एक स्थिति डैशबोर्ड, एक अपटाइम मॉनिटर, एक Discord बॉट, एक होम-ऑटोमेशन नियम। यह पैनल द्वारा ही परोसा जाता है और वही लाइव डेटा लौटाता है जो पैनल के अपने पृष्ठ दिखाते हैं (इन-मेमोरी कैश से), इसलिए इसे पोल करने से Docker कभी नहीं छूता है।
यह तब तक बंद रहता है जब तक कोई एडमिन इसका उपयोग नहीं करता और एडमिन-गेटेड है। जब तक टोकन मौजूद नहीं होता तब तक कुछ भी उजागर नहीं होता है।
इसे सक्षम करना
Section titled “इसे सक्षम करना”सेटिंग्स → पब्लिक API → नया कुंजी (New Key)। इसे एक नाम दें, चुनें कि यह क्या देख सकता है (सभी सर्वर, या एक विशिष्ट उपसमूह), और वैकल्पिक रूप से एक समाप्ति तिथि। पूरा कुंजी (एक बेयरर टोकन) एक बार एक डायलॉग में दिखाया जाता है; इसे अभी कॉपी करें, क्योंकि बाद में पहचान के लिए केवल एक छोटा उपसर्ग रखा जाता है।

पहली कुंजी बनाने से API स्वचालित रूप से चालू हो जाता है (बाहरी ऐप्स को स्थिति पढ़ने दें स्विच एक पॉज़ नियंत्रण है: किसी भी कुंजी को रद्द किए बिना सेवा देना बंद करने के लिए इसे बंद कर दें)। किसी भी समय उसी तालिका से एक कुंजी रद्द करें; इसका उपयोग करने वाले क्लाइंट तुरंत पहुंच खो देते हैं।
टोकन SHA-256 हैश के रूप में संग्रहीत किए जाते हैं (कभी भी प्लेनटेक्स्ट में नहीं), पैनल पुनरारंभ से बच जाते हैं, और उन सर्वरों से अधिक समय तक चलते हैं जिनके लिए वे स्कोप किए गए हैं (एक हटा दिया गया सर्वर बस उस टोकन के परिणामों से बाहर हो जाता है)।
प्रमाणीकरण
Section titled “प्रमाणीकरण”बेयरर क्रेडेंशियल के रूप में टोकन भेजें:
Authorization: Bearer msm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxकोई कुकीज़ नहीं हैं और कोई CORS नहीं: यह सर्वर-से-सर्वर और CLI
कॉलर्स के लिए है, न कि किसी अन्य मूल के ब्राउज़र ऐप्स के लिए। यदि पैनल एक रिवर्स प्रॉक्सी के पीछे है, तो सुनिश्चित करें कि प्रॉक्सी Authorization हेडर को फॉरवर्ड करता है।
विफलताएं { "ok": false, "error": "..." } के साथ 401 लौटाती हैं। GET
(या HEAD) के अलावा कुछ भी 405 लौटाता है। अज्ञात पथ 404 लौटाते हैं। जब API अक्षम होता है, तो हर रूट 404 लौटाता है।
दर सीमा
Section titled “दर सीमा”प्रत्येक टोकन का अपना बजट होता है, RATE_LIMIT_PUBLIC_API_PER_MIN (डिफ़ॉल्ट 120
अनुरोध/मिनट; 0 लिमिटर को अक्षम करता है)। सीमा से अधिक होने पर 429 लौटता है। प्रत्येक अनुरोध, इसके टोकन की जांच किए जाने से पहले भी, पांच गुना उस संख्या के प्रति-क्लाइंट-आईपी कैप की ओर गिना जाता है, इसलिए गुम, गलत, निरस्त, या समाप्त टोकन के साथ जांच करके बजट को घुमाकर बायपास नहीं किया जा सकता है।
एंडपॉइंट्स
Section titled “एंडपॉइंट्स”GET /api/v1/servers
Section titled “GET /api/v1/servers”टोकन के लिए स्कोप किए गए प्रत्येक सर्वर।
{ "ok": true, "total": 1, "online": 1, "servers": [ { "id": "srv_ab12cd34", "name": "SMP", "type": "PAPER", "state": "running", "cpuPct": 18.4, "memoryMb": 2048, "memoryLimitMb": 4096, "uptimeSeconds": 11722, "players": { "online": 3, "max": 20 } } ]}GET /api/v1/servers/:id
Section titled “GET /api/v1/servers/:id”एक सर्वर, server कुंजी के तहत वही ऑब्जेक्ट। एक अज्ञात आईडी
और एक सर्वर के लिए 404 लौटाता है जिसके लिए टोकन स्कोप नहीं किया गया है (कोई अस्तित्व ऑरेकल नहीं), और एक गलत आईडी के लिए 400।
प्रतिक्रिया फ़ील्ड
Section titled “प्रतिक्रिया फ़ील्ड”| फ़ील्ड | अर्थ |
|---|---|
total |
इस टोकन के लिए कितने सर्वर दिखाई दे रहे हैं (इसके स्कोप फ़िल्टर के बाद)। |
online |
उनमें से कितने running स्थिति में हैं। |
id |
स्थिर सर्वर आईडी (srv_...)। |
name |
प्रदर्शन नाम। |
type |
itzg सर्वर प्रकार (PAPER, FABRIC, AUTO_CURSEFORGE, …)। |
state |
running, starting, stopped, या crashed: पैनल की आंतरिक स्थिति का एक स्थिर सारांश। |
cpuPct |
हाल का CPU %, या null जब सर्वर नहीं चल रहा हो। |
memoryMb |
MB में निवासी मेमोरी, या null। |
memoryLimitMb |
MB में कॉन्फ़िगर की गई कंटेनर मेमोरी सीमा, या null। |
uptimeSeconds |
कंटेनर शुरू होने के बाद से सेकंड, या null। |
players |
{ online, max }, या null जब तक सर्वर खिलाड़ी सूची की रिपोर्ट नहीं करता। |
उदाहरण
Section titled “उदाहरण”curl -s https://panel.example.com/api/v1/servers \ -H "Authorization: Bearer $MSM_TOKEN" | jq