VPS.org API

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 Кога доменот е регистриран и кога истекува. Датата на истекување може да биде нула.
days_until_expiration integer | null Цели денови до истекувањето на_ датумот, негативниот е еднаш истекува
is_expired, needs_renewal_soon boolean Дали доменот истече и истекува во следните 30 дена
auto_renew, renewal_period_years boolean, integer Дали доменот автоматски се обновува, и колку години
registration_price, renewal_price string Цените во USD како децимални низи
whois_privacy, transfer_lock boolean Поставувања за приватноста и регистрацијата на преносот
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
}

Цените се бројки во USD за една година и се нулти за имиња кои не се достапни.

Кодови за статус на одговор

200 Успех
400 Недостасува домен или содржи знаци кои не се букви, цифри и црти
500 Регистраторот не успеа. Повтори подоцна.
ПОСТ /api/v1/domains/register/

Регистрирај нов домен

Регистрира домен и наплаќања за вашиот зачуван начин на исплата. Достапноста и цената се проверуваат повторно со регистарот пред наплатата. Податоците за контакти со регистарот се земени од профилот на вашата сметка. Ако регистарот ја одбие регистрацијата по наплатата, исплатата се враќа.

Неопходна дозвола: domains:register (доделен од домени:*)

Параметри на телото на барањето

Параметр Тип Задолжително Опис
domain string Да Целото име на доменот вклучувајќи го и неговото проширување, на пример. 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 Не. Дополнителни имињаservernames
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 имесервер1 недостасува
404 Не е пронајдено или припаѓа на друга сметка
500 Ажурирањето не успеа; телото има полиња за грешки и пораки
PUT /api/v1/domains/{uuid}/auto-renew/

Вклучи самообновување или исклучување

Го поставува автоматски_ обновуваниот објект на доменот. Испрати го овозможено како JSON: секоја непразна низа, вклучувајќи ја и неточната низа, го вклучи автоматски обновуваното.

Неопходна дозвола: 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 Не е пронајдено или припаѓа на друга сметка

Забелешки