VPS.org API

REST API sənədləşdirilməsi

Domenlər

Var olan domen adlarını axtarın, domenləri qeyd edin və yeniləyin, ad vericilərini idarə edin və avtomatik yeniləməni idarə edin. Domenlər öz uuid-ləri ilə təsnif edilir.

Son Nöqtələr 7
Əsas Yol /api/v1/domains
AL /api/v1/domains/

Bütün Domenləri Siyahıya Alın

Hesabınızda qeydiyyatdan keçmiş domenləri geri qaytarır, səhifə başına 25. Siyahıda filtr yoxdur.

İcazə tələb olunur: domains:list

Nümunə Sorğu

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/domains/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/domains/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for domain in response.json()["results"]:
    print(domain["domain_name"], domain["status"], domain["expiration_date"])
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

Nümunə Cavab

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
      "domain_name": "example.com",
      "status": "active",
      "registrar": "dynadot",
      "registration_date": "2026-01-15T10:30:00Z",
      "expiration_date": "2027-01-15T10:30:00Z",
      "days_until_expiration": 122,
      "is_expired": false,
      "needs_renewal_soon": false,
      "auto_renew": true,
      "renewal_period_years": 1,
      "registration_price": "12.64",
      "renewal_price": "12.64",
      "whois_privacy": true,
      "nameserver1": "ns1.vps.org",
      "nameserver2": "ns2.vps.org",
      "nameserver3": "ns3.vps.org",
      "nameserver4": null,
      "transfer_lock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-09-01T08:12:40Z"
    }
  ]
}

Cavab Sahələri

Sahə Növü İzahat
uuid string Digər domen son nöqtələri üçün istifadə edilən domen identifikatoru
status string active, pending, expired, cancelled, transferred
registrar string Domenin saxlandığı qeydiyyatçı
registration_date, expiration_date datetime Domenin qeydə alındığı və vaxtı bitdiyi vaxt. expiration_date null ola bilər.
days_until_expiration integer | null bitmə_tarixinə qədər bütün günlər, bitdikdən sonra mənfi
is_expired, needs_renewal_soon boolean Domenin vaxtı keçib-keçmədiyini və növbəti 30 gün ərzində vaxtı keçib-keçmədiyini göstər
auto_renew, renewal_period_years boolean, integer Domenin avtomatik olaraq yenilənməsi və neçə il üçün
registration_price, renewal_price string Qiymətlər onluq string olaraq USD
whois_privacy, transfer_lock boolean WHOIS məxfilik və qeydçi köçürmə qıfıl qurğuları
nameserver1 to nameserver4 string | null Domen ad vericiləri
created_at, updated_at datetime Qeyd yaradıldığı və son dəyişdirildiyi vaxt (ISO 8601, UTC)
AL /api/v1/domains/{uuid}/

_Domen Məlumatlarını Al

Üstdəki sahələr ilə bir domen cismi geri qaytarır.

İcazə tələb olunur: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Cavab Status Kodları

200 Müvəffəqiyyət
404 Tapılmadı ya da başqa hesaba aiddir
POST /api/v1/domains/search/

Domenin mövcudluğunu axtar

Adın 20 populyar uzantıda (com, net, org, io, dev, co, app, ai və daha çox) mövcud olub olmadığını yoxlayır, əlavə olaraq daxil etdiyiniz uzantının bu uzantıların arasında olmamasını da. Nəticələr tam uyğunluqla başlayır, sonra mövcud adlar, sonra da istifadə olunanlar.

İcazə tələb olunur: domains:search

Əsas Parametrləri Sorğu

Parametrlər Növü Tələb olunur İzahat
domain string Bəli Əlavə ilə ya da olmadan bir ad, məsələn mysite ya da mysite.com (2-dən 63-ə qədər xarakter)

Nümunə Sorğu

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/domains/search/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.com"}'
import requests

url = "https://admin.vps.org/api/v1/domains/search/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"domain": "mysite.com"})
for result in response.json()["results"]:
    if result["available"]:
        print(result["domain"], result["registration_price"], result["renewal_price"])

Nümunə Cavab

{
  "results": [
    {
      "domain": "mysite.com",
      "available": false,
      "price": null,
      "registration_price": null,
      "renewal_price": null,
      "tld": "com",
      "is_exact_match": true
    },
    {
      "domain": "mysite.dev",
      "available": true,
      "price": 17.24,
      "registration_price": 17.24,
      "renewal_price": 17.24,
      "tld": "dev",
      "is_exact_match": false
    }
  ],
  "base_domain": "mysite",
  "search_count": 20
}

Qiymətlər bir il üçün dollarla göstərilir və mövcud olmayan adlar üçün null hesab edilir. Göstərilən qiymətlər təsviredicidir.

Cavab Status Kodları

