VPS.org API

REST API құжаттамасы

Домендер API

Бар домен атауларын іздеу, домендерді тіркеу мен жаңарту, атау серверлерін және автоматты жаңартуды басқару. Домендер uid- і бойынша анықталады.

Соңғы нүктелер 7
Негізгі жол /api/v1/domains
АЛУ /api/v1/domains/

Барлық домендерді тізімдеу

Тіркелгіңізге тіркелген домендер тізімі, бір бетке 25- те. Тізімінде сүзгілер жоқ.

Рұқсат керек: domains:list

Мысал сұрау

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);

Мысал жауап

{
  "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"
    }
  ]
}

Жауап өрістері

Өріс Түрі Сипаттамасы
uuid string Басқа домендердің соңында қолданылатын домен идентификаторы
status string active, pending, expired, cancelled, transferred
registrar string Доменнің тіркелгісі
registration_date, expiration_date datetime Доменнің тіркелу және мерзімі біту уақыты. expiration_ date деген нөл болуы мүмкін.
days_until_expiration integer | null Ескіру_ күніне дейінгі күндер саны, ескіргеннен кейін теріс
is_expired, needs_renewal_soon boolean Доменнің мерзімі біткен немесе келесі 30 күн ішінде біткендігін
auto_renew, renewal_period_years boolean, integer Доменнің автоматты түрде жаңартылуы және қанша жылға
registration_price, renewal_price string Ақша бірлігі: доллар
whois_privacy, transfer_lock boolean WHOIS құпиялылығы мен регистрдің тасымалдау бұғатын орнату
nameserver1 to nameserver4 string | null Доменнің атау серверлері
created_at, updated_at datetime Жазбаның құрылған және соңғы өзгертілген уақыты (ISO 8601, UTC)
АЛУ /api/v1/domains/{uuid}/

Доменнің егжей- тегжейін алу

Returns one domain object with the fields above.

Рұқсат керек: domains:list

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

Жауап күйінің кодтары

200 Сәтті
404 Табылмады, немесе басқа тіркелгіге тиесілі
ХАБАРЛАМА /api/v1/domains/search/

Доменнің қолжетімділігін іздеу

Атау 20- дан астам танымал жұрнақтардың (com, net, org, io, dev, co, app, ai және т. б.) ішінде бар ма, жоқ па, соны тексереді. Нәтижелер сәйкесті атаулармен басталып, бар атаулармен аяқталады, сосын қолданыстағы атаулармен басталады.

Рұқсат керек: domains:search

Сұрау мәтінінің параметрлері

Параметрлер Түрі Қажетті Сипаттамасы
domain string Иә Жолданбаның атауы, жұрнағымен не жоқ, мысалы, mysite немесе mysite. com (2- ден 63- ке дейін таңба)

Мысал сұрау

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"])

Мысал жауап

{
  "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
}

Бағалар бір жылға АҚШ долларында көрсетілген, ал қол жеткізбейтін атаулар үшін нөл. Көрсетілген бағалар тек түсіндіру үшін.

Жауап күйінің кодтары

200 Сәтті
400 Домен жоқ немесе ол әріптер, цифрлар және үтірден басқа таңбаларды қамтиды
500 Регистраторды іздеу жаңылысы. Кейін қайталап көріңіз.
ХАБАРЛАМА /api/v1/domains/register/

Жаңа доменді тіркеу

Доменді тіркеу және сақталған төлем әдісіңізді есептеу. Қолжетімділігі мен бағасы төлемді есептеу алдында қайтадан регистратормен тексеріледі. Регистратордың қатынасу мәліметі тіркелгі профиліңізден алынады. Егер регистратор төлемді есептеген соң тіркеуді қабылдамаса, төлем қайтарылады.

Рұқсат керек: domains:register (домендер берген: *)

Сұрау мәтінінің параметрлері

Параметрлер Түрі Қажетті Сипаттамасы
domain string Иә Толық домен атауы, жұрнағымен бірге, мысалы example. com
years integer Жоқ Регистрация мерзімі, 1- ден 10- ға дейін (әдеттісі 1). Бағасы жылдық бағаны жылдарға көбейту..ai кемінде 2 жыл қажет, одан кіші мәні 400 қайтарады.
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}'

Мысал жауап

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

Жауап күйінің кодтары

201 Домен тіркелген
400 Жарамсыз домен, домен енді қолжетімді емес, баға тексерілмеді, төлем әдісі ескірген, немесе төлем қатесі
402 Файлдағы төлем әдісі жоқ, немесе төленбеген шот-фактуралар
500 Төлемді орындау мүмкін болмады, немесе регистратор төлемді қабылдамады. Екінші жағдайда, қате туралы хабарлама қайтару сәтті болғанын көрсетеді.
ХАБАРЛАМА /api/v1/domains/{uuid}/renew/

Доменді жаңарту

Доменді жаңарту және әрбір жыл үшін оның жаңарту_ бағасын сіздің сақталған төлем әдісіңізге есептеу.

Рұқсат керек: domains:renew

Сұрау мәтінінің параметрлері

Параметрлер Түрі Қажетті Сипаттамасы
years integer Жоқ Қосу үшін жыл, 1- ден 10- ге дейін (әдеттісі 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)!"
}

Жауап күйінің кодтары

200 Домен жаңартылған
400 Жарамсыз жыл, доменнің жаңарту бағасы жоқ, төлем әдісі қолданылмайды, немесе төлем қатесі
404 Табылмады, немесе басқа тіркелгіге тиесілі
500 Өтініштер қабылданбады, немесе төлем қабылданды, бірақ регистратор қайталауды тоқтатқан. Осы жағдайда қолдау қызметіне хабарласыңыз.
PUT /api/v1/domains/{uuid}/nameservers/

Атау серверлерін жаңарту

Доменнің атау серверлерін регистрде орнатып, жаңартылған домен нысанын қайтарады. DNS- ті DNS API арқылы басқару үшін, ns1. vps.org, ns2. vps.org және ns3. vps.org дегендерді қолданып, домен үшін аймақ құрыңыз.

Рұқсат керек: domains:update

Сұрау мәтінінің параметрлері

Параметрлер Түрі Қажетті Сипаттамасы
nameserver1 string Иә Негізгі атау серверінің хост атауы
nameserver2, nameserver3, nameserver4 string Жоқ Қосымша атау серверлерінің хост атаулары
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"}'

Жауап күйінің кодтары

200 Атау серверлері жаңартылған; денесі - домен нысаны
400 nameserver1 жоқ
404 Табылмады, немесе басқа тіркелгіге тиесілі
500 Жаңарту жаңылысы; бетінде қате мен хабарлама өрістері бар
PUT /api/v1/domains/{uuid}/auto-renew/

Автожаңартуды қосу не өшіру

auto_ renew дегенді орнатып, жаңартылған домен нысанын қайтарады. JSON логикалық мәні ретінде жіберу рұқсат етілген: кез келген бос емес жол, false деген жолды қоса алғанда, автожаңартуды қосады.

Рұқсат керек: 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}'

Жауап күйінің кодтары

200 Баптау сақталды; негізгі бөлігі - домен нысаны
400 рұқсат етілген жоқ
404 Табылмады, немесе басқа тіркелгіге тиесілі

Жазбалар