VPS.org API

Constellation name (optional)

Domeine API

Soek vir beskikbare domeinname, register en hernieu domein, en bestuur hulle naambedieners en outo-hernuweal. domeine word geïdentifiseer deur hulle uid.

Eindpunte 7
Basispad /api/v1/domains
KRY /api/v1/domains/

Lys alle domeine

Gee terug die domein geregistreer in u rekening, 25 per bladsy. Die lys het geen filters nie.

Benodigde toestemming: domains:list

Voorbeeldversoek

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

Voorbeeldantwoord

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

Antwoordvelde

Veld Tipe Beskrywing
uuid string Domeinidentifiseerder wat in die ander domein-Aanwysers gebruik word
status string active, pending, expired, cancelled, transferred
registrar string Registrasierar word die domein
registration_date, expiration_date datetime Wanneer die domein geregistreer is en wanneer dit vertrek. verval_datum kan nie wees nie.
days_until_expiration integer | null Volledige dae tot verval_datum, negatiewe een keer verval
is_expired, needs_renewal_soon boolean Of die domein verval het en of dit binne die volgende 30 dae verval
auto_renew, renewal_period_years boolean, integer Of die domein outomaties hernieu word, en vir hoeveel jaar
registration_price, renewal_price string Pryse in USD as desimale stringe
whois_privacy, transfer_lock boolean WHOIS privacy and registrar transfer lock settings
nameserver1 to nameserver4 string | null Die domein se naambedieners
created_at, updated_at datetime Toe die verslag geskep is en laaste verander is (Iso 8601, UTC)
KRY /api/v1/domains/{uuid}/

Kry domein Details

Gee een domeinvoorwerp terug met die velde hierbo.

Benodigde toestemming: domains:list

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

Reaksiestatuskodes

200 Sukses
404 Nie gevind nie, of dit behoort aan 'n ander rekening
AGT /api/v1/domains/search/

Soek Domein Ondebaarheid

Gaan na of 'n naam oor ongeveer 20 gewilde uitbreidings beskikbaar is (com, net, org, io, dev, co, app, ai en meer), plus die uitbreiding wat jy ingetik het as dit nie onder hulle is nie. Resultate begin met die presiese ooreenstem, dan beskikbaar name, dan geneemde name.

Benodigde toestemming: domains:search

Versoekliggaamparameters

Parameter Tipe Vereis Beskrywing
domain string Ja ' n Naam met of sonder'n uitbreiding, byvoorbeeld Mysiet of myste.com (2 tot 63 karakters)

Voorbeeldversoek

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

Voorbeeldantwoord

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

Pryse is nommers in USD vir 'n jaar en is nie geskik vir name wat nie beskikbaar is nie. Die pryse wat vertoon word is illustrasie.

Reaksiestatuskodes

200 Sukses
400 Ontbrekende domein, of dit bevat karakters buiten briewe, syfers en hiphenne
500 Die registrateur kyk gevaal. Herprobeer later.
AGT /api/v1/domains/register/

Registreer Nuwe Domein

Register 'n domein en aanklagte van jou gestoorde betaalmetode. Alvaility en prys word nagegaan met die registrateur weer direk voor die lading. Die geregistreerde kontakbesonderhede word geneem van jou rekening profiel. As die registrateur verwerp die registrasie na die lading, word die betaling herhale hervat.

Benodigde toestemming: domains:register (gelok deur domein:*)

Versoekliggaamparameters

Parameter Tipe Vereis Beskrywing
domain string Ja Die volle domeinnaam met inbegrip van sy uitbreiding, byvoorbeeld.com
years integer Nee Registrasie periode, 1 tot 10 (verstek 1). Die prys is Die jaarlikse prys maal jare..ai benodig na ten minste 2 jaar;'n kleiner waarde gee terug 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}'

Voorbeeldantwoord

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

Reaksiestatuskodes

201 Domein geregistreer
400 Ongeldige domein, domein nie meer beskikbaar nie, prys kon nie verifiëerd, verouderde betalingsmetode of die betaling het misluk nie
402 Geen betalingsmetode op lêer, of onbetaalde fakture,
500 Die betaling kon nie verwerk word nie, of die registrateur het die registrasie ná betaling verwerp.'n Foutboodskap in die tweede geval sê of die herreasde plaasgevind het.
AGT /api/v1/domains/{uuid}/renew/

Hernieu 'n Domein

Hernieu die domein en beskuldig die hernuwing daarvan elke jaar vir jou gestoorde betalingsmetode.

Benodigde toestemming: domains:renew

Versoekliggaamparameters

Parameter Tipe Vereis Beskrywing
years integer Nee Jare om by te voeg, 1 tot 10 (verstek 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)!"
}

Reaksiestatuskodes

200 Domein hervat
400 Ongeldige jare, geen hernuwingsprys vir die domein, geen bruikbaare betalingsmetode of die betaling het misluk nie
404 Nie gevind nie, of dit behoort aan 'n ander rekening
500 Die betalings kon nie verwerk word nie, of die betaling is gedoen, maar die registrateur het hom nie hernieu nie. Kontaksteun in daardie geval.
PUT /api/v1/domains/{uuid}/nameservers/

Dateer op Naambedieners

Verstel die domein se naambedieners by die registrateur en gee terug die opgedateerde domein voorwerp. Om DNS met die Dns API te bestuur, gebruik ns1.vps.org, ns2.vps.org en ns3.vps.org en skep 'n sone vir die domein.

Benodigde toestemming: domains:update

Versoekliggaamparameters

Parameter Tipe Vereis Beskrywing
nameserver1 string Ja Hoof naambedienernaam
nameserver2, nameserver3, nameserver4 string Nee Aditionele naam bediener masjien naam: 
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"}'

Reaksiestatuskodes

200 Naambedieners opgedateer; die liggaam is die domein objek
400 naam bediener1 ontbreek
404 Nie gevind nie, of dit behoort aan 'n ander rekening
500 Die opdatering het misluk; die liggaam het fout en boodskapvelde
PUT /api/v1/domains/{uuid}/auto-renew/

Skakel Outo-hernuwe aan of af

Sets auto_renew and returns the updated domain object. Send enabled as a JSON boolean: any non-empty string, including the string false, turns auto-renewal on.

Benodigde toestemming: 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}'

Reaksiestatuskodes

200 Opset gestoor; die liggaam is die domein voorwerp
400 geaktiveer vermis
404 Nie gevind nie, of dit behoort aan 'n ander rekening

Notas