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 Երբ է դոմենը գրանցվել և երբ է այն ավարտվում։ expiration_date կարող է լինել null։
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 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-ում են և null են անվանումների համար, որոնք հասանելի չեն։ Դերասանական գները ցուցադրվում են օրինակների համար։

Պատասխանի կարգավիճակի կոդեր

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 Invalid domain, domain no longer available, price could not be verified, outdated payment method, or the payment failed
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 nameserver1 բացակայում է
404 Չգտնվեց կամ պատկանում է այլ հաշվին
500 Ավելացնելը ձախողվեց, մարմինը սխալ և հաղորդագրության դաշտեր ունի
PUT /api/v1/domains/{uuid}/auto-renew/

Ավտոմատ վերականգնումը միացնել կամ անջատել

Օգտագործում է 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 Փոխադրում պահպանված է, մարմինը դոմենի օբյեկտն է
400 անջատված
404 Չգտնվեց կամ պատկանում է այլ հաշվին

Ծանոթագրություններ