VPS.org API

REST API skjölun

Domains API

Leita að tiltækum lénum, skrá og endurnýja lén, og stjórna nafnþjónum þeirra og sjálfvirkri endurnýjun.Lén eru auðkennd með uuid þeirra.

Endapunktar 7
Grunnslóð /api/v1/domains
FÁ /api/v1/domains/

Listi yfir öll lén

Sýnir lénin sem eru skráð á reikningnum þínum, 25 á síðu. Listinn hefur engar síur.

Nauðsynlegt leyfi: domains:list

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Field Tegund Lýsing
uuid string Lénakenni sem notað er í öðrum endapunktum léna
status string active, pending, expired, cancelled, transferred
registrar string Skráningaraðili lénsins er haldinn á
registration_date, expiration_date datetime Þegar lénið var skráð og þegar það rennur út. expiration_date getur verið null.
days_until_expiration integer | null Heilir dagar til gildistíma, neikvæðir þegar þeir renna út
is_expired, needs_renewal_soon boolean Hvort lénið hefur runnið út og hvort það rennur út á næstu 30 dögum
auto_renew, renewal_period_years boolean, integer Hvort lénið endurnýjast sjálfkrafa og í hve mörg ár
registration_price, renewal_price string Verð í USD sem tugakerfi
whois_privacy, transfer_lock boolean WHOIS persónuvernd og skrásetjaraflutningslásstillingar
nameserver1 to nameserver4 string | null Nafnþjónar lénsins
created_at, updated_at datetime Hvenær færslan var búin til og síðast breytt (ISO 8601, UTC)
FÁ /api/v1/domains/{uuid}/

Fá upplýsingar um lén

Skila einn lén hlut með sviðum hér að ofan.

Nauðsynlegt leyfi: domains:list

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

Kóðar fyrir svörunarstöðu

200 Velgengni
404 Fannst ekki, eða það tilheyrir öðrum reikningi
POST /api/v1/domains/search/

Leita að léni

Athugar hvort heiti sé tiltækt á um 20 vinsælum endingum (com, net, org, io, dev, co, app, ai og fleiri), auk viðbótar sem þú slóst inn ef hún er ekki á meðal þeirra. Niðurstöður byrja með nákvæmri samsvörun, síðan tiltækum nöfnum, síðan tekin nöfnum.

Nauðsynlegt leyfi: domains:search

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
domain string Já Nafn með eða án viðbótar, til dæmis mysite eða mysite.com (2 til 63 stafir)

Dæmi um beiðni

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

Dæmi um svar

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

Verð eru tölur í USD fyrir eitt ár og eru núll fyrir nöfn sem eru ekki í boði.Verð sem sýnd eru eru til skýringar.

Kóðar fyrir svörunarstöðu

200 Velgengni
400 Vantar lén, eða það inniheldur aðra stafi en bókstafi, tölustafi og bindeil
500 Leitin mistókst. Reyndu aftur seinna.
POST /api/v1/domains/register/

Skrá nýtt lén

Skráðir lén og gjaldfærir með þeim greiðslumáta sem þú hefur vistað. Tilboð og verð eru skoðuð hjá skrásetjaranum aftur rétt áður en gjaldfært er. Tengiliðaupplýsingar skrásetjarans eru teknar úr prófílnum þínum. Ef skrásetjari hafnar skráningunni eftir gjaldfærslu er greiðslunni skilað.

Nauðsynlegt leyfi: domains:register (gefið af lénum:*)

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
domain string Já Fullt lén með viðbótinni, til dæmis example.com
years integer Nei Skráningatímabil, 1 til 10 (sjálfgefið 1). Verðið er árlegt verð margfaldað með árum..ai þarf að minnsta kosti 2 ár; minni gildi skilar 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}'

Dæmi um svar

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

Kóðar fyrir svörunarstöðu

201 Lén skráð
400 Ógilt lén, lén ekki lengur í boði, verð var ekki hægt að staðfesta, úreltur greiðslumáti eða greiðsla mistókst
402 Engin greiðsluaðferð í skránni eða ógreiddar reikningar
500 Ekki var hægt að vinna úr greiðslunni eða skrásetjari hafnaði skráningu eftir greiðslu, í síðara tilvikinu kemur fram hvort endurgreiðsla hafi gengið í gegnum.
POST /api/v1/domains/{uuid}/renew/

Endurnýja lén

Endurnýjar lénið og innheimtir endurnýjunarverð fyrir hvert ár með vistaðri greiðsluaðferð þinni.

Nauðsynlegt leyfi: domains:renew

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
years integer Nei Ár til að bæta við, 1 til 10 (sjálfgefið 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)!"
}

Kóðar fyrir svörunarstöðu

200 Lén endurnýjað
400 Ógild ár, ekkert endurnýjunarverð fyrir lénið, enginn notanlegur greiðslumáti eða greiðslur mistókst
404 Fannst ekki, eða það tilheyrir öðrum reikningi
500 Ekki var hægt að vinna úr greiðslunni eða greiðslan fór í gegnum en endurnýjun skrásetjarans mistókst. Hafðu samband við þjónustudeild í því tilfelli.
PUT /api/v1/domains/{uuid}/nameservers/

Uppfæra nafnþjóna

Setja nafnþjóna lénsins hjá skrásetjaranum og skila uppfærðu léninu. Til að stjórna DNS með DNS API, notaðu ns1. vps.org, ns2. vps.org og ns3. vps.org og búðu til svæði fyrir lénið.

Nauðsynlegt leyfi: domains:update

Færibreytur beiðninnar

Breyta Tegund Nauðsynlegt Lýsing
nameserver1 string Já Nafn aðal nafnþjóns
nameserver2, nameserver3, nameserver4 string Nei Viðbótar nafnþjónar
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"}'

Kóðar fyrir svörunarstöðu

200 Nafnþjónar uppfærðir; líkaminn er lén hlutur
400 nameserver1 vantar
404 Fannst ekki, eða það tilheyrir öðrum reikningi
500 The update failed; the body has error and message fields
PUT /api/v1/domains/{uuid}/auto-renew/

Kveikja eða slökkva á sjálfvirkri endurnýjun

Setur auto_renew og skilar uppfærðu léninu. Send enabled as a JSON boolean: any non-empty string, including the string false, turns on auto-renew.

Nauðsynlegt leyfi: 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}'

Kóðar fyrir svörunarstöðu

200 Stilling vistuð; líkaminn er lén hlutur
400 virkjað vantar
404 Fannst ekki, eða það tilheyrir öðrum reikningi

Athugasemdir