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 Тоонууд
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/

Тогтмол нэрийн сервер

Доменийн нэрийн серверийг бүртгэлд тохируулж шинэчлэгдсэн домен объектыг буцаана. 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 Тооны серверүүд шинэчлэгдсэн; бие нь домен объект
400 нэр сервер1 алга
404 Олдоогүй эсвэл өөр дансанд хамаарна
500 Шинэчлэх бүтэлгүйтлээ. Үгний дотор алдаа болон мэдээний талбарууд байна
PUT /api/v1/domains/{uuid}/auto-renew/

Авто шинэчлэлийг идэвхжүүлэх эсвэл идэвхгүй болгох

Авто_ шинэчлэх-ийг тохируулж шинэчлэгдсэн домен объектыг буцаана. JSON boolean-оор илгээнэ: ямар ч хоосон биш мөр, 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 Setting saved; the body is the domain object
400 идэвхжүүлсэн
404 Олдоогүй эсвэл өөр дансанд хамаарна

Сэтгэгдэл