Domains API

Loetle kõik domeenid

Tagastab sinu kontole registreeritud domeenid, 25 lehekülje kohta. Nimekirjal pole filtreid.

Nõutav luba: domains:list

Näidistaotlus

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

Näidisvastus

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

Vastuseväljad

Domeeni üksikasjade hankimine

Tagastab ühe domeeniobjekti väljadega ülal.

Nõutav luba: domains:list

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

Vastuse olekukoodid

Otsingu domeeni kättesaadavus

Kontrollib, kas nimi on kättesaadav umbes 20 populaarse laiendi (com, net, org, io, dev, co, app, ai ja rohkem), pluss laiend, mille oled kirjutanud, kui see ei ole nende hulgas. Tulemused algavad täpse sobitusega, seejärel saadaval olevate nimede ja siis võetud laienditega.

Nõutav luba: domains:search

Taotluse sisu parameetrid

Näidistaotlus

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

Näidisvastus

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

Hinnad on ühe aasta kohta USA dollarites ja ei ole saadaval. Näidatavad hinnad on illustratiivsed.

Vastuse olekukoodid

Registreeri uus domeen

Registreerib domeeni ja võtab sinu salvestatud makseviisi. Saadavus ja hind kontrollitakse registripidajaga uuesti enne tasu. Registreerija kontaktandmed võetakse sinu kontoprofiilist. Kui registripidaja keeldub registreerimisest pärast tasu tasumist, tagastatakse makse.

Nõutav luba: domains:register (välja antud valdkondade kaupa:*)

Taotluse sisu parameetrid

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}'

Näidisvastus

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

Vastuse olekukoodid

Uuenda domeeni

Uuendab domeeni ja võtab selle uuendamise_hinna iga aasta kohta salvestatud makseviisi.

Nõutav luba: domains:renew

Taotluse sisu parameetrid

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)!"
}

Vastuse olekukoodid

Nimeserverite uuendamine

Määrab domeeni nimeserverid registripidaja juures ja tagastab uuendatud domeeniobjekti. DNS haldamiseks DNS- i DPI- ga kasuta ns1. vps.org, ns2. vps.org ja ns3. vps.org ning loo domeenile tsoon.

Nõutav luba: domains:update

Taotluse sisu parameetrid

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

Vastuse olekukoodid

Automaatne taaskäivitamine sisse või välja

Määrab _uuendab ja tagastab uuendatud domeeniobjekti. Saadab JSON- i boolaanina: iga mittetühi string, sealhulgas stringi väär, lülitab sisse automaatse uuendamise.

Nõutav luba: 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}'

Vastuse olekukoodid

Märkused

• API ei saa kustutada domeeni, edastada domeeni või muuta WHOIS privaatsust või ülekande lukk. Ülekanded ja kustutamine on saadaval juhtpaneelil admin.vps.org.
• DNS arvestust domeeni hallatakse DNS API. DNS-i halduse API