VPS.org API

REST API-dokumentasie

VPS.org API-dokumentasie

Volledige REST API-dokumentasie vir die bestuur van VPS-bedieners, domeine, DNS, rugsteun en meer.

Basis-URL https://admin.vps.org/api/v1
Verifikasie Draerteken
Weergawe v1.0
Formaat JSON

Aan die gang kom

Die VPS.org API laat jou toe om alle aspekte van jou VPS-gasheerinfrastruktuur programmaties te bestuur, insluitend bedieners, domeine, DNS-rekords, rugsteun en kiekies.

Verifikasie

Alle API-versoeke vereis verifikasie met behulp van 'n Draer-token. Jy kan jou API-token genereer vanaf jou rekeninginstellings by 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);

Tempobeperking

API-versoeke is beperk tot 300 versoeke per 5 minute per API-token. Inligting oor die tempolimiet is ingesluit in die antwoordopskrifte:

Fouthantering

Die API gebruik standaard HTTP-statuskodes om sukses of mislukking aan te dui:

Statuskode Beskrywing
200 Sukses - Versoek suksesvol voltooi
201 Geskep - Hulpbron suksesvol geskep
400 Slegte versoek - Ongeldige parameters of verkeerd gevormde versoek
401 Ongemagtig - Ongeldige of ontbrekende verifikasietoken
403 Verbode - Onvoldoende toestemmings
404 Nie gevind nie - Hulpbron bestaan nie
429 Te veel versoeke - tempolimiet oorskry
500 Interne bedienerfout - Iets het aan ons kant verkeerd geloop

API-kategorieë

Blaai deur ons API-dokumentasie volgens kategorie:

Bedieners-API 9 eindpunte

Skep, bestuur en beheer VPS-bedieners. Sluit kragbestuur, grootteverandering, herinstallasie en bedienerinligtingherwinning in.

Bekyk Dokumentasie
Rugsteun-API 3 eindpunte

Bestuur outomatiese en handmatige rugsteun vir jou bedieners. Lys, skep, herstel en verwyder bedienerrugsteun.

Bekyk Dokumentasie
Snapshots API 4 eindpunte

Skep en bestuur bedienerkiekies vir vinnige herstelpunte. Perfek vir toetsing en vinnige terugrol.

Bekyk Dokumentasie
Planne API 2 eindpunte

Kry beskikbare VPS-planne en prysinligting op. Kry besonderhede oor hulpbronne, pryse en beskikbaarheid.

Bekyk Dokumentasie
Bedryfstelsels API 2 eindpunte

Lys beskikbare bedryfstelsels en beelde vir bedienerontplooiing. Sluit Ubuntu, Debian, CentOS en meer in.

Bekyk Dokumentasie
Domeine-API 6 eindpunte

Soek, kontroleer beskikbaarheid, registreer en bestuur domeinname. Voltooi domeinlewensiklusbestuur deur die API.

Bekyk Dokumentasie
DNS-API 4 eindpunte

Bestuur DNS-sones en -rekords programmaties. Skep, werk op en verwyder A, AAAA, CNAME, MX, TXT en ander rekordtipes.

Bekyk Dokumentasie
Liggings-API 1 eindpunt

Lys beskikbare datasentrumliggings vir bedienerontplooiing. Kies uit verskeie streke regoor die wêreld.

Bekyk Dokumentasie

Het jy hulp nodig?

Indien u vrae het of hulp benodig met die API, moet asseblief nie huiwer om ons te kontak nie: