VPS.org API

REST API dokumentacija

Sritys API

Ieškokite prieinamų domenų vardų, registruokite ir atnaujinkite domenus, tvarkykite jų vardų serverius ir automatinius atnaujinimus. Domenas identifikuojamas pagal jų uuid.

Galutiniai taškai 7
Bazinis kelias /api/v1/domains
GAUTI /api/v1/domains/

Išvardinti visus domenus

Grįžta į paskyrą užregistruotus domenus, 25 per puslapį. Sąrašas neturi filtrų.

Reikalingas leidimas: domains:list

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas Tipas Aprašymas
uuid string Kitose domeno vertinamosiose baigtise naudojamas domeno identifikatorius
status string active, pending, expired, cancelled, transferred
registrar string Registruoti domeną
registration_date, expiration_date datetime Kai domenas buvo užregistruotas ir kai jis baigiasi. galiojimo pabaigos_date gali būti nulinės.
days_until_expiration integer | null Visos dienos iki galiojimo pabaigos, neigiamos pasibaigus
is_expired, needs_renewal_soon boolean Ar domeno domeno darbas pasibaigė ir ar jis baigsis per ateinančias 30 dienų
auto_renew, renewal_period_years boolean, integer Ar domenas atnaujinamas automatiškai, ir kiek metų
registration_price, renewal_price string Kainos JAV doleriais dešimtainėmis eilutėmis
whois_privacy, transfer_lock boolean WHOIS privatumo ir registratūros perdavimo užrakto nustatymai
nameserver1 to nameserver4 string | null Domeno vardų serveriai
created_at, updated_at datetime Įrašas buvo sukurtas ir paskutinį kartą pakeistas (ISO 8601, UTC)
GAUTI /api/v1/domains/{uuid}/

Gauti domeno informaciją

Grąžina vieną domeno objektą su laukeliais virš.

Reikalingas leidimas: domains:list

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

Atsakymo būsenos kodai

200 Sėkmė
404 Nerasta, arba ji priklauso kitai paskyrai
Potvarkis /api/v1/domains/search/

Ieškoti domeno prieinamumo

Patikrina, ar pavadinimas yra prieinamas apie 20 populiarių plėtinių (com, neto, org, io, dev, co, app, ai ir daugiau), plius plėtinys jums įvestą jei jis nėra tarp jų. Rezultatai prasideda su tiksliu atitikimą, tada prieinamas pavadinimus, tada paimti tie.

Reikalingas leidimas: domains:search

Užklausos turinio parametrai

Parametras Tipas Privaloma Aprašymas
domain string Taip Pavadinimas su plėtiniu arba be jo, pvz., mysite or myste.com (2-63 simboliai)

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Vienerius metus kainos yra USD ir nėra už pavadinimus, kurie nėra prieinami. Pateikiamos kainos yra iliustracinės.

Atsakymo būsenos kodai

200 Sėkmė
400 Trūksta domeno, arba jame yra simbolių, išskyrus raides, skaičius ir hifenus
500 Registrarų paieška nepavyko. Bandyti vėliau.
Potvarkis /api/v1/domains/register/

Registruoti naują domeną

Registruotojas užregistruoja domeną ir įtraukia į apskaitą savo įrašus. Prieinamumas ir kaina vėl patikrinami registratoriumi prieš tai, kai imamas mokestis. Registruotojas iš Jūsų sąskaitos profilio gauna kontaktinius duomenis. Jei registratorius po mokesčio registracijos atmeta, mokėjimas grąžinamas.

Reikalingas leidimas: domains:register (srityse:*)

Užklausos turinio parametrai

Parametras Tipas Privaloma Aprašymas
domain string Taip Visas domeno pavadinimas, įskaitant jo plėtinį, pavyzdžiui.com
years integer Nr. Registracijos laikotarpis nuo 1 iki 10 (numatyta 1). Kaina yra metinė kaina laikai metai..ai reikia ne mažiau kaip 2 metų; mažesnė vertė grąžinama 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}'

Atsakymo pavyzdys

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

Atsakymo būsenos kodai

201 Registruotas domenas
400 Netinkamas domenas, domeno nebėra, kaina negalėjo būti patikrinta, pasenęs mokėjimo būdas, arba mokėjimas nepavyko
402 Nėra mokėjimo būdo byloje, arba nesumokėtos sąskaitos faktūros
500 Mokėjimas negali būti tvarkomas, arba registratorius atmetė registraciją po mokėjimo. Antruoju atveju klaidos pranešimas sako, ar grąžinamoji išmoka buvo perkelta.
Potvarkis /api/v1/domains/{uuid}/renew/

Atnaujinti domeną

Atnaujina domeno ir mokesčiai jo renovation_price už kiekvienus metus jūsų išsaugotą mokėjimo būdą.

Reikalingas leidimas: domains:renew

Užklausos turinio parametrai

Parametras Tipas Privaloma Aprašymas
years integer Nr. Pridedant, 1-10 metų (numatyta 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)!"
}

Atsakymo būsenos kodai

200 Domenas atnaujintas
400 Netinkami metai, nėra atnaujinimo kaina už domeną, nėra naudojamas mokėjimo būdas, arba mokėjimas nepavyko
404 Nerasta, arba ji priklauso kitai paskyrai
500 Mokėjimas negali būti tvarkomas, arba mokėjimas buvo per, bet registratorius atnaujinimas nepavyko. Kontaktinė parama tuo atveju.
PUT /api/v1/domains/{uuid}/nameservers/

Atnaujinti vardų serverius

Nustato domeno vardų serverius registratūroje ir grąžina atnaujintą domeno objektą. Norėdami valdyti DNS su DNS API, naudokite ns1.vps.org, ns2.vps.org ir ns3.vps.org ir sukurkite domeno zoną.

Reikalingas leidimas: domains:update

Užklausos turinio parametrai

Parametras Tipas Privaloma Aprašymas
nameserver1 string Taip Pirminis vardų serverio vardas
nameserver2, nameserver3, nameserver4 string Nr. Papildomi vardų serverio pavadinimai
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"}'

Atsakymo būsenos kodai

200 Vardų serveriai atnaujinti; kūnas yra domeno objektas
400 trūksta vardų serverio1
404 Nerasta, arba ji priklauso kitai paskyrai
500 Atnaujinimas nepavyko; įstaiga turi klaidų ir pranešimų laukelius
PUT /api/v1/domains/{uuid}/auto-renew/

Įjungti arba išjungti automatinio atnaujinimo

Nustato automatinį_ atnaujinti ir grąžina atnaujintą domeno objektą. Siųsti įjungtas kaip JSON boolean: bet kokia netuščia eilutė, įskaitant klaidingą eilutę, automatiškai atnaujinama.

Reikalingas leidimas: 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}'

Atsakymo būsenos kodai

200 Nustatymas išsaugotas; kūnas yra domeno objektas
400 įjungtas trūkstamas
404 Nerasta, arba ji priklauso kitai paskyrai

Pastabos