VPS serverlərini, domenlərini, DNS-i, ehtiyat nüsxələrini və daha çoxunu idarə etmək üçün tam REST API sənədləri.
VPS.org API, serverlər, domenlər, DNS qeydləri, ehtiyat nüsxələr və anlıq görüntülər daxil olmaqla, VPS hostinq infrastrukturunuzun bütün aspektlərini proqramlı şəkildə idarə etməyə imkan verir.
Bütün API sorğuları Bearer tokenindən istifadə edərək identifikasiya tələb edir. API tokeninizi hesab parametrlərinizdən yarada bilərsiniz. 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);Hər bir token servers:list ya da dns:* kimi öz icazələrini daşıyır. Tokenin sahib olmadığı icazə tələbi 403 və eksik icazəni adlandıran required_permission sahəsi ilə rədd edilir. İmkanlar
Tanınan tələblər hesab başına saatda 1000 ilə məhdudlaşır. Tanınılmayan tələblər IP ünvanı başına saatda 100 ilə məhdudlaşır. Bu həddi keçən tələblər gözləmə saniyələrinin sayını verən Retry-After başlığı ilə 429 alır. Müvəffəqiyyətli cavablar üçün heç bir sürət həddi başlığı göndərilmir.
Siyahının son nöqtələri say, sonrakı, əvvəlki və nəticələrlə, səhifə başına 25 əşya ilə bir cismi geri qaytarır. Səhifə arasında hərəkət etmək üçün səhifəni keç, ya da səhifə boş olana qədər sonrakı URL-ni izlə. Vericilər siyahısı page_size-ni də qəbul edir, 100-ə qədər.
{
"count": 84,
"next": "https://admin.vps.org/api/v1/backups/?page=2",
"previous": null,
"results": [ ... ]
}API, uğur və ya uğursuzluğu göstərmək üçün standart HTTP status kodlarından istifadə edir:
| Status Kodu | İzahat |
|---|---|
200 |
Uğurlu - Sorğu uğurla tamamlandı |
201 |
Yaradıldı - Resurs uğurla yaradıldı |
400 |
Yanlış Sorğu - Yanlış parametrlər və ya səhv formalı sorğu |
202, 204 |
Qəbul edilmiş və növbəyə qoyulmuş (202) ya da cavab bədəni olmadan silinmiş (204) |
402 |
Ödəniş tələb olunur: faylda ödəniş üsulu yoxdur, ödənilməyən faturalar, ya da kart əvvəlcədən icazəsi rədd edilmişdir |
403 |
Yasaq: token yox, səhv, ya da vaxtı keçmişdir, ya da lazımi icazəsi yoxdur. Tanıtma bacarılmadıqda 401 deyil, 403 geri qaytarılır. |
404 |
Tapılmadı - Resurs mövcud deyil |
409 |
Mübahisə: məsələn, artıq baş verən bir ölçü dəyişikliyi, kifayət qədər həcm yox, ya da artıq işləyən bir dağıtma |
429 |
Çoxlu Sorğu - Qiymət limiti aşıldı |
500 |
Daxili Server Xətası - Bizim tərəfimizdən nəsə səhv getdi |
503 |
Xidmət mövcud deyil: müvəqqəti problem. Yenidən sına, göndərildikdə Retry-After'i qəbul et. |
Xəta bədənləri JSON-dur. Çoxları bir məlumat sahəsi və ya xəta sahəsi, bəzən ismarışla birlikdə var; təsdiq xətaları sahənin adı ilə problemləri siyahıya alır.
API sənədlərimizə kateqoriya üzrə baxın:
Vericiləri yaradın, yoxlayın, gücləndirin, ölçüsünü dəyişdirin və silin, root şifrəsini yenidən qoyun, əks DNS-i qurun, əmrləri yerinə yetirin və SSH açarlarını idarə edin.
Sənədlərə baxınVerici zəmanət nüsxələrini göstər, yeni zəmanət nüsxəsini başlat və zəmanət nüsxəsindən vericini bərpa et.
Sənədlərə baxınVericinin etiketli şəkillərini götür, siyahıya al və sil.
Sənədlərə baxınMövcud VPS planları və qiymət məlumatlarını əldə edin. Resurslar, qiymətlər və mövcudluq haqqında ətraflı məlumat əldə edin.
Sənədlərə baxınUbuntu, Debian, Rocky Linux, CentOS Stream, Fedora və Alpine kimi quraşdıra biləcəyiniz əməliyyat sistemləri və versiyaları siyahıya al.
Sənədlərə baxınDomenlərin mövcudluğunu yoxlayın, qeyd edin və yeniləyin, ad vericilərini və avtomatik yeniləməni təyin edin.
Sənədlərə baxınDNS zonaları yaradın və onların A, A, CNAME, MX, TXT, SRV, CAA və digər qeydlərini yaradın, yeniləyin və silin.
Sənədlərə baxınHesab profili və API token məlumatını əldə et. Tokenin hansı hesaba aid olduğunu müəyyən et və onun icazələrini yoxla.
Sənədlərə baxınSizin tərəfdaş balansınız, tövsiyyələr, komissiyalar və ödənişləri öz hesabatınıza çəkin, ödəniş qurğularını dəyişdirin və ödənişləri tələb edin.
Sənədlərə baxınAPI tətbiqetmə işə salınması üçün son nöqtələri də var (/api/v1/deploy-configs/ və /api/v1/deployments/). Onlar bu səhifələrdə hələlik təsvir edilmir; interaktiv istinad canlı API-dən yaradılan hər son nöqtəni siyahıya alır.
Interaktiv API istinadını açAPI ilə bağlı suallarınız varsa və ya köməyə ehtiyacınız varsa, zəhmət olmasa, bizimlə əlaqə saxlamaqdan çəkinməyin: