VPS.org API

Документация

Домендер API

Домендик аталыштарды издөө, домендерди каттоо жана жаңылоо, алардын ысым серверлерин жана автоматтык жаңылоону башкаруу. Домендер uuid менен аныкталат.

Аяктоо чекиттери 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 null болушу мүмкүн.
days_until_expiration integer | null expiration_date чейинки бүт күндөр, мөөнөтү бүткөндөн кийин терс
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}/

Домендин маалыматын алуу

Жогоруда көрсөтүлгөн талаалар менен бир домен объектин кайтарат.

Укуктар керек: 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/

Доменди жаңылоо

Доменди жаңылоо жана анын renewal_price суммасын ар бир жылга сактоодо төлөм ыкмасынан төлөө.

Укуктар керек: 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 Табылган жок же башка эсептик жазууга таандык

Заметки