VPS.org API Documentation

Ukuqalisa

I-VPS.org API ikuvumela ukuthi uphathe ngokuhlelekile zonke izici zengqalasizinda yakho yokubamba i-VPS, okuhlanganisa amaseva, izizinda, amarekhodi e-DNS, ama-backup, kanye nezifinyezo.

Ukuqinisekiswa

Zonke izicelo ze-API zidinga ukuqinisekiswa kusetshenziswa ithokheni ye-Bearer. Ungakha ithokheni yakho ye-API kusuka kuzilungiselelo ze-akhawunti yakho ku- 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);

I-token ngayinye ifaka izinqumo zayo, njenge-servers:list noma dns:*. Isicelo esidinga izinqumo i-token ayinayo silahlekile nge-403 ne-required_permission field ebizwa ngezinqumo ezilahlekile. Iimvumo

Umkhawulo Wezinga

Izicelo eziqinisekisiwe zilinganiselwa ku-1,000 ngehora ngalinye nge-akhawunti ngayinye. Izicelo ezingaqinisekisiwe zilinganiselwa ku-100 ngehora ngalinye nge-IP idilesi. Isicelo esingaphezu komkhawulo sithola u-429 nge-Retry-After header enikeza inani lezinhlamvu zokulindela. Akukho silinganiso sokulinganisa okubhalwe phansi kuthunyelwe kuphendula okuphumelelayo.

Ukuhlela

Uhlu lwezinhlamvu eziphelela lubuyisela into ngokubalwa, okulandelayo, okudlule kanye nemiphumela, 25 izinto ngakhasi ngalinye. Phatha ikhasi ukuzula phakathi kwamakhasi, noma landela i-URL elandelayo kuze kube yi-null. Uhlu lwezisebenzisi luyavuma page_size, kuze kube yi-100.

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

Iphutha Lokuphatha

I-API isebenzisa amakhodi wesimo se-HTTP ajwayelekile ukukhombisa impumelelo noma ukwehluleka:

Ikhodi Yesimo	Incazelo
`200`	Impumelelo - Isicelo siqediwe ngempumelelo
`201`	Kudalwe - Insiza idalwe ngempumelelo
`400`	Isicelo Esibi - Amapharamitha angavumelekile noma isicelo esingalungile
`202`, `204`	Ivunyelwe futhi ifakwe ifolokhwe (202), noma isuswa ngaphandle kwengxenye yomphumela (204)
`402`	Imali idinga ukukhokhwa: akukho indlela yokukhokhwa kwifayela, amafayela angakhokhwa, noma ikhadi elivunyelwe ngaphambili lilahlekile
`403`	Ivunyelwe: i-token ilahlekile, ayisebenzi noma iphelile, noma ayinazo izivumelwano ezidingekayo. Ukuqinisekiswa okubi futhi kubuyisela 403, hhayi 401.
`404`	Akutholakali - Insiza ayikho
`409`	Ungqubuzana: isibonelo, ukuguqula ubukhulu kuqhubeka, akukho lutho olunekhono, noma ukuthunyelwa kusebenza
`429`	Izicelo Eziningi Kakhulu - Umkhawulo Wesilinganiso udluliwe
`500`	Iphutha Leseva Yangaphakathi - Kukhona okungahambanga kahle ohlangothini lwethu
`503`	Inkonzo ayitholakalanga: izinkinga ezingenasikhathi. Zama futhi, uhlonipha Retry-After uma ithunyelwe.

Izimbambo zephutha yi-JSON. Eziningi zinomkhakha wemingwane noma umkhakha wephutha, ngamanye amaxesha nomyalezo; izinkinga zokuqinisekiswa zidweba izinkinga ngegama lomkhakha.

Izigaba ze-API

Dlulisa amehlo kumadokhumenti ethu e-API ngesigaba:

I-API Yamaseva 15 Amaphoyinti Okugcina

Dala, hlola, sebenzisa, shintsha ubukhulu bese ususa izisebenzisi, buyisela igama lokungena lomnikazi, hlela i-DNS eguqukayo, sebenzisa imiyalo, futhi uphatha izinkinobho ze-SSH.

Buka Amadokhumenti

I-API Yezipele 4 Amaphoyinti Okugcina

Linganisa izilungiselelo zokugcina zeseva, qala isilungiselelo sokugcina esitsha, futhi ubuyisele isilawuli kusuka ku-backup.

Buka Amadokhumenti

I-Snapshots API 4 Amaphoyinti Okugcina

Thola izithombe ezibophekile zeseva, hlela futhi cima.

Buka Amadokhumenti

I-API Yezinhlelo 2 Amaphoyinti Okugcina

Thola izinhlelo ze-VPS ezitholakalayo kanye nolwazi lwamanani. Thola imingwane mayelana nezinsizakusebenza, amanani, kanye nokutholakala.

Buka Amadokhumenti

I-API Yezinhlelo Zokusebenza 2 Amaphoyinti Okugcina

Linganisa ama-operating systems nama-versions ongayifaka, njenge-Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora ne-Alpine.

Buka Amadokhumenti

Ama-domains API 7 Amaphoyinti Okugcina

Khangela ukutholakala, bhalisela futhi uvuselele amadomains, futhi umisele izisebenzisi zegama kanye nokuvuselelwa okuzenzakalelayo.

Buka Amadokhumenti

I-DNS API 13 Amaphoyinti Okugcina

Dala izifunda ze-DNS futhi yenza, hlaziya futhi ususe i-A, A, CNAME, MX, TXT, SRV, CAA nezinye izingeniso.

Buka Amadokhumenti

I-API Yezindawo 2 Amaphoyinti Okugcina

Linganisa izindawo ezikhona zokuphatha isisebenzisi.

Buka Amadokhumenti

I-akhawunti 1 Amaphoyinti Okugcina

Thola iprofayili ye-akhawunti kanye ne-API token information. Qaphela ukuthi iyiphi i-akhawunti i-token ikhona futhi hlola izivumelwano zayo.

Buka Amadokhumenti

Izisebenzi 7 Amaphoyinti Okugcina

Thola i-akhawunti yakho ye-affiliate, izixhumanisi, amakomidi kanye nemali engenayo ezingxoxweni zakho, shintsha izilungiselelo zokukhokha futhi ucele imali engenayo.

Buka Amadokhumenti

Izindawo eziphelela ezingaphezu kwezingu-100

I-API inezinkomba zesiphelo zezinhlelo zokusebenza ezisebenza (/api/v1/deploy-configs/ ne /api/v1/deployments/). Azicacisiwe kule khasi; umbiko oxhumanayo ukhombisa zonke izinkomba zesiphelo, ezikhiqizwa yi-API ephilayo.

Vula i-API exhunywe

Udinga usizo?

Uma unemibuzo noma udinga usizo nge-API, sicela ungangabazi ukuxhumana nathi:

Amathikithi Okusekela: Vula ithikithi lokusekela
I-imeyili: hello@vps.org
Uhlelo Imibhalo Egcwele