VPS.org API

REST API-dokumentation

API för domäner

Sök efter tillgängliga domännamn, registrera och förnya domäner, och hantera deras namnservrar och automatisk förnyelse. Domäner identifieras av deras uuid.

Slutpunkter 7
Basväg /api/v1/domains
FÅ /api/v1/domains/

Lista alla domäner

Returnerar domänerna registrerade på ditt konto, 25 per sida. Listan har inga filter.

Krav på tillstånd: domains:list

Exempelförfrågan

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

Exempelsvar

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

Svarsfält

Fält Typ Varuslag
uuid string Domänidentifiering som används i andra domänslutpunkter
status string active, pending, expired, cancelled, transferred
registrar string Registrator domänen hålls på
registration_date, expiration_date datetime När domänen registrerades och när den upphör att gälla. extence_date kan vara ogiltig.
days_until_expiration integer | null Hela dagar till utgångsdatum, minus när det gått ut
is_expired, needs_renewal_soon boolean Om domänen har gått ut och om den går ut inom de närmaste 30 dagarna
auto_renew, renewal_period_years boolean, integer Om domänen förnyas automatiskt och hur många år
registration_price, renewal_price string Priserna i USD som decimalsträngar
whois_privacy, transfer_lock boolean WHOIS inställningar för sekretess och registreringsöverföring
nameserver1 to nameserver4 string | null Domänens namnservrar
created_at, updated_at datetime När skivan skapades och senast ändrades (ISO 8601, UTC)
FÅ /api/v1/domains/{uuid}/

Hämta domändetaljer

Returnerar ett domänobjekt med fälten ovan.

Krav på tillstånd: domains:list

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

Svarsstatuskoder

200 Lyckades
404 Inte hittat, eller det tillhör ett annat konto
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/domains/search/

Tillgängliga sökdomäner

Kontrollerar om ett namn finns tillgängligt över cirka 20 populära tillägg (com, net, org, io, dev, co, app, ai och mer), plus tillägget du skrev om det inte är bland dem. Resultat börjar med exakt matchning, sedan tillgängliga namn, sedan tagna.

Krav på tillstånd: domains:search

Parametrar för begäran

Parameter Typ Nödvändig Varuslag
domain string Ja Ett namn med eller utan förlängning, till exempel mysite eller mysite.com (2 till 63 tecken)

Exempelförfrågan

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

Exempelsvar

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

Priserna är siffror i USD för ett år och är noll för namn som inte är tillgängliga. Priserna som visas är belysande.

Svarsstatuskoder

200 Lyckades
400 Saknas domän, eller innehåller andra tecken än bokstäver, siffror och bindestreck
500 The registrar lookup failed. Retry later.
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/domains/register/

Registrera ny domän

Registrerar en domän och debiterar din sparade betalningsmetod. Tillgänglighet och pris kontrolleras med registratorn igen precis före avgiften. Kontaktuppgifter till registranten hämtas från din kontoprofil. Om registratorn avvisar registreringen efter avgiften återbetalas betalningen.

Krav på tillstånd: domains:register (beviljas av domäner:*)

Parametrar för begäran

Parameter Typ Nödvändig Varuslag
domain string Ja Det fullständiga domännamnet inklusive dess förlängning, t ex.com
years integer Ej tillämpligt Anmälningsperiod, 1 till 10 (standard 1). Priset är den årliga pris gånger år..ai kräver minst 2 år; ett mindre värde returnerar 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}'

Exempelsvar

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

Svarsstatuskoder

201 Domänregistrerad
400 Ogiltig domän, domän inte längre tillgänglig, priset kunde inte verifieras, föråldrad betalningsmetod, eller betalningen misslyckades
402 Ingen betalningsmetod på fil eller obetald räkning
500 Betalningen kunde inte behandlas, eller registratorn avvisade registreringen efter betalning. I det andra fallet felmeddelandet står om återbetalningen gick igenom.
Från och med den 1 januari 2016 till och med den 31 december 2016 /api/v1/domains/{uuid}/renew/

Förnya ett domänområde

Förnyar domänen och debiterar dess förnyelsepris för varje år till din sparade betalningsmetod.

Krav på tillstånd: domains:renew

Parametrar för begäran

Parameter Typ Nödvändig Varuslag
years integer Ej tillämpligt År att lägga till, 1 till 10 (standard 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)!"
}

Svarsstatuskoder

200 Domänen förnyas
400 Ogiltiga år, inget förnyelsepris för domänen, ingen användbar betalningsmetod eller betalningen misslyckades
404 Inte hittat, eller det tillhör ett annat konto
500 Betalningen kunde inte behandlas, eller betalningen gick igenom men förnyelsen av registrar misslyckades. Kontakta supporten i så fall.
PUT /api/v1/domains/{uuid}/nameservers/

Uppdatera namnservrar

Ställer in domänens namnservrar vid registraren och returnerar det uppdaterade domänobjektet. För att hantera DNS med DNS- API:et, använd ns1.vps.org, ns2.vps.org och ns3.vps.org och skapa en zon för domänen.

Krav på tillstånd: domains:update

Parametrar för begäran

Parameter Typ Nödvändig Varuslag
nameserver1 string Ja Huvudnamnservervärddatornamn
nameserver2, nameserver3, nameserver4 string Ej tillämpligt Ytterligare namnservervärdnamn
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"}'

Svarsstatuskoder

200 Namnservrar uppdaterade; kroppen är domänobjektet
400 namnserver1 saknas
404 Inte hittat, eller det tillhör ett annat konto
500 Uppdateringen misslyckades. Organet har fel- och meddelandefält
PUT /api/v1/domains/{uuid}/auto-renew/

Aktivera automatisk förnyelse eller avstängning

Ställer in auto_reny och returnerar det uppdaterade domänobjektet. Skicka aktiverad som en JSON boolean: varje sträng som inte är tom, inklusive strängen som är falsk, vänder automatiskt på förnyelsen.

Krav på tillstånd: 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}'

Svarsstatuskoder

200 Ställa in sparad; kroppen är domänobjektet
400 aktiverad saknas
404 Inte hittat, eller det tillhör ett annat konto

Anmärkningar