VPS API क्विक स्टार्ट, API की बनाना और पहला सर्वर बनाना

स्टेप 2. ऑथेंटिकेशन और पहली रिक्वेस्ट

सभी रिक्वेस्ट बेस एड्रेस https://helpervps.com/api/v1 के नीचे भेजें, और Authorization: Bearer YOUR_KEY हेडर लगाएँ। पहली रिक्वेस्ट में अपने सर्वर की सूची मँगाकर देखें। सर्वर न हो, तो खाली सूची [] लौटती है।

curl -s $HVP/servers -H "Authorization: Bearer $HVP_KEY"

हर अकाउंट 1 मिनट में 300 रिक्वेस्ट तक भेज सकता है, और सर्वर बनाना 10 मिनट में 10 बार तक है। स्थिति जाँचने वाली बार-बार की रिक्वेस्ट में कुछ सेकंड का अंतर रखें, काफ़ी है। सभी रिस्पॉन्स JSON में हैं, और एरर होने पर स्टेटस कोड के साथ {"error": "code"} के रूप में लौटते हैं।

स्टेप 3. प्लान, क्षेत्र और इमेज चुनें

सर्वर बनाते समय डाली जाने वाली सभी वैल्यू कैटलॉग से आती हैं। GET /catalog बिक्री में मौजूद प्लान (plans), क्षेत्र (locations), इमेज (images) और अतिरिक्त विकल्प (addons) एक साथ लौटाता है। jq हो, तो ज़रूरी हिस्सा चुनकर देखना आसान है।

curl -s $HVP/catalog -H "Authorization: Bearer $HVP_KEY" | jq '.plans[] | {code, type, vcpu, ram_mb, disk_gb, monthly}'
curl -s $HVP/catalog -H "Authorization: Bearer $HVP_KEY" | jq '.locations, .images'

• प्लान कोड: s1, s2 की तरह प्रकार और साइज़ बताता है। type में basic (SSD स्टैंडर्ड), fast (NVMe हाई परफ़ॉर्मेंस), cpu (डेडिकेटेड CPU), mem (हाई मेमोरी) हैं। monthly अमेरिकी डॉलर में मासिक शुल्क है।
• क्षेत्र कोड: frankfurt, singapore, seoul जैसे शहर के नाम।
• इमेज कोड: ubuntu-24-04, debian-13, almalinux-10 जैसे ऑपरेटिंग सिस्टम और app-docker, app-wordpress जैसे ऐप।
• अतिरिक्त विकल्प: ऑटो बैकअप का प्रतिशत, अतिरिक्त डिस्क साइज़ और प्रति GB शुल्क, और DDoS सुरक्षा शुल्क। जो विकल्प बिक्री में नहीं है, वह null आता है।

Ubuntu पर न हो तो apt install -y jq, और Mac पर brew install jq से इंस्टॉल करें। यह स्क्रीन पर चुनी जाने वाली सूची जैसी ही है, इसलिए प्लान के अंतर कीमत पेज पर साथ देखें तो आसानी रहती है।

स्टेप 4. सर्वर बनाएँ

प्लान, लोकेशन, इमेज और नाम JSON में POST /servers पर भेजें। चुने गए प्लान का पहला टर्म भुगतान करें और सर्वर बनना शुरू हो जाएगा।

curl -s -X POST $HVP/servers \
  -H "Authorization: Bearer $HVP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1"}'

सफल होने पर स्टेटस कोड 201 के साथ सर्वर की जानकारी लौटती है। id, S-XXXX-XXXX-XXXX जैसा सर्वर कोड है, जिसे आगे की सभी रिक्वेस्ट में इस्तेमाल करें। root_password इसी रिस्पॉन्स में एक बार आता है, इसलिए तुरंत सेव करें। सर्वर पेज पर भी 7 दिन तक देख सकते हैं।

• label: सर्वर का नाम। अंग्रेज़ी अक्षर, अंक, डॉट और हाइफ़न से 40 अक्षरों तक लिखें, दूसरे अक्षर हाइफ़न में बदल जाते हैं।
• backups: true हो तो ऑटो बैकअप चालू होता है।
• extra_disk_gb: अतिरिक्त NVMe ब्लॉक डिस्क का साइज़। कैटलॉग की sizes_gb वैल्यू (50, 100, 250, 500, 1000) में से एक डालें।
• ddos_protection: true हो तो DDoS सुरक्षा चालू होती है।

विकल्प शुल्क सर्वर के मासिक शुल्क में जुड़कर रिस्पॉन्स के monthly में दिखता है, और हर भुगतान तारीख पर उतनी ही रकम से अपने आप रिन्यू होता है। हर अकाउंट में 10 सर्वर तक बना सकते हैं।

स्टेप 5. स्थिति जाँचें और कनेक्ट करें

नया सर्वर creating स्थिति से शुरू होता है, तैयार होने पर running हो जाता है और ipv4 एड्रेस भर जाता है। नीचे का लूप हर 10 सेकंड में स्थिति देखता है और running होने पर IP दिखाता है। सर्वर कोड को अपने सर्वर के कोड से बदलें।

ID=S-XXXX-XXXX-XXXX
until [ "$(curl -s $HVP/servers/$ID -H "Authorization: Bearer $HVP_KEY" | jq -r .state)" = "running" ]; do sleep 10; done
curl -s $HVP/servers/$ID -H "Authorization: Bearer $HVP_KEY" | jq -r .ipv4

स्थिति creating, running, stopped, rebooting, installing, suspended या check में से एक होती है। suspended का मतलब है कि सर्वर बिलिंग तारीख पर रिन्यू न होने के कारण रोक दिया गया है, और check का मतलब है कि हम सर्वर सेटअप के नतीजे की जाँच कर रहे हैं। IP दिखने पर ssh root@IP से कनेक्ट करें। कनेक्ट करने का तरीका पहले लॉग इन की गाइड में है।

स्टेप 6. पावर, रिन्यूअल, डिलीट

curl -s -X POST $HVP/servers/$ID/stop   -H "Authorization: Bearer $HVP_KEY"
curl -s -X POST $HVP/servers/$ID/start  -H "Authorization: Bearer $HVP_KEY"
curl -s -X POST $HVP/servers/$ID/reboot -H "Authorization: Bearer $HVP_KEY"
curl -s -X POST $HVP/servers/$ID/renew  -H "Authorization: Bearer $HVP_KEY"
curl -s -X DELETE $HVP/servers/$ID     -H "Authorization: Bearer $HVP_KEY"

• start: रुके हुए (stopped) सर्वर को चालू करता है।
• stop, reboot: चालू (running) सर्वर को बंद या रीस्टार्ट करता है।
• renew: अभी 1, 3, 6 या 12 महीने का भुगतान करता है। एक suspended सर्वर भी इसी रिक्वेस्ट से वापस चालू हो जाता है।
• DELETE: सर्वर और डिस्क डिलीट करता है और {"state": "deleted"} लौटाता है। जिस महीने का भुगतान हो चुका है, उसकी बाकी अवधि रिफ़ंड नहीं होती।

मौजूदा स्थिति में न हो सकने वाला काम भेजें, तो 409 wrong_state लौटता है। जैसे पहले से चालू सर्वर पर start भेजें। री-इंस्टॉल और नया root पासवर्ड बनाना सर्वर पेज से होता है। क्रम री-इंस्टॉल गाइड में है।

Python से वही क्रम चलाएँ

वही फ़्लो Python स्क्रिप्ट में लिखें, तो ऐसा होता है। requests लाइब्रेरी (pip install requests) इस्तेमाल होती है।

import os, time, requests

API = "https://helpervps.com/api/v1"
H = {"Authorization": f"Bearer {os.environ['HVP_KEY']}"}

r = requests.post(f"{API}/servers", headers=H, json={
    "plan": "s2", "location": "frankfurt",
    "image": "ubuntu-24-04", "label": "web-1",
})
r.raise_for_status()
server = r.json()
print("id:", server["id"], "root password:", server["root_password"])

while True:
    s = requests.get(f"{API}/servers/{server['id']}", headers=H).json()
    if s["state"] == "running" and s["ipv4"]:
        print("ready:", s["ipv4"])
        break
    time.sleep(10)

अक्सर दिखने वाले एरर कोड

• 401 unauthorized: की नहीं है या गलत है। जाँचें कि हेडर Authorization: Bearer hvp_... जैसा है।
• 403 not_allowed: पहला भुगतान कन्फ़र्म होने पर खुलता है।
• 400 bad_request: फ़ील्ड का नाम या वैल्यू गलत है। कोड कैटलॉग की वैल्यू जैसा ही लिखें।
• 402 not_enough_balance: भुगतान राशि $25 से कम है। कम से कम $25 के साथ फिर से भेजें।
• 409 limit: अकाउंट में बनाए जा सकने वाले सर्वर की संख्या पूरी हो गई है।
• 409 not_created: सर्वर नहीं बन पाया, और फ़ीस आपके अकाउंट क्रेडिट में जाती है।
• 202 checking: हम सर्वर सेटअप के नतीजे की जाँच कर रहे हैं। वही रिक्वेस्ट फिर से न भेजें; अपनी सर्वर सूची देखें। सर्वर पूरा बन जाएगा या फ़ीस आपके अकाउंट क्रेडिट में लौट जाएगी।
• 404 not_found: आपके अकाउंट में न होने वाला सर्वर कोड या एड्रेस।
• 409 wrong_state: मौजूदा स्थिति में यह काम नहीं हो सकता।
• 429 rate_limited: 1 मिनट की रिक्वेस्ट सीमा पूरी हो गई। थोड़ा रुककर भेजें।

सभी एंडपॉइंट, रिस्पॉन्स फ़ील्ड और उदाहरण API डॉक्यूमेंट में इकट्ठा हैं। API से क्या-क्या कर सकते हैं और इसके इस्तेमाल VPS API पेज पर देखें।