200 Müvəffəqiyyət
400 Kağızda olmayan domen, ya da hərf, rəqəm və ya sıfırlardan başqa xarakterlər var
500 Qeydiyyatçı axtarışı bacarılmadı. Sonra yenidən cəhd edin.
POST /api/v1/domains/register/

Yeni Domen Qeydiyyatı

Domeni qeyd edir və qeyd etdiyiniz ödəniş üsulunu ödəyir. Üzvlük və qiymət ödənişdən əvvəl qeydçi ilə yenidən yoxlanır. Qeydçi ilə əlaqə məlumatları hesab profilinizdən alınır. Əgər qeydçi ödənişdən sonra qeydi rədd edərsə, ödəniş geri qaytarılır.

İcazə tələb olunur: domains:register (domenlər tərəfindən verilmiş:*)

Əsas Parametrləri Sorğu

Parametrlər Növü Tələb olunur İzahat
domain string Bəli Domen adı, genişləndirmə daxil olmaqla, misal example.com
years integer _Yox Qeydiyyat müddəti, 1-dən 10-a qədər (öncəki 1). Qiymət illik qiymətə illər sayını qatla bərabərdir..ai ən azı 2 il tələb edir; kiçik dəyər 400 geri qaytarır.
curl -X POST "https://admin.vps.org/api/v1/domains/register/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.dev", "years": 1}'

Nümunə Cavab

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

Cavab Status Kodları

201 Domenin qeyd edildiyi
400 Səhv domen, domen artıq mövcud deyil, qiymət təsdiq edilə bilmədi, köhnə ödəniş üsulu, ya da ödəniş bacarılmadı
402 Faylda ödəniş üsulu yoxdur, ya da ödənilməyən faturalar var
500 Ödəniş həyata keçirilə bilmədi, ya da qeydiyyatçı ödənişdən sonra qeydiyyatı rədd etdi. İkinci halda xəta ismarışı geri qaytarmanın başa çatdığını bildirir.
POST /api/v1/domains/{uuid}/renew/

Domeni Yenilə

Domeni yenilə və hər il üçün yeniləmə_qiymətini qeyd etdiyiniz ödəniş üsulu ilə ödə.

İcazə tələb olunur: domains:renew

Əsas Parametrləri Sorğu

Parametrlər Növü Tələb olunur İzahat
years integer _Yox 1-dən 10-a qədər əlavə ediləcək illər (öncəki 1)
curl -X POST "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"years": 1}'
{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "new_expiration": "2028-01-15T10:30:00+00:00",
  "message": "example.com renewed successfully for 1 year(s)!"
}

Cavab Status Kodları

200 Domenin yenilənməsi
400 Səhv illər, domen üçün yeniləmə qiyməti yoxdur, istifadə edilə bilən ödəniş üsulu yoxdur, ya da ödəniş bacarılmadı
404 Tapılmadı ya da başqa hesaba aiddir
500 Ödəniş həyata keçirilə bilmədi, ya da ödəniş keçdi amma qeydçi yeniləməsi bacarılmadı. Bu halda dəstəklə əlaqə saxlayın.
PUT /api/v1/domains/{uuid}/nameservers/

Ad Vericiləri

Domenin ad vericilərini qeydiyyatçıda quraşdırır və yenilənmiş domen cismini geri qaytarır. DNS-i DNS API ilə idarə etmək üçün ns1.vps.org, ns2.vps.org və ns3.vps.org istifadə edin və domen üçün bir zona yaradın.

İcazə tələb olunur: domains:update

Əsas Parametrləri Sorğu

Parametrlər Növü Tələb olunur İzahat
nameserver1 string Bəli Əsas ad verici qovşaq adı
nameserver2, nameserver3, nameserver4 string _Yox Əlavə ad vericiləri
curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/nameservers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nameserver1": "ns1.vps.org", "nameserver2": "ns2.vps.org", "nameserver3": "ns3.vps.org"}'

Cavab Status Kodları

200 Ad vericiləri yeniləndi; bədən domen cismidir
400 nameserver1 yoxdu
404 Tapılmadı ya da başqa hesaba aiddir
500 Yeniləmə bacarılmadı; bədən xəta və ismarış sahələri var
PUT /api/v1/domains/{uuid}/auto-renew/

Avtomatik Yeniləməni Fəal/Qapalı Et

auto_renew qur və yenilənmiş domen cismini geri qaytar. JSON boolean olaraq göndərmək fəallaşdırılmışdır: boş olmayan hər hansı string, string false daxil olmaqla, auto-renew'i işə salır.

İcazə tələb olunur: domains:update

curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/auto-renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Cavab Status Kodları

200 Qurğular qeyd olundu; bədən domen cismidir
400 fəallaşdırılmış
404 Tapılmadı ya da başqa hesaba aiddir

Qeydlər