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);

દરેક ટોકન તેની પોતાની પરવાનગીઓ લઇને આવે છે, જેમ કે સર્વર:યાદી અથવા dns:*. ટોકન પાસે પરવાનગીની જરૂરિયાત હોય તેવી વિનંતી 403 અને required_permission ક્ષેત્ર સાથે નકારવામાં આવે છે જે ગુમ થયેલ પરવાનગીનું નામ આપે છે. પરવાનગીઓ સંદર્ભ

દર મર્યાદા

સત્તાધિકરણ થયેલ વિનંતી દર કલાકે ૧,૦૦૦ પ્રતિ ખાતું સુધી મર્યાદિત છે. સત્તાધિકરણ થયેલ વિનંતી દર IP સરનામાં પ્રતિ કલાકે ૧૦૦ સુધી મર્યાદિત છે. મર્યાદા કરતાં વધુ વિનંતી Retry-After હેડર સાથે ૪૨૯ મેળવે છે જે રાહ જોવા માટે સેકન્ડોની સંખ્યા આપે છે. સફળ જવાબો પર કોઈ દર મર્યાદા હેડરો મોકલવામાં આવતા નથી.

પાનાંઓ

યાદી અંતબિંદુઓ ગણતરી, આગળ, પહેલા અને પરિણામો સાથે વસ્તુ પાછી આપે છે, પાના દીઠ ૨૫ વસ્તુઓ. પાનાંઓ વચ્ચે ખસેડવા માટે પાનું પસાર કરો, અથવા પછીની URL ને અનુસરો જ્યાં સુધી તે ન્યુલ ન હોય. સર્વરોની યાદી page_size ને પણ સ્વીકારે છે, ૧૦૦ સુધી.

{
  "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
• દસ્તાવેજ: સંપૂર્ણ દસ્તાવેજીકરણ