Domein API

Alle domeinen weergeven

Geeft de domeinen die zijn geregistreerd in uw account, 25 per pagina. De lijst heeft geen filters.

Vereiste toestemming: domains:list

Voorbeeldverzoek

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

Antwoordvelden

Domeindetails opvragen

Geeft één domeinobject terug met de velden hierboven.

Vereiste toestemming: domains:list

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

Responsstatuscodes

Zoekdomein beschikbaarheid

Controleert of een naam beschikbaar is over ongeveer 20 populaire extensies (com, net, org, io, dev, co, app, ai en meer), plus de extensie die je typte als het niet onder hen is. De resultaten beginnen met de exacte match, dan beschikbare namen, dan genomen.

Vereiste toestemming: domains:search

Parameters van de aanvraagbody

Voorbeeldverzoek

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
}

De prijzen zijn in USD per jaar en zijn nul voor namen die niet beschikbaar zijn. De getoonde prijzen zijn illustratief.

Responsstatuscodes

Nieuw domein registreren

Registreert een domein en rekent uw opgeslagen betaalmethode in. Beschikbaarheid en prijs worden opnieuw gecontroleerd met de registrar vlak voor de lading. De contactgegevens van de registrant worden uit uw rekeningprofiel gehaald. Indien de registrar de registratie na de kosten weigert, wordt de betaling terugbetaald.

Vereiste toestemming: domains:register (toegekend door domeinen:*)

Parameters van de aanvraagbody

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

Responsstatuscodes

Een domein vernieuwen

Vernieuwt het domein en brengt zijn vernieuwing_prijs voor elk jaar in rekening aan uw opgeslagen betaalmethode.

Vereiste toestemming: domains:renew

Parameters van de aanvraagbody

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)!"
}

Responsstatuscodes

Naamservers bijwerken

Stelt de naamservers van het domein in op de registrar en geeft het bijgewerkte domeinobject terug. Om DNS te beheren met de DNS API, gebruik je ns1.vps.org, ns2.vps.org en ns3.vps.org en maak je een zone voor het domein.

Vereiste toestemming: domains:update

Parameters van de aanvraagbody

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

Responsstatuscodes

Automatisch aan- of uitzetten

Stelt auto_renew in en geeft het bijgewerkte domeinobject terug. Verzend ingeschakeld als een JSON boolean: elke niet-leeg tekenreeks, inclusief de string false, zet automatisch verlenging aan.

Vereiste 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}'

Responsstatuscodes

Opmerkingen

• De API kan een domein niet verwijderen, een domein verhuizen of de privacy van de WHOIS of het verhuisslot wijzigen. Transfers en verwijderingen zijn beschikbaar in het bedieningspaneel bij admin.vps.org.
• DNS records voor een domein worden beheerd met de DNS API. DNS-beheer-API