VPS.org API

REST API dokumentācija

Domēna API

Meklē pieejamās domēna vardas, reģistrē un atjauno domēnus, pārvalda to vārdu serverus un automātiski atjauno. Domēni tiek identificēti pēc to uuid.

Galapunkti 7
Bāzes ceļš /api/v1/domains
IEGŪT /api/v1/domains/

Uzskaitīt visus domēnus

Atgriež domēni reģistrēti jūsu kontā, 25 par lapu. Sarakstam nav filtru.

Nepieciešamā atļauja: domains:list

Pieprasījuma piemērs

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);

Atbildes piemērs

{
  "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"
    }
  ]
}

Atbildes lauki

Lauks Tips Apraksts
uuid string Domēna identifikators, ko izmanto citos domēna mērķa punktos
status string active, pending, expired, cancelled, transferred
registrar string Sekretārs domēns tiek turēts
registration_date, expiration_date datetime Kad domēns tika reģistrēts un kad tas beidzas. derīguma termiņš var būt nulle.
days_until_expiration integer | null Visas dienas līdz derīguma termiņa beigām, negatīvs pēc derīguma termiņa beigām
is_expired, needs_renewal_soon boolean Vai domēna darbības termiņš ir beidzies un vai tā derīguma termiņš beidzas nākamo 30 dienu laikā
auto_renew, renewal_period_years boolean, integer Vai domēns tiek automātiski atjaunots, un cik gadu
registration_price, renewal_price string Cenas USD decimāldaļās
whois_privacy, transfer_lock boolean WHOIS privātuma un reģistrara transfera slēdzenes iestatījumi
nameserver1 to nameserver4 string | null Domēna vārdu serveri
created_at, updated_at datetime When the record was created and last changed (ISO 8601, UTC)
IEGŪT /api/v1/domains/{uuid}/

Iegūst domēna detaļas

Atgriež vienu domēna objektu ar laukiem.

Nepieciešamā atļauja: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Atbildes statusa kodi

200 Panākumi
404 Nav atrasts, vai arī tas pieder citam kontam
POSMS /api/v1/domains/search/

Meklēšanas domēna pieejamība

Pārbauda, vai nosaukums ir pieejams aptuveni 20 populārs paplašinājumi (com, neto, org, io, dev, co, app, ai un vairāk), plus paplašinājums jums ierakstīja, ja tas nav starp tiem. Rezultāti sākas ar precīzu spēli, tad pieejami nosaukumi, tad ņem tos.

Nepieciešamā atļauja: domains:search

Pieprasījuma pamatteksta parametri

Parametrs Tips Obligāti Apraksts
domain string Jā Nosaukums ar vai bez paplašinājuma, piemēram, mysite vai mysite.com (2 līdz 63 rakstzīmes)

Pieprasījuma piemērs

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"])

Atbildes piemērs

{
  "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
}

Cenas ir USD numuri vienu gadu un nav pieejami nosaukumi. Cenas parādītas ilustratīvi.

Atbildes statusa kodi

200 Panākumi
400 Trūkst domēna, vai tas satur rakstzīmes, kas nav burti, cipari un hifeni
500 Reģistrāra meklēšana neizdevās. Mēģināt vēlāk.
POSMS /api/v1/domains/register/

Reģistrēt jaunu domēnu

Reģistrē jūsu saglabāto maksājumu veidu un domēnu. Pieejamība un cena tiek pārbaudīta ar reģistratoru, pirms maksas. Reģistrētāja kontaktinformācija tiek ņemta no jūsu konta profila. Ja reģistrētājs noraida reģistrāciju pēc maksas, maksājums tiek atmaksāts.

Nepieciešamā atļauja: domains:register (piešķir domēni:*)

Pieprasījuma pamatteksta parametri

Parametrs Tips Obligāti Apraksts
domain string Jā Pilns domēna nosaukums, ieskaitot tā paplašinājumu, piemēram.com
years integer Nē Reģistrācijas periods 1 līdz 10 (noklusējums 1). Cena ir gada cenas laiki gadiem..ai prasa vismaz 2 gadi; mazāka vērtība atgriež 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}'

Atbildes piemērs

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

Atbildes statusa kodi

201 Reģistrēts domēns
400 Nederīgs domēns, domēns vairs nav pieejams, cenu nevarēja pārbaudīt, novecojusi maksājumu metode, vai maksājums neizdevās
402 Nav maksājuma metodes lietā, vai neapmaksāti rēķini
500 Maksājumu nevar apstrādāt, vai reģistrators noraidīja reģistrāciju pēc maksājuma. Otrajā gadījumā kļūdas ziņojums saka, vai kompensācija izgāja cauri.
POSMS /api/v1/domains/{uuid}/renew/

Atsvaidzināt domēnu

Atjauno domēnu un maksā tās retrocesion_cena par katru gadu jūsu saglabāto maksājumu metodi.

Nepieciešamā atļauja: domains:renew

Pieprasījuma pamatteksta parametri

Parametrs Tips Obligāti Apraksts
years integer Nē Pievienojamie gadi, 1 līdz 10 (noklusējums 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)!"
}

Atbildes statusa kodi

200 Domēns atjaunots
400 Nederīgi gadi, nav pārreģistrācijas cenu par domēnu, nav izmantojama maksājumu metode, vai maksājums nav izdevies
404 Nav atrasts, vai arī tas pieder citam kontam
500 Maksājumu nevarēja apstrādāt, vai maksājums izgāja cauri, bet reģistra atjaunošanas neizdevās. Kontaktu atbalstu šajā gadījumā.
PUT /api/v1/domains/{uuid}/nameservers/

Atjaunināt nosaukumusCervers

Iestata domēna vārdu serveras pie reģistrara un atgriež atjaunoto domēna objektu. Lai pārvaldītu DNS ar DNS API, izmantojiet ns1.vps.org, ns2.vps.org un ns3.vps.org un izveidojiet domēna zonu.

Nepieciešamā atļauja: domains:update

Pieprasījuma pamatteksta parametri

Parametrs Tips Obligāti Apraksts
nameserver1 string Jā Primārais vārdu servera datora nosaukums
nameserver2, nameserver3, nameserver4 string Nē Papildus nosaukumu servera datora nosaukums
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"}'

Atbildes statusa kodi

200 Vārdu serveris atjaunots; ķermenis ir domēna objekts
400 nav vārdu servera1
404 Nav atrasts, vai arī tas pieder citam kontam
500 Atjauninājums neizdevās; iestādei ir kļūdas un ziņojumu lauki
PUT /api/v1/domains/{uuid}/auto-renew/

Ieslēgt vai izslēgt automātisku atjaunošanu

Iestata_ renew un atgriež atjaunoto domēna objektu. Sūta ieslēgtu kā JSON boolean: jebkura netukša virkne, ieskaitot rindu melnumu, pārvērš automātiski atjaunot.

Nepieciešamā atļauja: 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}'

Atbildes statusa kodi

200 Iestatīšana saglabāta; ķermenis ir domēna objekts
400 ieslēgts nav
404 Nav atrasts, vai arī tas pieder citam kontam

Piezīmes