API-documentatie: Domains Module
Dit is de handleiding voor de domains module van onze API. Hieronder vindt u een overzicht van alle beschikbare acties binnen deze module. Klik op een actie om direct naar de toelichting te springen.
🔍 m: domains, a: check – Beschikbaarheid controleren
📄 m: domains, a: list – Domeinoverzicht ophalen
🛒 m: domains, a: order – Domein bestellen of verhuizen
📋 m: domains, a: show – Domeindetails opvragen
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Domein opzeggen
✍️ m: domains, a: edit-contact – WHOIS-gegevens wijzigen
🛠️ m: domains, a: edit-nameserver – Nameservers wijzigen
🔒 m: domains, a: lock – Domein vergrendelen
🔓 m: domains, a: unlock – Domein ontgrendelen
🔑 m: domains, a: get-authkey – Verhuiscode opvragen
👥 m: domains, a: list, t: contact – Contacten overzicht
👤 m: domains, a: show, t: contact – Contactgegevens bekijken
➕ m: domains, a: add, t: contact – Contact toevoegen
✏️ m: domains, a: edit, t: contact – Contact wijzigen
🔎 m: domains, a: check, t: contact – Contact controleren
🗑️ m: domains, a: del, t: contact – Contact verwijderen
📡 m: domains, a: show-dns-zone – DNS zone bekijken
⚙️ m: domains, a: edit-dns-zone – DNS zone bewerken
Statuswaardes:
available – de domeinnaam is beschikbaar
unavailable – de domeinnaam is bezet
Statuswaardes:
success – het domeinoverzicht is succesvol opgehaald
⚠️ Zie ook: Domeinnamen real-time bestellen via de API
Statuswaardes:
success – de domeinnaam is succesvol besteld
not-authorized – achteraf betalen is niet ingeschakeld
not-found-service – extensie wordt niet ondersteund
not-found-contact – contact kon niet worden gevonden
not-available – domein al eerder besteld
validation-domain – ongeldig formaat domeinnaam
Statuswaardes:
success – domeinnaam is gevonden
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – domein is opgezegd
pending-deletion – opzegging was al actief
not-supported – niet mogelijk voor extensie
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – contacten zijn gewijzigd
error – wijziging is mislukt
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – nameservers zijn gewijzigd
warning – nameservers zijn niet aangepast
error – wijziging mislukt
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – domein is vergrendeld
not-supported – niet ondersteund
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – domein is ontgrendeld
not-supported – niet ondersteund
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – verhuiscode opgevraagd
warning – geen code beschikbaar
error – ophalen mislukt
not-supported – extensie ondersteunt dit niet
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
Statuswaardes:
success – contacten opgehaald
pending – verwerking bezig
not-authorized – geen toegang
not-found – geen contacten gevonden
Statuswaardes:
success – contact gevonden
pending – nog in verwerking
not-authorized – geen toegang
not-found – contact niet gevonden
(zelfde velden als bij edit, zie verderop)
Statuswaardes:
success – contact is toegevoegd
error-processing – contact kon niet worden toegevoegd
validation-handle – ongeldige Handle
validation-emailaddress – ongeldig e-mailadres
validation-address – ongeldig adres
validation-phonenumber – ongeldig telefoonnummer
not-found – contact niet gevonden
Statuswaardes:
success – contact is gewijzigd
error-processing – wijziging mislukt
validation-handle – ongeldige Handle
validation-emailaddress – ongeldig e-mailadres
validation-address – ongeldig adres
validation-phonenumber – ongeldig telefoonnummer
pending-processing – verwerking loopt
pending-modification – wordt aangepast
pending-deletion – wordt verwijderd
not-found – contact niet gevonden
Statuswaardes:
success – contact bestaat
not-found – contact niet gevonden
Statuswaardes:
success – contact verwijderd
pending-processing – verwerking gestart
pending-modification – contact in wijziging
pending-deletion – al in verwijdering
not-found – contact niet gevonden
Statuswaardes:
success – DNS zone gevonden
not-found – zone niet gevonden
Statuswaardes:
success – DNS zone aangepast
error-processing – wijziging mislukt
not-found – zone niet gevonden
📑 Inhoudsopgave
🔍 m: domains, a: check – Beschikbaarheid controleren
📄 m: domains, a: list – Domeinoverzicht ophalen
🛒 m: domains, a: order – Domein bestellen of verhuizen
📋 m: domains, a: show – Domeindetails opvragen
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Domein opzeggen
✍️ m: domains, a: edit-contact – WHOIS-gegevens wijzigen
🛠️ m: domains, a: edit-nameserver – Nameservers wijzigen
🔒 m: domains, a: lock – Domein vergrendelen
🔓 m: domains, a: unlock – Domein ontgrendelen
🔑 m: domains, a: get-authkey – Verhuiscode opvragen
👥 m: domains, a: list, t: contact – Contacten overzicht
👤 m: domains, a: show, t: contact – Contactgegevens bekijken
➕ m: domains, a: add, t: contact – Contact toevoegen
✏️ m: domains, a: edit, t: contact – Contact wijzigen
🔎 m: domains, a: check, t: contact – Contact controleren
🗑️ m: domains, a: del, t: contact – Contact verwijderen
📡 m: domains, a: show-dns-zone – DNS zone bekijken
⚙️ m: domains, a: edit-dns-zone – DNS zone bewerken
🔍 m: domains, a: check – Beschikbaarheid controleren
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Bijv. voorbeeld.nl |
Statuswaardes:
available – de domeinnaam is beschikbaar
unavailable – de domeinnaam is bezet
📄 m: domains, a: list – Domeinoverzicht ophalen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| - | ❌ | Geen nodig |
Statuswaardes:
success – het domeinoverzicht is succesvol opgehaald
🛒 m: domains, a: order – Domein bestellen of verhuizen
⚠️ Zie ook: Domeinnamen real-time bestellen via de API
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Bijv. voorbeeld |
| Tld | ✅ | Bijv. nl |
| OwnerHandle | ✅ | Unieke ID van houder |
| AdminHandle | ✅ | Unieke ID administratief contact |
| TechHandle | ✅ | Unieke ID technisch contact |
| DNS1 | ✅ | Eerste nameserver |
| DNS2 | ✅ | Tweede nameserver |
| DNS3 | ❌ | Derde nameserver |
| AuthKey | ❌ | Verhuiscode indien vereist |
Statuswaardes:
success – de domeinnaam is succesvol besteld
not-authorized – achteraf betalen is niet ingeschakeld
not-found-service – extensie wordt niet ondersteund
not-found-contact – contact kon niet worden gevonden
not-available – domein al eerder besteld
validation-domain – ongeldig formaat domeinnaam
📋 m: domains, a: show – Domeindetails opvragen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Bijv. voorbeeld |
| Tld | ✅ | Bijv. nl |
Statuswaardes:
success – domeinnaam is gevonden
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Domein opzeggen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Bijv. voorbeeld |
| Tld | ✅ | Bijv. nl |
Statuswaardes:
success – domein is opgezegd
pending-deletion – opzegging was al actief
not-supported – niet mogelijk voor extensie
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
✍️ m: domains, a: edit-contact – WHOIS-gegevens wijzigen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
| OwnerHandle | ✅ | Houder |
| AdminHandle | ✅ | Administratief contact |
| TechHandle | ✅ | Technisch contact |
Statuswaardes:
success – contacten zijn gewijzigd
error – wijziging is mislukt
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
🛠️ m: domains, a: edit-nameserver – Nameservers wijzigen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
| DNS1 | ✅ | Eerste nameserver |
| DNS2 | ✅ | Tweede nameserver |
| DNS3 | ❌ | Derde nameserver |
Statuswaardes:
success – nameservers zijn gewijzigd
warning – nameservers zijn niet aangepast
error – wijziging mislukt
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
🔒 m: domains, a: lock – Domein vergrendelen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
Statuswaardes:
success – domein is vergrendeld
not-supported – niet ondersteund
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
🔓 m: domains, a: unlock – Domein ontgrendelen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
Statuswaardes:
success – domein is ontgrendeld
not-supported – niet ondersteund
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
🔑 m: domains, a: get-authkey – Verhuiscode opvragen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
Statuswaardes:
success – verhuiscode opgevraagd
warning – geen code beschikbaar
error – ophalen mislukt
not-supported – extensie ondersteunt dit niet
not-authorized – geen toegang tot domein
not-found – domein bestaat niet
👥 m: domains, a: list, t: contact – Contacten overzicht
| Variabele | Verplicht | Toelichting |
|---|---|---|
| - | ❌ | - |
Statuswaardes:
success – contacten opgehaald
pending – verwerking bezig
not-authorized – geen toegang
not-found – geen contacten gevonden
👤 m: domains, a: show, t: contact – Contactgegevens bekijken
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Handle | ✅ | Unieke ID contact |
Statuswaardes:
success – contact gevonden
pending – nog in verwerking
not-authorized – geen toegang
not-found – contact niet gevonden
➕ m: domains, a: add, t: contact – Contact toevoegen
(zelfde velden als bij edit, zie verderop)
Statuswaardes:
success – contact is toegevoegd
error-processing – contact kon niet worden toegevoegd
validation-handle – ongeldige Handle
validation-emailaddress – ongeldig e-mailadres
validation-address – ongeldig adres
validation-phonenumber – ongeldig telefoonnummer
not-found – contact niet gevonden
✏️ m: domains, a: edit, t: contact – Contact wijzigen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Handle | ✅ | Unieke naam |
| CompanyName | ❌ | Optioneel |
| CompanyNumber | ❌ | Alleen NL bedrijven |
| TaxNumber | ❌ | Alleen EU bedrijven |
| Initials | ✅ | Voorletters of naam |
| SurName | ✅ | Achternaam |
| Address | ✅ | Geen postbus toegestaan |
| ZipCode | ✅ | Bijv. 1234AB |
| City | ✅ | Alleen letters en spaties |
| Country | ✅ | ISO 3166-1 code |
| EmailAddress | ✅ | Moet geldig zijn |
| PhoneNumber | ✅ | Alleen cijfers |
Statuswaardes:
success – contact is gewijzigd
error-processing – wijziging mislukt
validation-handle – ongeldige Handle
validation-emailaddress – ongeldig e-mailadres
validation-address – ongeldig adres
validation-phonenumber – ongeldig telefoonnummer
pending-processing – verwerking loopt
pending-modification – wordt aangepast
pending-deletion – wordt verwijderd
not-found – contact niet gevonden
🔎 m: domains, a: check, t: contact – Contact controleren
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Initials | ✅ | Voorletters |
| SurName | ✅ | Achternaam |
| CompanyName | ❌ | Optioneel |
Statuswaardes:
success – contact bestaat
not-found – contact niet gevonden
🗑️ m: domains, a: del, t: contact – Contact verwijderen
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Handle | ✅ | Unieke naam |
Statuswaardes:
success – contact verwijderd
pending-processing – verwerking gestart
pending-modification – contact in wijziging
pending-deletion – al in verwijdering
not-found – contact niet gevonden
📡 m: domains, a: show-dns-zone – DNS zone bekijken
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
Statuswaardes:
success – DNS zone gevonden
not-found – zone niet gevonden
⚙️ m: domains, a: edit-dns-zone – DNS zone bewerken
| Variabele | Verplicht | Toelichting |
|---|---|---|
| Domain | ✅ | Domeinnaam |
| Tld | ✅ | Extensie |
| DNSZone | ✅ | Gewijzigde zone als array |
Statuswaardes:
success – DNS zone aangepast
error-processing – wijziging mislukt
not-found – zone niet gevonden
Bijgewerkt op: 23/05/2025
Dankuwel!