VPS.org API

REST API ලේඛන

VPS.org API ලේඛන

VPS සේවාදායක, වසම්, DNS, උපස්ථ සහ තවත් දේ කළමනාකරණය කිරීම සඳහා REST API ලේඛන සම්පූර්ණ කරන්න.

මූලික URL එක https://admin.vps.org/api/v1
සත්‍යාපනය දරන්නාගේ ටෝකනය
සංස්කරණය v1
සංයුතිය JSON

ඇරඹේ

VPS.org API මඟින් ඔබට සේවාදායකයන්, වසම්, DNS වාර්තා, උපස්ථ සහ ස්නැප්ෂොට් ඇතුළුව ඔබේ VPS සත්කාරක යටිතල ව්‍යුහයේ සියලුම අංග ක්‍රමලේඛනගතව කළමනාකරණය කිරීමට ඉඩ සලසයි.

සත්‍යාපනය

සියලුම API ඉල්ලීම් සඳහා Bearer ටෝකනයක් භාවිතයෙන් සත්‍යාපනය අවශ්‍ය වේ. ඔබට ඔබගේ ගිණුම් සැකසුම් වලින් ඔබගේ API ටෝකනය ජනනය කළ හැක admin.vps.org/account/developers/.

cURL
Python
JavaScript
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 ක්ෂේත්රයේ සමග ප්රතික්ෂේප කරනු ලැබේ. අවසර උපුටාදැක්වීම්

අනුපාත සීමා කිරීම

ගිණුමකට පැයකට 1,000 ක් දක්වා සත්යතාවය සහතික කර ඇති ඉල්ලීම් සීමා කර ඇත. සත්යතාවය සහතික නොකළ ඉල්ලීම් IP ලිපිනයකට පැයකට 100 ක් දක්වා සීමා කර ඇත. සීමාව ඉක්මවා ඉල්ලීමක් ලැබේ 429 බලා සිටීමට තත්පර ගණනක් ලබා දෙන නැවත උත්සාහ කිරීමෙන් පසු ශීර්ෂය සමඟ. සාර්ථක ප්රතිචාර මත කිසිදු අනුපාත සීමා ශීර්ෂ යවනු නොලැබේ.

පිටු සැකසීම

ලැයිස්තු අවසන් ස්ථානය ගණන්, ඊළඟ, පෙර හා ප්රතිඵල, පිටුවකට අයිතම 25 සමග වස්තුව ආපසු. පිටු අතර ගමන් කිරීමට පිටුව, හෝ එය ශුන්‍ය වන තෙක් ඊළඟ URL අනුගමනය. සේවාදායක ලැයිස්තුව ද page_size පිළිගනී, 100 දක්වා.

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

දෝෂ හැසිරවීම

සාර්ථකත්වය හෝ අසාර්ථකත්වය දැක්වීමට API සම්මත HTTP තත්ව කේත භාවිතා කරයි:

තත්ව කේතය විස්තරය
200 සාර්ථකයි - ඉල්ලීම සාර්ථකව සම්පූර්ණ කරන ලදී.
201 නිර්මාණය කරන ලදී - සම්පත සාර්ථකව නිර්මාණය කරන ලදී.
400 වැරදි ඉල්ලීම - අවලංගු පරාමිතීන් හෝ විකෘති ඉල්ලීමක්
202, 204 පිළිගත් හා පෝලිමේ (202), හෝ ප්රතිචාර ශරීරය (204) සමග මකා
402 ගෙවීම් අවශ්ය: ගොනුව මත ගෙවීම් ක්රමයක් නැත, නොගෙවුණු ඉන්වොයිසි, හෝ කාඩ්පත් පෙර-බලපත්ර ප්රතික්ෂේප
403 තහනම්: ටොකන් අතුරුදහන්, වලංගු හෝ කල් ඉකුත් වී, හෝ අවශ්ය අවසර නොමැති. අසාර්ථක සහතික කිරීම ද 403, 401 නොවේ, ආපසු.
404 හමු නොවීය - සම්පත නොපවතී.
409 ගැටුම්: උදාහරණයක් ලෙස දැනටමත් ක්රියාත්මක වන resize, ප්රමාණවත් ධාරිතාවයක් නැත, හෝ දැනටමත් ක්රියාත්මක වන යෙදවීමක්
429 ඉල්ලීම් වැඩියි - අනුපාත සීමාව ඉක්මවා ඇත.
500 අභ්‍යන්තර සේවාදායක දෝෂයක් - අපේ පැත්තෙන් යමක් වැරදී ඇත.
503 සේවාව නොලැබෙන: තාවකාලික ගැටලුවක්. නැවත උත්සාහ, එය යවන විට නැවත උත්සාහ-පසුව ගෞරව.

දෝෂ ශරීර JSON වේ. බොහෝ විට පණිවිඩයක් සමග සමහර විට, විස්තර ක්ෂේත්ර හෝ දෝෂ ක්ෂේත්ර ඇත; වලංගු දෝෂ ක්ෂේත්ර නාමය විසින් ගැටළු ලැයිස්තුගත.

API කාණ්ඩ

කාණ්ඩය අනුව අපගේ API ලේඛන පිරික්සන්න:

සේවාදායක API 15 අන්ත ලක්ෂ්‍ය

නිර්මාණය, පරීක්ෂා, බලය, නැවත ප් රමාණය සහ සේවාදායක මකා දමන්න, රූට් මුරපදය යළි සකසන්න, ආපසු DNS සකසන්න, විධාන ධාවනය කරන්න, සහ SSH යතුරු කළමනාකරණය කරන්න.

ලේඛන බලන්න
උපස්ථ API 4 අන්ත ලක්ෂ්‍ය

ඔබේ සේවාදායකය පිටපත් ලැයිස්තුගත, නව පිටපතක් ආරම්භ, සහ පිටපතක් සිට සේවාදායකය ප්රතිස්ථාපනය.

ලේඛන බලන්න
ස්නැප්ෂොට් API 4 අන්ත ලක්ෂ්‍ය

සේවාදායකය ලේබල් ස්නයිප්ස් ගන්න, ඒවා ලැයිස්තුගත සහ ඒවා මකා දමන්න.

ලේඛන බලන්න
සැලසුම් API 2 අන්ත ලක්ෂ්‍ය

ලබා ගත හැකි VPS සැලසුම් සහ මිලකරණ තොරතුරු ලබා ගන්න. සම්පත්, මිලකරණය සහ ලබා ගත හැකි බව පිළිබඳ විස්තර ලබා ගන්න.

ලේඛන බලන්න
මෙහෙයුම් පද්ධති API 2 අන්ත ලක්ෂ්‍ය

ඔබ ස්ථාපනය කළ හැකි මෙහෙයුම් පද්ධති සහ අනුවාද ලැයිස්තුගත කරන්න, උබුන්ටු, ඩෙබියන්, රොකී ලිනක්ස්, සෙන්ටෝස් ස්ට්‍රීම්, ෆෙඩෝරා සහ ඇල්පීන වැනි.

ලේඛන බලන්න
ඩොමේන API 7 අන්ත ලක්ෂ්‍ය

ලබා ගත හැකි පරීක්ෂා කරන්න, ලියාපදිංචි සහ ඩොමේන අලුත් කිරීම, සහ nameservers සහ ස්වයංක්රීය අලුත් කිරීම සකස් කරන්න.

ලේඛන බලන්න
DNS API 13 අන්ත ලක්ෂ්‍ය

DNS කලාප නිර්මාණය සහ නිර්මාණය, යාවත්කාලීන හා ඔවුන්ගේ A, A, CNAME, MX, TXT, SRV, CAA සහ වෙනත් වාර්තා මකා දමන්න.

ලේඛන බලන්න
ස්ථාන API 2 අන්ත ලක්ෂ්‍ය

සේවාදායකය ස්ථාපනය සඳහා ලබා ගත හැකි ස්ථාන ලැයිස්තුගත කරන්න.

ලේඛන බලන්න
ගිණුම 1 අන්ත ලක්ෂ්‍ය

ගිණුම් පැතිකඩ සහ API ටොකන් තොරතුරු ලබා ගන්න. ටොකන් අයිති වන ගිණුම හඳුනාගෙන එහි අවසර පරීක්ෂා කරන්න.

ලේඛන බලන්න
අනුබද්ධ 7 අන්ත ලක්ෂ්‍ය

ඔබේ අනුබද්ධ ඉතිරි ඇද, නිර්දේශ, ඔබේම වාර්තා කිරීම සඳහා කොමිසම් හා ගෙවීම්, ගෙවීම් සැකසුම් වෙනස් හා ඉල්ලා ගෙවීම්.

ලේඛන බලන්න

තවත් අවසාන ස්ථානයන්

API ද යෙදුම් යෙදවුම් සඳහා අවසන් ස්ථානයන් ඇත (/api/v1/deploy-configs/ සහ /api/v1/deployments/). ඔවුන් තවමත් මෙම පිටු මත විස්තර කර නැත; අන්තර්ක්රියාකාරී උපුටා සෑම අවසන් ස්ථානයක් ලැයිස්තුගත, සජීවී API සිට ජනනය.

අන්තර්ක්‍රියාකාරී API උපුටනය විවෘත කරන්න

උදව් අවශ්‍යයි?

ඔබට කිසියම් ප්‍රශ්නයක් ඇත්නම් හෝ API සම්බන්ධයෙන් සහාය අවශ්‍ය නම්, කරුණාකර පහත සඳහන් දෑ සම්බන්ධ කර ගැනීමට පසුබට නොවන්න: