VPS.org API

Dokumentazzjoni tal-REST API

VPS.org Dokumentazzjoni API

Dokumentazzjoni kompluta tal-REST API għall-immaniġġjar ta' servers VPS, dominji, DNS, backups, u aktar.

URL Bażiku https://admin.vps.org/api/v1
Awtentikazzjoni Token tal-Portatur
Verżjoni v1
Format JSON

Nibdew

L-API tal-VPS.org tippermettilek timmaniġġja b'mod programmatiku l-aspetti kollha tal-infrastruttura tal-hosting tal-VPS tiegħek, inklużi servers, dominji, rekords tad-DNS, backups, u snapshots.

Awtentikazzjoni

It-talbiet kollha tal-API jeħtieġu awtentikazzjoni bl-użu ta' Bearer token. Tista' tiġġenera t-token tal-API tiegħek mis-settings tal-kont tiegħek fuq 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);

Kull token iġorr il-permessi tiegħu stess, bħal servers:list jew dns:*.Talba li teħtieġ permess li t-tokens ma jkollhomx hija rrifjutata b'403 u field required_permission li jissemma l-permess nieqes. Permessi Referenza

Limitazzjoni tar-Rata

Talbiet awtentikati huma limitati għal 1,000 kull siegħa għal kull kont. Talbiet mhux awtentikati huma limitati għal 100 kull siegħa għal kull indirizz IP. Talba fuq il-limitu tirċievi 429 b'intestatura Retry-After li tagħti n-numru ta' sekondi biex tistenna. L-ebda intestaturi ta' limitu tar-rata ma jintbagħtu fuq tweġibiet b'suċċess.

Paginazzjoni

Il-punti tat-tmiem tal-lista jirritornaw oġġett b'għadd, li jmiss, preċedenti u riżultati, 25 oġġett għal kull paġna. Pass paġna biex timxi bejn il-paġni, jew isegwu l-URL li jmiss sakemm ikun null. Il-lista tas-servers taċċetta wkoll page_size, sa 100.

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

Immaniġġjar tal-Iżbalji

L-API tuża kodiċijiet standard tal-istatus HTTP biex tindika suċċess jew falliment:

Kodiċi tal-Istatus Deskrizzjoni
200 Suċċess - Talba kompluta b'suċċess
201 Maħluqa - Ir-riżorsa nħolqot b'suċċess
400 Talba Ħażina - Parametri invalidi jew talba ffurmata ħażin
202, 204 Aċċettati u mqiegħda fil-kju (202), jew imħassra mingħajr ebda korp ta’ tweġiba (204)
402 Ħlas Meħtieġ: l-ebda metodu ta' ħlas fuq il-fajl, fatturi mhux imħallsa, jew pre-awtorizzazzjoni tal-kard miċħuda
403 Projbit: it-token huwa nieqes, invalidu jew skadut, jew m'għandux il-permess meħtieġ.Awtentikazzjoni li ma rnexxietx ukoll tirritorna 403, mhux 401.
404 Ma nstabx - Ir-riżorsa ma teżistix
409 Kunflitt: pereżempju, ridimensjoni diġà fil-proċess, kapaċità mhux biżżejjed, jew l-iskjerament diġà qed jaħdem
429 Wisq Talbiet - Il-limitu tar-rata nqabeż
500 Żball Intern tas-Server - Xi ħaġa marret ħażin min-naħa tagħna
503 Servizz Mhux Disponibbli: problema temporanja. Ipprova mill-ġdid, onorar Retry-After meta tintbagħat.

Il-biċċa l-kbira għandhom qasam ta' dettall jew qasam ta' żball, xi kultant b'messaġġ; żbalji ta' validazzjoni jelenkaw il-problemi skont l-isem tal-qasam.

Kategoriji tal-API

Fittex id-dokumentazzjoni tal-API tagħna skont il-kategorija:

API tas-Servers 15 Punti tat-tmiem

Oħloq, spezzjona, qawwa, tibdel id-daqs u tħassar is-servers, tirrisettja l-password tal-għerq, tissettja DNS inversa, tmexxi kmandi, u timmaniġġja ċwievet SSH.

Ara d-Dokumentazzjoni
API tal-Backups 4 Punti tat-tmiem

Elenkar backups server tiegħek, tibda backup ġdid, u jirrestawraw server minn backup.

Ara d-Dokumentazzjoni
API tal-Snapshots 4 Punti tat-tmiem

Ħu snapshots tikkettati ta ’server, elenkawhom u tħassarhom.

Ara d-Dokumentazzjoni
API tal-Pjanijiet 2 Punti tat-tmiem

Irkupra l-pjanijiet VPS disponibbli u l-informazzjoni dwar il-prezzijiet. Ikseb dettalji dwar ir-riżorsi, il-prezzijiet, u d-disponibbiltà.

Ara d-Dokumentazzjoni
API tas-Sistemi Operattivi 2 Punti tat-tmiem

Elenka s-sistemi operattivi u l-verżjonijiet li tista'tinstalla, bħal Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora u Alpine.

Ara d-Dokumentazzjoni
Domenji API 7 Punti tat-tmiem

Iċċekkja d-disponibbiltà, irreġistra u tiġġedded dominji, u jistabbilixxu nameservers u tiġdid awtomatiku.

Ara d-Dokumentazzjoni
API tad-DNS 13 Punti tat-tmiem

Oħloq żoni DNS u joħolqu, jaġġornaw u tħassar tagħhom A, A, CNAME, MX, TXT, SRV, CAA u rekords oħra.

Ara d-Dokumentazzjoni
API tal-Lokazzjonijiet 2 Punti tat-tmiem

Elenka l-postijiet disponibbli għall-iskjerament server.

Ara d-Dokumentazzjoni
Kont 1 Punti tat-tmiem

Identifika liema kont jappartjeni għal token u iċċekkja l-permessi tiegħu.

Ara d-Dokumentazzjoni
Assoċjati 7 Punti tat-tmiem

Iġbed bilanċ affiljat tiegħek, referenzi, kummissjonijiet u ħlasijiet fir-rappurtar tiegħek stess, bidla settings ħlas u talba ħlasijiet.

Ara d-Dokumentazzjoni

Aktar punti aħħarin

L-API għandha wkoll punti aħħarin għall-implimentazzjoni tal-apps (/api/v1/deploy-configs/ u /api/v1/deployments/) li għadhom mhumiex deskritti f'dawn il-paġni; ir-referenza interattiva telenka kull punt aħħari, iġġenerat mill-API ħaj.

Iftaħ ir-referenza interattiva tal-API

Teħtieġ l-Għajnuna?

Jekk għandek xi mistoqsijiet jew teħtieġ għajnuna bl-API, jekk jogħġbok ikkuntattjana: