Documentare API VPS.org

Noțiuni de bază

API-ul VPS.org vă permite să gestionați programatic toate aspectele infrastructurii de găzduire VPS, inclusiv servere, domenii, înregistrări DNS, copii de rezervă și snapshot-uri.

Autentificare

Toate solicitările API necesită autentificare folosind un token Bearer. Puteți genera tokenul API din setările contului dvs. la 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);

Fiecare token poartă propriile permissione, cum ar fi serverele:list sau dns:*. O cerere care are nevoie de o permisiune, nu are permisiunea de a fi refuzată cu 403 și un câmp obligatoriu_permisie care numește permisiunea lipsă. Referință permisiunilor

Limitarea ratei

Cererile autenticate sunt limitate la 1000 pe cont. Solicitațiile neautenticate sunt limitate la 100 pe oră pe adresă IP. O cerere peste limita primește 429 cu un antet de încercare-După așteptare, oferind numărul de secunde. Nici un entități limită de rată nu sunt trimise la răspunsuri cu succes.

Paginări

Încheierea listei de puncte de referință returnează un obiect cu număr, următor, precedent și rezultate, 25 elemente pe pagină. Pagină de trecere pentru a muta între pagini, sau urma următoarea URL până la nul. Lista serverelor acceptă, de asemenea, pagina_size, până la 100.

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

Gestionarea erorilor

API-ul folosește coduri de stare HTTP standard pentru a indica succesul sau eșecul:

Corpile de eroare sunt JSON. Cele mai multe au un câmp de detaliu sau un câmp de eroare, uneori cu un mesaj; erorile de validare listă problemele după numele câmpului.

Categorii API

Răsfoiți documentația noastră API pe categorii:

Mai multe puncte finale

API are, de asemenea, puncte de endpoint pentru implementarea aplicațiilor (/api/v1/deployment-configs/ și /api/v1/deployments/). Ele nu sunt descrise în aceste pagini încă; lista de referință interactivă fiecare punct de end, generat din API live.

Ai nevoie de ajutor?

Dacă aveți întrebări sau aveți nevoie de asistență cu API-ul, nu ezitați să ne contactați:

• Tichete de asistență: Deschideți un tichet de asistență
• E-mail: hello@vps.org
• Documentare: Documentație completă