कस्टमर API · V1 बीटा
VPS और डेडिकेटेड सर्वर के लिए
REST API
कोड से अपने सर्वर प्रबंधित करें: घंटा-आधारित VPS ऑर्डर करें और नष्ट करें, पावर एक्शन और रीइंस्टॉल चलाएँ, अपनी इमेज कैप्चर और डिप्लॉय करें, और क्रेडिट से इनवॉइस का भुगतान करें।
X-ZoneServers कस्टमर API (v1, पब्लिक बीटा) HTTPS पर 92 ऑपरेशन देता है — OpenAPI 3.0 स्पेसिफ़िकेशन, स्कोप वाली API कुंजियों और प्रति कुंजी प्रति घंटा 1,000 अनुरोधों की डिफ़ॉल्ट सीमा के साथ। यह हर खाते के साथ बिना किसी अतिरिक्त लागत के शामिल है।
92 API ऑपरेशन1,000 अनुरोध प्रति घंटा प्रति कुंजी
आपकी पहली API कॉल
क्लाइंट क्षेत्र में Profile → API Keys के अंतर्गत एक कुंजी बनाएँ, फिर API से पूछें कि आप कौन हैं।
curl https://my.x-zoneservers.com/api/v1/ \
-H "Authorization: Bearer $XZ_API_KEY"
{ "success": true,
"data": {
"version": "1",
"key": { "scopes": ["read", "services"] },
"rate_limit": { "limit": 1000, "remaining": 999 }
} }01विशेषताएँ
आप क्या-क्या ऑटोमेट कर सकते हैं
API ऑर्डर से लेकर इनवॉइस तक सर्वर के पूरे लाइफ़साइकल को कवर करता है, क्लाइंट क्षेत्र जैसी ही अनुमतियों के साथ।
डिप्लॉय और नष्ट करें
घंटा-आधारित या मासिक बिलिंग पर VPS ऑर्डर करें, पहले बूट के लिए cloud-init user-data और SSH कुंजियाँ दें, और काम पूरा होते ही उसे डिलीट कर दें। सर्वर हटते ही घंटा-आधारित बिलिंग रुक जाती है।
पावर, रीइंस्टॉल और आँकड़े
अपने VPS को स्टार्ट, स्टॉप, रीबूट और रीइंस्टॉल करें, रूट पासवर्ड रीसेट करें, और अपनी मॉनिटरिंग स्क्रिप्ट से उपयोग और ट्रैफ़िक के आँकड़े पढ़ें।
कस्टम इमेज
किसी VPS को इमेज के रूप में कैप्चर करें (प्रति खाता 3 तक), या अपनी qcow2 या raw इमेज रजिस्टर करें (SHA-256 से सत्यापित) और उससे नए सर्वर डिप्लॉय करें।
बिलिंग और उपयोग
अपना क्रेडिट बैलेंस और इस महीने के प्रति-घंटा शुल्क देखें, इनवॉइस और प्रोफ़ॉर्मा की सूची लें, और उन्हें क्रेडिट से चुकाएँ — लागत डैशबोर्ड और बजट अलर्ट के लिए उपयोगी।
ऐड-ऑन और अपग्रेड
किसी मौजूदा सेवा के लिए ऐड-ऑन खरीदें, जैसे अतिरिक्त IP एड्रेस, या क्लाइंट क्षेत्र खोले बिना उसे बड़े प्लान पर ले जाएँ।
प्रोजेक्ट और स्कोप वाली कुंजियाँ
सर्वरों को प्रोजेक्ट में समूहित करें और किसी एक प्रोजेक्ट से बंधी कुंजियाँ जारी करें, ताकि स्टेजिंग की कुंजी प्रोडक्शन को न कभी देख सके, न छू सके।
02यह कैसे काम करता है
उदाहरण: एक CI जॉब के लिए घंटा-आधारित VPS
एक साफ़ बिल्ड मशीन बनाएँ, पाइपलाइन चलाएँ, उसे डिलीट करें — और सिर्फ़ उन्हीं घंटों का भुगतान करें जितने समय वह मौजूद रही।
घंटा-आधारित सेवाओं का शुल्क इनवॉइस के बजाय आपके खाते के क्रेडिट से कटता है, इसलिए खाते में बैलेंस बनाए रखें। हर ऑर्डर के साथ Idempotency-Key हेडर भेजें: तब टाइम-आउट हुए अनुरोध को दूसरा सर्वर बनाए बिना दोबारा भेजा जा सकता है।
1. प्लान चुनें: प्रोडक्ट्स को उनकी प्रति घंटा और मासिक कीमतों के साथ सूचीबद्ध करें।
curl https://my.x-zoneservers.com/api/v1/products \
-H "Authorization: Bearer $XZ_API_KEY"2. फ़र्स्ट-बूट स्क्रिप्ट और अपनी SSH कुंजी के साथ इसे घंटा-आधारित बिलिंग पर ऑर्डर करें।
curl -X POST https://my.x-zoneservers.com/api/v1/orders \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Idempotency-Key: ci-run-4812" \
-H "Content-Type: application/json" \
-d '{"productId": "<plan-id>", "billingCycle": "hourly",
"hostname": "ci-4812.example.com", "location": "<location>",
"configOptions": {"os_image_id": "<image-id>",
"ssh_keys": ["ssh-ed25519 AAAA... ci@runner"],
"user_data": "#!/bin/sh\n/opt/ci/run-pipeline.sh"}}'3. जॉब पूरा होने पर सर्वर डिलीट करें। बिलिंग तुरंत रुक जाती है।
curl -X DELETE https://my.x-zoneservers.com/api/v1/vps/<vps-id> \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"immediate": true}'03API
स्क्रिप्ट और AI एजेंट के लिए बना
जब बटन कोई इंसान नहीं, बल्कि एक प्रोग्राम दबा रहा हो, तो एंडपॉइंट की गिनती से ज़्यादा मायने रखता है कि व्यवहार पूर्वानुमेय हो।
स्कोप वाली कुंजियाँ
हर कुंजी में केवल वही स्कोप होते हैं जो आप देते हैं — read, services, orders, billing, destructive — साथ में वैकल्पिक IP अलाउलिस्ट और समाप्ति तिथि।
प्रकाशित रेट लिमिट
डिफ़ॉल्ट रूप से प्रति कुंजी प्रति घंटा 1,000 अनुरोध, जिनकी जानकारी X-RateLimit हेडर में मिलती है, और पावर व रीइंस्टॉल एक्शन पर हर सर्वर के लिए छोटा कूल-डाउन।
सुरक्षित रीट्राई
ऑर्डर Idempotency-Key स्वीकार करते हैं, और हर अस्वीकृति एक मशीन-पठनीय एरर कोड लौटाती है, ताकि ऑटोमेशन दोबारा आज़माई जा सकने वाली विफलता और असली विफलता में फ़र्क़ कर सके।
मशीन-पठनीय दस्तावेज़
क्लाइंट जनरेटर के लिए OpenAPI 3.0 स्पेसिफ़िकेशन, और एक सादी Markdown गाइड जिसे कोडिंग असिस्टेंट और AI एजेंट सीधे पढ़ सकते हैं।
04संबंधित
अपने ख़ुद के ग्राहकों को सर्वर बेच रहे हैं?
यह कस्टमर API आपके अपने खाते को ऑटोमेट करता है। अपने ब्रांड के तहत रीसेल करने के लिए रीसेलर प्रोग्राम से जुड़ें और इसकी जगह रीसेलर API का इस्तेमाल करें: वॉल्यूम टियर के साथ होलसेल कीमतें, HMAC-साइन किए गए अनुरोध, वेबहुक, ग्राहक से बंधी कुंजियाँ और ऐसे कंसोल लिंक जिन्हें आपके ग्राहक हमारे पास खाता बनाए बिना खोल सकते हैं।
05प्रश्न
API से जुड़े सवाल
X-ZoneServers को ऑटोमेट करने से जुड़े आम सवाल।
क्या X-ZoneServers का कोई API है?
हाँ। कस्टमर API (v1) https://my.x-zoneservers.com/api/v1 पर HTTPS के ज़रिए उपलब्ध एक REST API है, जिसमें VPS, डेडिकेटेड सर्वर, ऑर्डर, ऐड-ऑन, अपग्रेड, इनवॉइस, SSH कुंजियों और कस्टम इमेज को कवर करने वाले 92 ऑपरेशन हैं। यह पब्लिक बीटा में है: इतना स्थिर है कि इस पर निर्माण किया जा सके, लेकिन एंडपॉइंट और रिस्पॉन्स की संरचना अभी भी बदल सकती है।
क्या API एक्सेस मुफ़्त है?
हाँ। API एक्सेस हर खाते के साथ बिना किसी अतिरिक्त लागत के शामिल है; आप केवल उन्हीं सर्वरों और ऐड-ऑन का भुगतान करते हैं जिन्हें आप ऑर्डर करते हैं, वेबसाइट और क्लाइंट क्षेत्र वाली कीमतों पर ही।
क्या मैं API के ज़रिए घंटा-आधारित VPS बना और डिलीट कर सकता हूँ?
हाँ। बिलिंग साइकल को घंटा-आधारित पर सेट करके ऑर्डर दें, चाहें तो cloud-init user-data और SSH कुंजियों के साथ, और ज़रूरत न रहने पर VPS डिलीट कर दें। घंटा-आधारित सेवाओं का शुल्क खाते के क्रेडिट से कटता है और डिलीट होते ही बिलिंग रुक जाती है।
क्या API डेडिकेटेड सर्वर के साथ काम करता है?
आंशिक रूप से। डेडिकेटेड सर्वरों के लिए API ऑर्डर करना, ऐड-ऑन, इनवॉइस और सेवा विवरण कवर करता है। डेडिकेटेड सर्वरों के लिए पावर कंट्रोल, OS रीइंस्टॉल और पासवर्ड रीसेट न API के ज़रिए उपलब्ध हैं, न क्लाइंट क्षेत्र में।
मैं प्रमाणीकरण कैसे करूँ?
क्लाइंट क्षेत्र में Profile → API Keys के अंतर्गत एक API कुंजी बनाएँ और उसे Bearer टोकन के रूप में भेजें। बनाते समय उसके स्कोप चुनें, और चाहें तो उसे विशिष्ट IP एड्रेस तक सीमित करें या उसकी समाप्ति तिथि तय करें। कुंजियाँ केवल एक बार दिखाई जाती हैं और क्लाइंट क्षेत्र से कभी भी रद्द की जा सकती हैं।
क्या कोई OpenAPI या Swagger स्पेसिफ़िकेशन है?
हाँ। पूरा OpenAPI 3.0 स्पेसिफ़िकेशन https://my.x-zoneservers.com/api/v1/openapi.json पर प्रकाशित है, साथ में रेंडर किया गया दस्तावेज़ीकरण और एक Markdown उपयोग गाइड भी।
शुरू करें
अपनी पहली API कुंजी बनाएँ
क्लाइंट क्षेत्र में साइन इन करें, Profile → API Keys खोलें और एक मिनट से भी कम समय में अपनी पहली कॉल करें। API से जुड़े सवाल सीधे उन लोगों तक पहुँचते हैं जो प्लेटफ़ॉर्म बनाते हैं।