VPS.org API ਡੌਕੂਮੈਂਟੇਸ਼ਨ

ਸ਼ੁਰੂ ਕਰਨਾ

VPS.org API ਤੁਹਾਨੂੰ ਤੁਹਾਡੇ VPS ਹੋਸਟਿੰਗ ਬੁਨਿਆਦੀ ਢਾਂਚੇ ਦੇ ਸਾਰੇ ਪਹਿਲੂਆਂ ਨੂੰ ਪ੍ਰੋਗਰਾਮੇਟਿਕ ਤੌਰ 'ਤੇ ਪ੍ਰਬੰਧਿਤ ਕਰਨ ਦੀ ਆਗਿਆ ਦਿੰਦਾ ਹੈ, ਜਿਸ ਵਿੱਚ ਸਰਵਰ, ਡੋਮੇਨ, DNS ਰਿਕਾਰਡ, ਬੈਕਅੱਪ ਅਤੇ ਸਨੈਪਸ਼ਾਟ ਸ਼ਾਮਲ ਹਨ।

ਪ੍ਰਮਾਣਿਕਤਾ

ਸਾਰੀਆਂ 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);

ਹਰੇਕ ਟੋਕਨ ਆਪਣੇ ਅਧਿਕਾਰ ਰੱਖਦਾ ਹੈ, ਜਿਵੇਂ ਕਿ servers:list ਜਾਂ dns:*। ਇੱਕ ਬੇਨਤੀ, ਜਿਸ ਨੂੰ ਅਧਿਕਾਰ ਦੀ ਲੋੜ ਹੈ, ਜੋ ਕਿ ਟੋਕਨ ਕੋਲ ਨਹੀਂ ਹੈ, ਨੂੰ 403 ਅਤੇ required_permission ਖੇਤਰ ਨਾਲ ਰੱਦ ਕੀਤਾ ਜਾਂਦਾ ਹੈ, ਜਿਸ ਵਿੱਚ ਗੁੰਮ ਅਧਿਕਾਰ ਦਾ ਨਾਂ ਹੈ। ਅਧਿਕਾਰ ਹਵਾਲਾ

ਦਰ ਸੀਮਾ

ਪਰਮਾਣਿਤ ਮੰਗਾਂ ਪ੍ਰਤੀ ਘੰਟਾ ਪ੍ਰਤੀ ਅਕਾਊਂਟ 1000 ਤੱਕ ਸੀਮਿਤ ਹਨ । ਨਾ- ਪਰਮਾਣਿਤ ਮੰਗਾਂ ਪ੍ਰਤੀ IP ਐਡਰੈੱਸ ਪ੍ਰਤੀ ਘੰਟਾ 100 ਤੱਕ ਸੀਮਿਤ ਹਨ । ਇੱਕ ਮੰਗ ਜੋ ਕਿ ਸੀਮਾ ਤੋਂ ਵੱਧ ਹੈ, ਨੂੰ 429 ਮਿਲਦਾ ਹੈ, ਜਿਸ ਵਿੱਚ Retry- After ਹੈੱਡਰ ਹੈ, ਜੋ ਕਿ ਸੈਕਿੰਡ ਦੀ ਗਿਣਤੀ ਦਿੰਦਾ ਹੈ । ਸਫਲ ਜਵਾਬ ਲਈ ਕੋਈ ਰੇਟ ਲਿਮਟ ਹੈੱਡਰ ਨਹੀਂ ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ ।

ਪੇਜ਼ਿੰਗ

ਲਿਸਟ ਅੰਤ ਬਿੰਦੂ ਇੱਕ ਆਬਜੈਕਟ ਨਾਲ ਗਿਣਤੀ, ਅੱਗੇ, ਪਿਛਲੇ ਅਤੇ ਨਤੀਜੇ, ਪ੍ਰਤੀ ਸਫ਼ਾ 25 ਆਈਟਮਾਂ ਨਾਲ ਵਾਪਸ ਆਉਂਦਾ ਹੈ । ਸਫ਼ਿਆਂ ਵਿੱਚ ਭੇਜਣ ਲਈ ਸਫ਼ਾ ਪਾਸ ਕਰੋ, ਜਾਂ ਅਗਲੇ URL ਨੂੰ ਵੇਖੋ, ਜਦੋਂ ਤੱਕ ਇਹ ਨੂਲ ਨਾ ਹੋ ਜਾਵੇ । ਸਰਵਰ ਲਿਸਟ ਪੇਜ਼_ ਸਾਈਜ਼ ਵੀ ਸਵੀਕਾਰ ਕਰਦੀ ਹੈ, 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
• ਡੌਕੂਮੈਂਟੇਸ਼ਨ: ਪੂਰਾ ਦਸਤਾਵੇਜ਼ੀਕਰਨ