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 დომენის რეგისტრაციის თარიღი და მისი ვადის გასვლის თარიღი. ვადის გასვლის თარიღი შეიძლება იყოს ნული.
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
}

ფასი არის ციფრები USD ერთი წლის განმავლობაში და არის ნული სახელებისთვის, რომლებიც არ არის ხელმისაწვდომი. ნაჩვენები ფასი არის ილუსტრაციული.

პასუხის სტატუსის კოდები

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- ის მართვისთვის 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 ბულეინის სახით გაგზავნა: ნებისმიერი ცარიელი სტრიქონი, მათ შორის სტრიქონი 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 ვერ მოიძებნა, ან სხვა ანგარიშს ეკუთვნის

შენიშვნები