VPS.org API

Dokumintaasje

Domeinen API

Sykje nei beskikbere domeinnammen, domeinen registrearje en fernije, en har nammetsjinners en automatyske fernijings beheare. Domeinen wurde identifisearre troch har uuid.

Einpunten 7
Basispaad /api/v1/domains
KRIJE /api/v1/domains/

List alle domeinen

Jout de domeinen werom dy' t yn jo akkount registrearre binne, 25 per side. De list hat gjin filters.

Tagongsrjochten fereaske: domains:list

Foarbyldfersyk

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

Foarbyldantwurd

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

Antwurdfjilden

Fjild Type Beskriuwing
uuid string Domein- identifikaasje brûkt yn de oare domein- einpunten
status string active, pending, expired, cancelled, transferred
registrar string Registrar it domein wurdt hâlden by
registration_date, expiration_date datetime Wannear' t it domein registrearre is en wannear' t it ferrint. expiration_ date kin null wêze.
days_until_expiration integer | null Folle dagen oant ferrin_ datum, negatyf as ferrûn
is_expired, needs_renewal_soon boolean Of it domein ferrûn is, en of it binnen de kommende 30 dagen ferrint
auto_renew, renewal_period_years boolean, integer Of it domein automatysk fernijd wurdt, en foar hoefolle jierren
registration_price, renewal_price string Priis yn USD as desimaal tekenrige
whois_privacy, transfer_lock boolean WHOIS privacy en register oerdracht lock ynstellings
nameserver1 to nameserver4 string | null De domeinnammetsjinners
created_at, updated_at datetime Wannear' t de rekord oanmakke en foar it lêst feroare is (ISO 8601, UTC)
KRIJE /api/v1/domains/{uuid}/

Domeindetails ophelje

Jout ien domeinobjekt werom mei de boppesteande fjilden.

Tagongsrjochten fereaske: domains:list

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

Antwurdstatuskoades

200 Suksesfol
404 Net fûn, of it heart by in oar akkount
POST /api/v1/domains/search/

Domein beskikberens

Kontrolearret oft in namme beskikber is yn sa' n 20 populêre taheaksels (com, net, org, io, dev, co, app, ai en mear), plus de taheaksel dy jo ynfierd hawwe as it net by dy taheaksels heart. De resultaten begjinne mei de eksakte oerienkomst, dan de beskikbere nammen, dan de brûkte nammen.

Tagongsrjochten fereaske: domains:search

Parameters fan oanfraachlichem

Parameters Type Ferplicht Beskriuwing
domain string Ja In namme mei of sûnder taheaksel, bygelyks mynside of mynside. com (2 oant 63 tekens)

Foarbyldfersyk

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

Foarbyldantwurd

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

De prizen binne nûmers yn USD foar ien jier en binne nul foar nammen dy' t net beskikber binne. De prizen dy' t sjen litte binne illustratyf.

Antwurdstatuskoades

200 Suksesfol
400 Domein ûntbrekt, of befettet tekens dy' t net letters, sifers of bindestreken binne
500 De registeropsykjen is mislearre. Probearje it letter opnij.
POST /api/v1/domains/register/

Registrearje nij domein

Registrearret in domein en nimt de betelle betelling fan jo opslein betellingsmetoade. Beskikberens en priis wurde nochris kontrolearre by de registrator foardat de betelling dien wurdt. De kontaktgegevens fan de registrant wurde út jo akkountprofyl helle. As de registrator de betelling ôfwiisd nei de betelling, dan wurdt de betelling werombetelle.

Tagongsrjochten fereaske: domains:register (takend troch domeinen: *)

Parameters fan oanfraachlichem

Parameters Type Ferplicht Beskriuwing
domain string Ja De folsleine domeinnamme mei taheaksel, bygelyks example. com
years integer Net Registraasjeperioade, 1 oant 10 (standert 1). De priis is de jierlikse priis multiplisearre mei jierren..ai fereasket yn elts gefal 2 jier; in lytsere wearde jout 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}'

Foarbyldantwurd

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

Antwurdstatuskoades

201 Domein registrearre
400 Unjildich domein, domein net mear beskikber, priis koe net verifisearre wurde, ferâldere betellingsmetoade, of de betelling mislearre
402 Gjin betellingsmethode yn triem, of net- betelle faktueren
500 De betelling koe net ferwurke wurde, of de registrator hat de registraasje nei de betelling ôfwiisd. Yn it twadde gefal jout de flatermelding oan oft de werombetelling trochgien is.
POST /api/v1/domains/{uuid}/renew/

Domein fernije

Fernijt it domein en nimt de fernij_ priis foar elk jier yn betelling op oan jo opslein betellingsmetoade.

Tagongsrjochten fereaske: domains:renew

Parameters fan oanfraachlichem

Parameters Type Ferplicht Beskriuwing
years integer Net Te foegjen jierren, 1 oant 10 (standert 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)!"
}

Antwurdstatuskoades

200 Domein fernijd
400 Unjildige jierren, gjin fernijpriis foar it domein, gjin brûkerfreonlike betellingsmethode, of de betelling is mislearre
404 Net fûn, of it heart by in oar akkount
500 De betelling koe net ferwurke wurde, of de betelling gie troch mar de fernijing fan de registers mislearre. Nim yn dat gefal kontakt op mei de ûndersteuning.
PUT /api/v1/domains/{uuid}/nameservers/

Nammetsjinners bywurkje

Stelt de domeinnammetsjinners yn by de registrator en jout it bywurke domeinobjekt werom. Om DNS mei de DNS API te behearen, brûk ns1. vps.org, ns2. vps.org en ns3. vps.org en meitsje in zone oan foar it domein.

Tagongsrjochten fereaske: domains:update

Parameters fan oanfraachlichem

Parameters Type Ferplicht Beskriuwing
nameserver1 string Ja Primêre nammetsjinner hostnamme
nameserver2, nameserver3, nameserver4 string Net Oanfoljende nammetsjinner hostnammen 
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"}'

Antwurdstatuskoades

200 Nammetsjinners bywurke; it lichem is it domeinobjekt
400 nammetsjinner1 ûntbrekt
404 Net fûn, of it heart by in oar akkount
500 It bywurkjen is mislearre; de haadtekst hat flater- en berjochtfjilden
PUT /api/v1/domains/{uuid}/auto-renew/

Automatysk ferfarskjen yn- of útskeakelje

Stelt auto_ renew yn en jout it bywurke domeinobjekt werom. Ferstjoere as JSON- boolean: eltse net- lege tekenrige, ynklusyf de tekenrige false, set automatysk fernijen oan.

Tagongsrjochten fereaske: 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}'

Antwurdstatuskoades

200 Ynstellings bewarre; it lichem is it domeinobjekt
400 ynskeakele ûntbrekt
404 Net fûn, of it heart by in oar akkount

Notysje