VPS.org API

डेटी एपीआई प्रलेख

स्थान एपीआई

स्थान स्थान जहाँ आप VPPERED पर तैनात कर सकते हैं की सूची दें. स्थान आईडी को स्थान_id के रूप में पास करें जब आप सर्वर बना रहे होते हैं.

अंतिमबिंदुओं 2 endpoints
आधार पथ /api/v1/locations
पाना /api/v1/locations/

सभी स्थानों की सूची बनाएं

सभी उपलब्ध डेटा केंद्र की सूची प्राप्त करें जहाँ आप VPS सर्वर पर तैनात कर सकते हैं.

उदाहरण अनुरोध

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/locations/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/locations/"
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/locations/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const locations = await response.json();
console.log(locations);
$ch = curl_init('https://admin.vps.org/api/v1/locations/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$locations = json_decode($response, true);
curl_close($ch);

उदाहरण प्रतिक्रिया

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "New Jersey",
      "country_name": "United States",
      "country_code": "US",
      "is_active": true
    }
  ]
}

प्रतिक्रिया क्षेत्र

क्षेत्र प्रकार वर्णन
id integer स्थान पहचानकर्ता. इसे सर्वर बनाने के दौरान स्थान_id के रूप में प्रयोग करें.
name string मानव द्वारा पढ़ा जा सकने योग्य स्थान नाम
country_name string देश स्थान में है
country_code string ISO 3166-1 alpha-2 देश कोड, uppercase में
is_active boolean क्या स्थान नए सर्वर को स्वीकार कर रहा है

प्रतिक्रिया स्थिति कोड

200 स्थानों की सूची सफलतापूर्वक प्राप्त कर ली गई है।
403 गुम है या अवैध एपीआई टोकन, या टोकन जरूरी अनुमति नहीं
पाना /api/v1/locations/{id}/

स्थान प्राप्त करें

एक एकल स्थान इसके आईडी से प्राप्त करें. प्रतिक्रिया ऊपर दिए क्षेत्रों के साथ एक स्थान वस्तु है.

curl -X GET "https://admin.vps.org/api/v1/locations/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": 1,
  "name": "New Jersey",
  "country_name": "United States",
  "country_code": "US",
  "is_active": true
}

आपका सर्वर कहाँ चलाएँ

हर VPS.org server अभी हमारे New Jersey, USA स्थान में चलता है, जो IPv4 और IPv6 पर दुनिया भर के customers की सेवा करता है। किसी id को hardcode करने के बजाय हमेशा locations endpoint को पढ़ें, ताकि नई locations जोड़े जाने पर आपका integration उन्हें अपने आप ले ले।