Buuxi dukumentiyada REST API si aad u maamusho server-yada VPS, domain-yada, DNS-ka, kaydinta, iyo waxyaabo kaloo badan.
VPS.org API wuxuu kuu ogolaanayaa inaad si barnaamij ahaan ah u maamusho dhammaan dhinacyada kaabayaasha martigelinta VPS-gaaga, oo ay ku jiraan server-yada, domain-yada, diiwaannada DNS, kaydinta, iyo sawirada.
Dhammaan codsiyada API waxay u baahan yihiin xaqiijin iyadoo la adeegsanayo calaamadda Bearer. Waxaad ka soo saari kartaa calaamaddaada API dejinta akoonkaaga halkan admin.vps.org/account/developers/.
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 kasta oo qaado oggolaanshaha ay u gaar ah, sida servers: liiska ama DNS: *. A codsiga oo u baahan oggolaansho token ma laha waa la diiday la 403 iyo a required_permission field magacyada oggolaanshaha ka maqan. Xuquuqda Soo Celinta
Authenticated codsiyada waxaa xaddidan 1,000 saacaddii xisaab kasta. Authenticated codsiyada waxaa xaddidan 100 saacaddii cinwaanka IP kasta. A codsiga ka badan xaddidan helaa 429 la Retry-After header siin tirada ilbiriqsi oo sugaya. No heerka xaddidan headers waxaa la diray jawaabaha guusha.
Liiska endpoints soo celin wax la tirada, soo socda, hore iyo natiijooyinka, 25 waxyaabaha bog kasta. Pass page in ay u wareegaan inta u dhexeysa boggaga, ama raac URL soo socda ilaa ay tahay null. servers liiska sidoo kale aqbalaa page_size, ilaa 100.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API-gu wuxuu adeegsadaa lambarrada heerka HTTP ee caadiga ah si uu u muujiyo guul ama guuldarro:
| Koodhka Xaaladda | Tilmaamaha |
|---|---|
200 |
Guul - Codsiga si guul leh ayaa loo dhammaystiray |
201 |
La sameeyay - Kheyraad si guul leh loo sameeyay |
400 |
Codsi Xun - Xuduudo aan sax ahayn ama codsi khaldan |
202, 204 |
Aqbalay oo isku xigta (202), ama la tirtiro iyadoo aan jawaabta jirka (204) |
402 |
Bixinta loo baahan yahay: ma jiraan habka lacag bixinta on file, xisaabaadka aan la bixin, ama kaarka diiday hore u oggolaansho |
403 |
Xayiraadda: calaamadda waa la waayey, aan sharci ahayn ama dhamaatay, ama aan haysan oggolaanshaha loo baahan yahay. Authentication ku fashilantay sidoo kale ku soo laabtay 403, ma 401. |
404 |
Lama helin - Kheyraadku ma jiro |
409 |
Khilaaf: tusaale ahaan, resize horeyba u socda, awoodda aan ku filan, ama soo bandhigida horeyba u socda |
429 |
Codsiyo Aad u Badan - Xadka qiimaha ayaa dhaafay |
500 |
Khalad Adeegaha Gudaha - Wax baa khaldamay dhinaceena |
503 |
Service la heli karo: dhibaato waqti. Ku dadaal, sharaf Retry-After marka la diro. |
Dhibaatooyinka jirka waa JSON. Inta badan waxay leeyihiin dhul faahfaahin ama dhul qalad, marar badan oo la fariin; khaladaadka xaqiijinta liiska dhibaatooyinka by magac dhul.
Ka baadho dukumeentiyada API-ga ee nooc ahaan:
abuuro, baaritaan, awood, cusboonaysiinta iyo tirtirka servers, dib u dhigo password root, set DNS ka dib, fuliya amarrada, iyo maamula furayaasha SSH.
Fiiri DukumentiyadaLiiska aad server backups, bilowdo backup cusub, iyo soo celinta server ka backup.
Fiiri DukumentiyadaQaado snapshots labelled server, liiska iyaga oo tirtirto.
Fiiri DukumentiyadaSoo hel qorshayaasha VPS ee la heli karo iyo macluumaadka qiimaha. Hel faahfaahin ku saabsan agabka, qiimaha, iyo helitaanka.
Fiiri DukumentiyadaLiiska nidaamka hawlgalka iyo noocyada aad ku rakibi karto, sida Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora iyo Alpine.
Fiiri DukumentiyadaKa hubi helitaanka, diiwaangelinta iyo cusbooneysiinta domains, iyo set nameservers iyo auto-cusub.
Fiiri DukumentiyadaSamee DNS gobolada iyo abuuro, cusbooneysiiyo iyo tirtirto A, A, CNAME, MX, TXT, SRV, CAA iyo diiwaanada kale.
Fiiri DukumentiyadaLiiska meelaha la heli karo si ay u isticmaalaan server.
Fiiri DukumentiyadaSoo celinta xisaabta profile iyo API token macluumaad. Ogaan waxa xisaabta a token ku saabsan iyo hubi xaqeeda.
Fiiri DukumentiyadaJiid miisaaniyadaada la xiriira, soo jeedinta, guddiga iyo lacagaha ku soo warbixintaada, bedelka settings lacag iyo codsiga lacagaha.
Fiiri DukumentiyadaAPI sidoo kale waxay leedahay endpoints u adeegsiga app (/api/v1/deploy-configs/ iyo /api/v1/deployments/). Waxayna aan lagu sharaxay bogaggaan weli; ka soo horjeedka interactive liiska endpoint kasta, ka soo baxay API nool.
Fur API-ga isdhexgalkaHaddii aad qabtid su'aalo ama aad u baahan tahay caawimaad ku saabsan API-ga, fadlan ha ka waaban inaad nala soo xiriirto: