VPS.org API

REST 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 Не. Допълнителни имена на сървъра
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 Не е намерено или принадлежи на друга сметка

Бележки