VPS.org API

Dokumentimi i API REST

Dokumentimi i API VPS.org

Dokumentacion i plotë i REST API për menaxhimin e serverëve VPS, domeneve, DNS, kopjeve rezervë dhe më shumë.

URL-ja bazë https://admin.vps.org/api/v1
Autentifikimi Token i Mbajtësit
Versioni v1
Formati JSON

Fillimi

API-ja VPS.org ju lejon të menaxhoni në mënyrë programore të gjitha aspektet e infrastrukturës suaj të hostimit VPS, duke përfshirë serverat, domenet, të dhënat DNS, kopjet rezervë dhe pamjet e çastit.

Autentifikimi

Të gjitha kërkesat API kërkojnë autentifikim duke përdorur një token të Mbajtësit. Mund ta gjeneroni tokenin tuaj API nga cilësimet e llogarisë suaj në 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);

Çdo token mban të drejtat e veta, si servers:list ose dns:*. Një kërkesë që kërkon të drejtat që token nuk i ka, refuzohet me 403 dhe një fushë required_permission që emëron të drejtat që mungojnë. Referenca e të drejtave

Kufizimi i Shkallës

Kërkesat e autentifikuara janë të kufizuara në 1,000 për orë për llogari. Kërkesat e paautentifikuara janë të kufizuara në 100 për orë për adresë IP. Një kërkesë mbi limitin merr 429 me një header Retry-After që jep numrin e sekondave për të pritur. Nuk dërgohen headers me limitin e shpejtësisë në përgjigjet e suksesshme.

Faqja

Lista e pikave përfundimtare kthen një objekt me numrin, të ardhmen, të kaluarën dhe rezultatet, 25 elemente për faqe. Shko tek faqja për të lëvizur midis faqes, ose ndjek URL-në tjetër derisa të jetë null. Lista e serverëve pranon gjithashtu page_size, deri në 100.

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

Trajtimi i Gabimeve

API përdor kode standarde të statusit HTTP për të treguar suksesin ose dështimin:

Kodi i Statusit Përshkrimi
200 Sukses - Kërkesa u përfundua me sukses
201 Krijuar - Burimi u krijua me sukses
400 Kërkesë e gabuar - Parametra të pavlefshëm ose kërkesë e keqformuar
202, 204 E pranuar dhe e vendosur në radhë (202), ose e fshirë pa trup përgjigje (204)
402 Pagimi është i nevojshëm: nuk ka metodë pagese në file, faturat e papaguara, apo një autorizim paraprak i refuzuar i kartës
403 E ndaluar: token mungon, është i pavlefshëm ose ka skaduar, ose nuk ka të drejtat e kërkuara. Autentifikimi i dështuar gjithashtu kthen 403, jo 401.
404 Nuk u gjet - Burimi nuk ekziston
409 Konflikt: për shembull një ndryshim i madhësisë në proces, kapacitet i pamjaftueshëm, ose një instalim që është tashmë në proces
429 Shumë kërkesa - Limiti i shpejtësisë është tejkaluar
500 Gabim i brendshëm i serverit - Diçka shkoi keq nga ana jonë
503 Shërbimi nuk është në dispozicion: problem i përkohshëm. Përpiqu përsëri, duke respektuar Retry-After kur dërgohet.

Trupat e gabimit janë JSON. Shumica kanë një fushë detajesh ose një fushë gabimi, ndonjëherë me një mesazh; gabimet e validimit listojnë problemet sipas emrave të fushave.

Kategoritë e API-t

Shfletoni dokumentacionin tonë të API-t sipas kategorisë:

API-ja e serverëve 15 Pikat fundore

Krijo, kontrollo, fuqizo, ndrysho madhësinë dhe elemino serverat, rivendos fjalëkalimin root, vendos DNS të kundërt, ekzekuto komanda dhe menaxhoje çelësat SSH.

Shiko Dokumentacionin
API-ja e kopjeve rezervë 4 Pikat fundore

Listo backup-et e serverit, fillo një backup të ri dhe rikthe serverin nga një backup.

Shiko Dokumentacionin
API-ja e pamjeve të çastit 4 Pikat fundore

Merr foto të etiketuara të një serveri, listoje ato dhe eleminoi ato.

Shiko Dokumentacionin
API-ja e planeve 2 Pikat fundore

Merrni planet VPS të disponueshme dhe informacionin mbi çmimet. Merrni detaje rreth burimeve, çmimeve dhe disponueshmërisë.

Shiko Dokumentacionin
API-ja e Sistemeve Operative 2 Pikat fundore

Liston sistemet operativë dhe versionet që mund të instaloni, si Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora dhe Alpine.

Shiko Dokumentacionin
Domain API 7 Pikat fundore

Kontrollo disponueshmërinë, regjistro dhe rinovojë domenet, dhe vendos serverat e emrave dhe rinovimin automatik.

Shiko Dokumentacionin
DNS API 13 Pikat fundore

Krijo zona DNS dhe krijo, përditëso dhe elemino rregjistrimet e tyre A, A, CNAME, MX, TXT, SRV, CAA dhe të tjera.

Shiko Dokumentacionin
API-ja e Vendndodhjeve 2 Pikat fundore

Liston pozicionet në dispozicion për përdorimin e serverit.

Shiko Dokumentacionin
Profili 1 Pikat fundore

Merr informacionet e profilit të llogarisë dhe token API. Identifiko llogarinë që i përket një token dhe kontrollo të drejtat e saj.

Shiko Dokumentacionin
Afiliate 7 Pikat fundore

Tërhiq balancën e partnerëve, referencave, komisioneve dhe pagesave në raportimin tënd, ndrysho rregullimet e pagesës dhe kërko pagesa.

Shiko Dokumentacionin

Më shumë pika përfundimtare

API gjithashtu ka pika përfundimtare për zbatimin e aplikativit (/api/v1/deploy-configs/ dhe /api/v1/deployments/). Ato nuk janë përshkruar në këto faqe ende; referenca interaktive liston çdo pikë përfundimtare, të gjeneruar nga API e gjallë.

Hap referencën interaktive API

Keni nevojë për ndihmë?

Nëse keni pyetje ose keni nevojë për ndihmë me API-në, ju lutemi mos hezitoni të na kontaktoni: