VPS.org API दस्तऐवजीकरण

सुरुवात करणे

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

प्रमाणीकरण

सर्व API विनंत्यांसाठी Bearer टोकन वापरून प्रमाणीकरण आवश्यक आहे. तुम्ही तुमच्या खाते सेटिंग्जमधून तुमचे 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);

प्रत्येक टोकन स्वतःची परवानगी, जसे की सर्वर: यादी किंवा dns: *, सोबत घेऊन जातो. टोकनला परवानगीची आवश्यकता नसलेल्या विनंतीला 403 आणि missing_permission क्षेत्र नावाने नकार दिला जातो. परवानगी संदर्भ

दर मर्यादा

अधिप्रमाणीत विनंती प्रति तास प्रति कळप 1000 पर्यंत मर्यादित आहे. अनधिकृत विनंती प्रति तास प्रति IP पत्ता 100 पर्यंत मर्यादित आहे. मर्यादा पेक्षा जास्त विनंती 429 प्राप्त करते Retry-After हेडर सह प्रतीक्षा यादीतील सेकंद. यशस्वी प्रतिसादावर दर मर्यादा हेडर पाठविले जात नाही.

पान क्रमांक

यादीतील शेवटचे बिंदू एक घटक परत करतो ज्यात संख्या, पुढील, पूर्वीचे व परिणाम, प्रति पान २५ घटक असतात. पानांमधून हलविण्याकरीता पान पार करा, किंवा नूल होईपर्यंत पुढील URL अनुसरून जा. सर्वर यादी page_size स्वीकारते, 100 पर्यंत.

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

त्रुटी हाताळणी

यश किंवा अपयश दर्शविण्यासाठी API मानक HTTP स्थिती कोड वापरते:

त्रुटी बाडी JSON आहे. बहुतेक वेळा तपशील क्षेत्र किंवा त्रुटी क्षेत्र असते, कधीकधी संदेशसह; वैधता त्रुटी क्षेत्र नावाने समस्यांची यादी दर्शविते.

API श्रेणी

श्रेणीनुसार आमचे API दस्तऐवजीकरण ब्राउझ करा:

अधिक अंतबिंदू

API कडे अनुप्रयोग वितरणासाठी अंतबिंदू आहेत (/api/v1/deploy-configs/ आणि /api/v1/deployments/). ते या पानावर अजून वर्णन केले गेले नाही; इंटरएक्टिव संदर्भ प्रत्येक अंतबिंदूची यादी दर्शवितो, लाइव API पासून निर्माण केले गेले.

मदत हवी आहे?

जर तुम्हाला प्रश्न असतील किंवा API बद्दल मदत हवी असेल, तर कृपया संपर्क साधण्यास संकोच करू नका:

• सपोर्ट तिकिटे: सपोर्ट तिकीट उघडा
• ईमेल: hello@vps.org
• दस्तऐवजीकरण: संपूर्ण दस्तऐवजीकरण