VPS.org API

REST API dokumentacija

VPS.org API dokumentacija

Išsami REST API dokumentacija, skirta VPS serverių, domenų, DNS, atsarginių kopijų ir kitų dalykų valdymui.

Bazinis URL https://admin.vps.org/api/v1
Autentifikavimas Turėtojo žetonas
Versija v1.0
Formatas JSON

Pradžia

„VPS.org“ API leidžia programiškai valdyti visus VPS talpinimo infrastruktūros aspektus, įskaitant serverius, domenus, DNS įrašus, atsargines kopijas ir momentines kopijas.

Autentifikavimas

Visoms API užklausoms reikalingas autentifikavimas naudojant „Bearer“ prieigos raktą. API prieigos raktą galite sugeneruoti savo paskyros nustatymuose adresu 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);

Greičio ribojimas

API užklausų skaičius ribojamas iki 300 per 5 minutes vienam API prieigos raktui. Informacija apie užklausų dažnio apribojimą pateikiama atsakymo antraštėse:

Klaidų tvarkymas

API naudoja standartinius HTTP būsenos kodus, kad parodytų sėkmę arba nesėkmę:

Būsenos kodas Aprašymas
200 Sėkmė – užklausa sėkmingai įvykdyta
201 Sukurta – išteklius sėkmingai sukurtas
400 Neteisinga užklausa – neteisingi parametrai arba netinkamai suformuota užklausa
401 Neautorizuota – neteisingas arba trūksta autentifikavimo prieigos rakto
403 Draudžiama – Nepakanka leidimų
404 Nerasta – išteklių nėra
429 Per daug užklausų – viršytas dažnio limitas
500 Vidinė serverio klaida – kažkas nutiko mūsų pusėje

API kategorijos

Naršykite mūsų API dokumentaciją pagal kategoriją:

Serverių API 9 galiniai taškai

Kurti, valdyti ir kontroliuoti VPS serverius. Apima energijos valdymą, dydžio keitimą, diegimą iš naujo ir serverio informacijos gavimą.

Peržiūrėti dokumentaciją
Atsarginių kopijų API 3 galiniai taškai

Tvarkykite automatines ir rankines serverių atsargines kopijas. Pateikite serverio atsarginių kopijų sąrašą, kurkite, atkurkite ir ištrinkite.

Peržiūrėti dokumentaciją
Momentinių kopijų API 4 galiniai taškai

Kurkite ir tvarkykite serverio momentines kopijas, kad galėtumėte greitai atkurti duomenis. Puikiai tinka testavimui ir greitam atkurtų nustatymų atkūrimui.

Peržiūrėti dokumentaciją
Planų API 2 galiniai taškai

Gaukite galimus VPS planus ir kainodaros informaciją. Gaukite išsamią informaciją apie išteklius, kainas ir prieinamumą.

Peržiūrėti dokumentaciją
Operacinių sistemų API 2 galiniai taškai

Išvardykite galimus operacines sistemas ir atvaizdus, skirtus diegti serveryje. Apima „Ubuntu“, „Debian“, „CentOS“ ir kt.

Peržiūrėti dokumentaciją
Domenų API 6 galiniai taškai

Ieškokite, tikrinkite prieinamumą, registruokite ir valdykite domenų vardus. Visą domeno gyvavimo ciklo valdymą atlikite per API.

Peržiūrėti dokumentaciją
DNS API 4 galiniai taškai

Programiškai tvarkykite DNS zonas ir įrašus. Kurkite, atnaujinkite ir ištrinkite A, AAAA, CNAME, MX, TXT ir kitų tipų įrašus.

Peržiūrėti dokumentaciją
Vietovių API 1 galinis taškas

Išvardykite galimus duomenų centro vietas serverių diegimui. Pasirinkite iš kelių regionų visame pasaulyje.

Peržiūrėti dokumentaciją

Reikia pagalbos?

Jei turite klausimų arba jums reikia pagalbos dėl API, nedvejodami kreipkitės: