VPS.org API

REST API- dokumentasjon

Domene- API

Søk etter tilgjengelige domenenavn, registrer og forny domener, og administrer navnetjenerne og forny automatisk. Domener identifiseres ved hjelp av uuid- en deres.

Endepunkter 7
Basissti /api/v1/domains
BLI /api/v1/domains/

List opp alle domener

Returnerer domenene som er registrert på kontoen din, 25 pr. side. Lista har ingen filtre.

Påkrevd tillatelse: domains:list

Eksempelforespørsel

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

Eksempelsvar

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

Svarfelt

Felt Type Beskrivelse
uuid string Domeneidentifikator brukt i de andre domeneendepunktene
status string active, pending, expired, cancelled, transferred
registrar string Registrar, domenet innehas i
registration_date, expiration_date datetime Når domenet ble registrert og utløper. EXPOSID_ date kan være null.
days_until_expiration integer | null Hele dager fram til utløpsdatoen, negativ en gang utløpt
is_expired, needs_renewal_soon boolean Om domenet har utløpt, og om det utløper i løpet av de neste 30 dagene
auto_renew, renewal_period_years boolean, integer Om domenet fornyes automatisk, og for hvor mange år
registration_price, renewal_price string Priser i USD som desimaler
whois_privacy, transfer_lock boolean WHOIS personvern og låse- innstillinger for overføring
nameserver1 to nameserver4 string | null Domenets navnetjenere
created_at, updated_at datetime Når posten ble opprettet og sist endret (ISO 8601, UTC)
BLI /api/v1/domains/{uuid}/

Hent domenedetaljer

Returnerer ett domeneobjekt med feltene over.

Påkrevd tillatelse: domains:list

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

Svarstatuskoder

200 Vellykket
404 Ikke funnet, eller den tilhører en annen konto
POST /api/v1/domains/search/

Tilgjengelighet for søkedomene

Sjekker om et navn finnes på tvers av ca. 20 populære utvidelser (com, net, org, io, dev, co, app, ai og mer) pluss etternavnet du skrev inn hvis det ikke er blant dem. Resultatene starter med det eksakte, så tilgjengelige navn, og tok så et navn.

Påkrevd tillatelse: domains:search

Forespørselsparametere

Parameter Type Obligatorisk Beskrivelse
domain string Ja Et navn med eller uten en utvidelse, for eksempel mysite eller mysite.com (2 til 63 tegn)

Eksempelforespørsel

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

Eksempelsvar

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

Prisene er tall i USD for ett år og er null for navn som ikke er tilgjengelige. Prisene som vises er illustrerende.

Svarstatuskoder

200 Vellykket
400 Manglende domene, eller det inneholder tegn unntatt bokstaver, sifre og bindestreker
500 Oppslag på registrator mislyktes. Prøv igjen senere.
POST /api/v1/domains/register/

Registrer nytt domene

Registrerer et domene og krever betaling for din lagrede betalingsmetode. Tilgjengelighet og pris sjekkes med registratoren igjen rett før avgiften. Registrators kontaktopplysninger tas fra din kontoprofil. Hvis registratoren avviser registreringen etter avgiften, blir betalingen tilbakebetalt.

Påkrevd tillatelse: domains:register (inndelt etter område:*)

Forespørselsparametere

Parameter Type Obligatorisk Beskrivelse
domain string Ja Fullt domenenavn inkludert utvidelse, for eksempel.com
years integer Nei Registreringsperiode, 1 til 10 (standard 1). Prisen er årlig pris ganger år..ai krever minst 2 år, en mindre verdi gir 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}'

Eksempelsvar

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

Svarstatuskoder

201 Domene registrert
400 Ugyldig domene, domene ikke lenger tilgjengelig, prisen kunne ikke verifiseres, foreldet betalingsmetode, eller betaling mislyktes
402 Ingen betalingsmetode for fil, eller ubetalte fakturaer
500 Betalingen kunne ikke behandles eller registrator avviste registrering etter betaling. i det andre tilfellet viser feilmeldingen om tilbakebetalingen gikk gjennom.
POST /api/v1/domains/{uuid}/renew/

Forny et domene

Fornyer domenet og krever for hvert år fornyer du din lagrede betalingsmetode.

Påkrevd tillatelse: domains:renew

Forespørselsparametere

Parameter Type Obligatorisk Beskrivelse
years integer Nei År som skal legges til, 1 til 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)!"
}

Svarstatuskoder

200 Domene fornyet
400 Ugyldig år, ingen fornyelsespris for domenet, ingen brukbar betalingsmetode, eller betaling mislyktes
404 Ikke funnet, eller den tilhører en annen konto
500 Betaling kunne ikke behandles, eller betalingen gikk gjennom men registrators fornyelse mislyktes. Kontaktstøtte i så fall.
PUT /api/v1/domains/{uuid}/nameservers/

Oppdater navnetjenere

Setter domenets navnetjenere i registraren og returnerer det oppdaterte domeneobjektet. For å håndtere DNS med DNS API, bruk ns1.vps.org, ns2.vps.org og ns3.vps.org og opprett en sone for domenet.

Påkrevd tillatelse: domains:update

Forespørselsparametere

Parameter Type Obligatorisk Beskrivelse
nameserver1 string Ja Hovednavntjeners vertsnavn
nameserver2, nameserver3, nameserver4 string Nei Flere vertsnavntjenere
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"}'

Svarstatuskoder

200 Navnetjenere oppdaterte. Legemet er domeneobjektet
400 navnetjener1 mangler
404 Ikke funnet, eller den tilhører en annen konto
500 Oppdateringen mislyktes, kroppen har feil - og meldingsfelter
PUT /api/v1/domains/{uuid}/auto-renew/

Slå på eller av automatisk fornyelse

Setter automatisk _fornyelse og returnerer det oppdaterte domeneobjektet. Send slått på som JSON boolsk: enhver streng som ikke er tom, medregnet strengen False slår automatisk på fornyelse.

Påkrevd tillatelse: 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}'

Svarstatuskoder

200 Setter opp lagret; kroppen er domeneobjektet
400 slått på mangler
404 Ikke funnet, eller den tilhører en annen konto

Merknader