VPS.org API

Ҳуҷҷатгузории REST 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 метавонад нуқсон бошад.
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}/

Гирифтани тафсилоти домен

Як объектро бо заминаҳои дар боло буда бар мегардонад.

Иҷозат лозим аст: 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/

Навсозии Nameservers

Серверҳои номи доменро дар қайдгиранда барпо мекунад ва объектҳои навшудаи доменро бармегардонад. Барои идоракунии DNS бо API- и DNS, 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 Nameservers навсозӣ шуд; бадани объект домени объект аст
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 Ё ки ёфт нашуд ё ба ҳисоби дигар тааллуқ дорад

Ёддоштҳо