VPS.org API

Litokomane tsa REST API

VPS.org Litokomane tsa API

Tokomane e felletseng ea REST API bakeng sa ho laola li-server tsa VPS, libaka, DNS, li-backups, le tse ling.

URL ea motheo https://admin.vps.org/api/v1
Netefatso Letšoao la Mojari
Tlhaloso v1
Bophara JSON

Rea qala

VPS.org API e o dumella ho laola ka lenaneo dikarolo tsohle tsa meralo ya motheo ya hao ya ho amohela VPS, ho kenyeletswa le di-server, di-domain, direkoto tsa DNS, di-backup le di-snapshots.

Netefatso

Likopo tsohle tsa API li hloka netefatso ho sebelisoa token ea Bearer. U ka hlahisa token ea hau ea API ho tsoa litlhophisong tsa akhaonto ea hau ho 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);

Token e ngoe le e ngoe e na le litokelo tsa eona, joalo ka servers:list kapa dns:*. Lipotso tse hlokang litokelo tseo token e sa li nang le tsona li refuted ka 403 le sebaka sa required_permission se bitsoang litokelo tse sa fumaneheng. Litokelo

Tekanyetso ea Sekhahla

Lipotso tse sa tsejoeng li lekanyelitsoe ho 1000 ka hora ka akhaonto. Lipotso tse sa tsejoeng li lekanyelitsoe ho 100 ka hora ka aterese ea IP. Lipotso tse feta tekanyetso li tla fumana 429 le lebokose le reng Retry-After le fanang ka palo ea metsotsoana e tla etsoa. Ha ho na lebokose le reng rate limit le tla romelloa ka likarabo tse atlehileng.

Ho theha leqephe

Li-endpoints tsa lenane li khutlisa ntho e nang le palo, e latelang, e fetileng le litlamorao, lintho tse 25 ka leqephe. Emisa leqephe ho tsamaea lipakeng tsa lihlooho, kapa latela URL e latelang ho fihlela e le null. Lenaneo la liservers le amohela page_size, ho fihlela ho 100.

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

Phoso ea ho sebetsana le eona

API e sebelisa likhoutu tse tloaelehileng tsa boemo ba HTTP ho bontša katleho kapa ho hloleha:

Khoutu ea Boemo Bophara
200 Katleho - Kopo e phethetsoe ka katleho
201 E entsoe - Mohloli o entsoe ka katleho
400 Kopo e Fosahetseng - Liparamitha tse fosahetseng kapa kopo e fosahetseng
202, 204 E amoheloe'me e buloa (202), kapa e tlosoa ntle le ho khutlisa' mele (204)
402 Theko e hlokahale: ha ho na mokhoa oa ho lefa ka file, li-invoice tse sa lefelloeng, kapa ho laoloa pele ha karete e sa lumelloeng
403 Ho laoloa: token e sa fumaneha, e sa nepahale kapa e feletseng, kapa e na le tumello e hlokahalang. Ho sa khone ho netefatsa ho khutlisa 403, eseng 401.
404 Ha e Fumanehe - Mohloli ha o eo
409 Ho tšoana: mohlala, ho fetola boholo ho ntse ho tsoela pele, ho se na bokhoni bo lekaneng, kapa ho kenya ho ntse ho sebetsa
429 Likopo tse ngata haholo - Moeli oa sekhahla o fetile
500 Phoso ea Seva sa Ka Hare - Ho na le ho hong ho sa kang ha tsamaea hantle lehlakoreng la rona
503 Litšebeletso ha li fumanehe: bothata bo ka nako. Tlanya hape, ho latela Retry-After ha e romelloa.

Li-body tsa liphoso ke JSON. Ho na le libaka tse ngata tsa lintlha kapa libaka tsa liphoso, ka linako tse ling le lengolo-tsoibila; liphoso tsa ho nepahala li bonts'a mathata ka lebitso la sebaka.

Lihlopha tsa API

Batla litokomane tsa rona tsa API ka sehlopha:

Liseva tsa API 15 Mafelo a ho Qetela

E etsa, e hlahloba, e matlafatsa, e fetola boholo ba eona le ho tlosa li-servers, e khutliselitse lentsoe la hau la root, e be DNS e khutsitseng, e phethela litaelo, le ho laola li-keys tsa SSH.

Sheba Litokomane
API ea Li-backup 4 Mafelo a ho Qetela

Tsebisa li-backup tsa hau tsa seva, qala backup e ncha, le ho khutlisa server ho tloha backup.

Sheba Litokomane
Lifoto tsa Snapshot tsa API 4 Mafelo a ho Qetela

Ntlafatsa lifoto tsa server, li hlophisa'me u li tlose.

Sheba Litokomane
Merero ea API 2 Mafelo a ho Qetela

Fumana merero ea VPS e fumanehang le tlhahisoleseling ea litheko. Fumana lintlha tse mabapi le lisebelisoa, litheko le ho fumaneha.

Sheba Litokomane
Sistimi ea Ts'ebetso ea API 2 Mafelo a ho Qetela

Li-OS le li-versions tseo u ka li kenya, joalo ka Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora le Alpine.

Sheba Litokomane
Li-domains API 7 Mafelo a ho Qetela

Check availability, register and renew domains, and set nameservers and auto-renew.

Sheba Litokomane
DNS API 13 Mafelo a ho Qetela

E etsa libaka tsa DNS le ho etsa, ho nchafatsa le ho tlosa A, A, CNAME, MX, TXT, SRV, CAA le li-records tse ling.

Sheba Litokomane
API ea Libaka 2 Mafelo a ho Qetela

Sebetsa ka ho lekola sebaka sa ho kenya sephutheloana.

Sheba Litokomane
Akaunti 1 Mafelo a ho Qetela

Fumana tlhaiso-leseling ka profil ea ak'haonte le token ea API. Tseba hore na ak'haonte efe e nang le token'me u sheba litokelo tsa eona.

Sheba Litokomane
Li-affiliates 7 Mafelo a ho Qetela

Ea ho etsa chelete ea hau ea ho ba teng, ho ngolisa, likomishene le ho lefa ho tsoa ho linyeoe tsa hau, ho fetola likhetho tsa ho lefa le ho kopa ho lefa.

Sheba Litokomane

Li-endpoints tse ling

API e na le li-endpoints bakeng sa ho kenya li-app (/api/v1/deploy-configs/ le /api/v1/deployments/). Ha li hlalosoe ka li-page tsena; ho ngolisoa ha ho ngolisoa ho ngolisa li-endpoints tsohle, tse hlahisoang ho tloha ho API e phelang.

Bula ho ngolisoa ha API e interactive

Na u hloka thuso?

Haeba o na le lipotso kapa o hloka thuso ka API, ka kopo o seke oa tsilatsila ho ikopanya le: