VPS.org एपीआई प्रलेख

शुरू करना

VPS.org API आपको सर्वर, डोमेन, DNS रिकॉर्ड, बैकअप और स्नैपशॉट सहित अपने VPS होस्टिंग इंफ्रास्ट्रक्चर के सभी पहलुओं को प्रोग्रामेटिक रूप से प्रबंधित करने की अनुमति देता है।

प्रमाणीकरण

सभी API अनुरोधों के लिए बियरर टोकन का उपयोग करके प्रमाणीकरण आवश्यक है। आप अपने खाते की सेटिंग से अपना API टोकन जनरेट कर सकते हैं। admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

हर टोकन अपनी अनुमतियाँ रखता है, जैसे कि सर्वर: सूची या dss:*. एक निवेदन जो इस चिह्न को अनुमति की आवश्यकता नहीं है 403 के साथ और एक वांछित क्षेत्र नामकरण की अनुमति के साथ मना किया गया है. अनुमतियाँ संदर्भ

दर सीमा

Authenticated requests प्रति account प्रति घंटे 1,000 तक सीमित हैं। Unauthenticated requests प्रति IP address प्रति घंटे 100 तक सीमित हैं। सीमा से अधिक request पर 429 मिलता है, साथ में एक Retry-After header जो प्रतीक्षा करने के लिए seconds की संख्या बताता है। सफल responses पर कोई rate limit headers नहीं भेजे जाते।

पैसिवेशन

सूची अंतिम भाग में गिनती के साथ, अगला, पिछला, और परिणाम प्रति पृष्ठ के २५ वस्तुएँ बताता है. पृष्ठ के बीच ले जाने के लिए या अगला यूआरएल के साथ अनुसरण करें जब तक कि यह नल न हो. सर्वर सूची पृष्ठ 100 को स्वीकार करता है.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

त्रुटि प्रबंधन

यह एपीआई सफलता या विफलता को दर्शाने के लिए मानक HTTP स्टेटस कोड का उपयोग करता है:

त्रुटि बन्दों में JSON है. अधिकांश के पास एक विवरण क्षेत्र या त्रुटि क्षेत्र है, कभी किसी संदेश के साथ; क्षेत्र नाम द्वारा समस्याओं को सूची दी गई.

एपीआई श्रेणियाँ

श्रेणी के अनुसार हमारे एपीआई दस्तावेज़ को ब्राउज़ करें:

और भी अंत बिन्दु

एपीआई ने एयरमेंट (/ह-विड1/ह-/क1/क्शन) के लिए अंत-र्स भी हैं। इन पृष्ठों पर वर्णन नहीं किया गया है। इन पृष्ठों पर अभी तक के बारे में नहीं बताया गया है; हर अंत-क संदर्भ सूची इन दोनों के अंत-क्शन्स में, Eninninin, EnaEna.

मदद की ज़रूरत है?

यदि आपके पास एपीआई से संबंधित कोई प्रश्न हैं या आपको सहायता की आवश्यकता है, तो कृपया बेझिझक हमसे संपर्क करें:

• सहायता टिकट: सहायता टिकट खोलें
• ईमेल: hello@vps.org
• दस्तावेज़ीकरण: पूर्ण दस्तावेज़ीकरण