> ## Knowledge Base Index > Fetch the complete knowledge base index at: https://help.xynta.com/sitemap.xml > Use this file to discover available pages before exploring further. > Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash). # API-documentatie: Domains Module **Dit artikel beschrijft alle beschikbare acties binnen de `domains`-module van de xYnta API. Per actie staan de benodigde parameters en de mogelijke statuswaardes in de response.** || Voordat de API gebruikt kan worden, moet API-toegang geactiveerd zijn en moet het IP-adres op de whitelist staan. Zie [Eerste keer verbinden met de API](https://help.xynta.com/nl/article/eerste-keer-verbinden-met-de-api-l6w50v/). Voor een volledige lijst van statuscodes, zie [Statuscodes API overzicht](https://help.xynta.com/nl/article/statuscodes-api-overzicht-1oabcn5/). ## Inhoudsopgave **Domeinacties** * [check — Beschikbaarheid controleren](#3-check-beschikbaarheid-controleren) * [list — Domeinoverzicht ophalen](#3-list-domeinoverzicht-ophalen) * [order — Domein bestellen of verhuizen](#3-order-domein-bestellen-of-verhuizen) * [show — Domeindetails opvragen](#3-show-domeindetails-opvragen) * [del — Domein opzeggen](#3-del-domein-opzeggen) * [edit-contact — WHOIS-gegevens wijzigen](#3-edit-contact-whois-gegevens-wijzigen) * [edit-nameserver — Nameservers wijzigen](#3-edit-nameserver-nameservers-wijzigen) * [lock — Domein vergrendelen](#3-lock-domein-vergrendelen) * [unlock — Domein ontgrendelen](#3-unlock-domein-ontgrendelen) * [get-authkey — Verhuiscode opvragen](#3-get-authkey-verhuiscode-opvragen) **Contactacties** * [list, t: contact — Contacten-overzicht](#3-list-t-contact-contacten-overzicht) * [show, t: contact — Contactgegevens bekijken](#3-show-t-contact-contactgegevens-bekijken) * [add, t: contact — Contact toevoegen](#3-add-t-contact-contact-toevoegen) * [edit, t: contact — Contact wijzigen](#3-edit-t-contact-contact-wijzigen) * [check, t: contact — Contact controleren](#3-check-t-contact-contact-controleren) * [del, t: contact — Contact verwijderen](#3-del-t-contact-contact-verwijderen) **DNS-acties** * [show-dns-zone — DNS-zone bekijken](#3-show-dns-zone-dns-zone-bekijken) * [edit-dns-zone — DNS-zone bewerken](#3-edit-dns-zone-dns-zone-bewerken) ### check — Beschikbaarheid controleren ``` m: domains, a: check ``` Controleert of een domeinnaam beschikbaar is voor registratie. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Volledige domeinnaam, bijv. `voorbeeld.nl` | Statuswaardes: * `available` — de domeinnaam is beschikbaar. * `unavailable` — de domeinnaam is al geregistreerd. ### list — Domeinoverzicht ophalen ``` m: domains, a: list ``` Haalt een overzicht op van alle domeinnamen gekoppeld aan het account. Geen parameters vereist. Statuswaardes: * `success` — het domeinoverzicht is succesvol opgehaald. ### order — Domein bestellen of verhuizen ``` m: domains, a: order ``` Bestelt of verhuist een domeinnaam. Zie ook: [Domeinnamen real-time bestellen via de API](https://help.xynta.com/nl/article/domeinnamen-real-time-bestellen-via-de-api-td8qei/). | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie, bijv. `voorbeeld` | | `Tld` | Ja | Extensie zonder punt, bijv. `nl` | | `OwnerHandle` | Ja | Unieke ID van de houder | | `AdminHandle` | Ja | Unieke ID van het administratief contact | | `TechHandle` | Ja | Unieke ID van het technisch contact | | `DNS1` | Ja | Eerste nameserver | | `DNS2` | Ja | Tweede nameserver | | `DNS3` | Nee | Derde nameserver | | `DNS4` | Nee | Vierde nameserver | | `DNS5` | Nee | Vijfde nameserver | | `AuthKey` | Nee | Verhuiscode, indien vereist voor de verhuizing | Statuswaardes: * `success` — de domeinnaam is succesvol besteld. * `not-authorized` — achteraf factureren is niet ingeschakeld. * `not-found-service` — de extensie wordt niet ondersteund. * `not-found-contact` — een of meer opgegeven contacten zijn niet gevonden. * `not-available` — de domeinnaam is al eerder besteld. * `validation-domain` — ongeldig formaat domeinnaam. ### show — Domeindetails opvragen ``` m: domains, a: show ``` Haalt de details van een specifieke domeinnaam op. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie, bijv. `voorbeeld` | | `Tld` | Ja | Extensie zonder punt, bijv. `nl` | Statuswaardes: * `success` — de domeinnaam is gevonden. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### del — Domein opzeggen ``` m: domains, a: del, t: cancel / cancel-direct / undo ``` Zegt een domeinnaam op. Gebruik `t: cancel` voor opzegging op einde contractperiode, `t: cancel-direct` voor directe opzegging, of `t: undo` om een lopende opzegging ongedaan te maken. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | Statuswaardes: * `success` — het domein is opgezegd. * `pending-deletion` — de opzegging was al actief. * `not-supported` — opzegging is niet mogelijk voor deze extensie. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### edit-contact — WHOIS-gegevens wijzigen ``` m: domains, a: edit-contact ``` Wijzigt de aan een domeinnaam gekoppelde contacten (houder, administratief en technisch). | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | | `OwnerHandle` | Ja | Unieke ID van de houder | | `AdminHandle` | Ja | Unieke ID van het administratief contact | | `TechHandle` | Ja | Unieke ID van het technisch contact | Statuswaardes: * `success` — de contacten zijn gewijzigd. * `error` — wijziging mislukt. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### edit-nameserver — Nameservers wijzigen ``` m: domains, a: edit-nameserver ``` Wijzigt de nameservers van een domeinnaam. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | | `DNS1` | Ja | Eerste nameserver | | `DNS2` | Ja | Tweede nameserver | | `DNS3` | Nee | Derde nameserver | | `DNS4` | Nee | Vierde nameserver | | `DNS5` | Nee | Vijfde nameserver | Statuswaardes: * `success` — de nameservers zijn gewijzigd. * `warning` — de nameservers zijn niet aangepast. * `error` — wijziging mislukt. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### lock — Domein vergrendelen ``` m: domains, a: lock ``` Activeert een transfer lock op de domeinnaam om ongeautoriseerde verhuizing te voorkomen. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | Statuswaardes: * `success` — het domein is vergrendeld. * `not-supported` — niet ondersteund voor deze extensie. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### unlock — Domein ontgrendelen ``` m: domains, a: unlock ``` Verwijdert de transfer lock van een domeinnaam. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | Statuswaardes: * `success` — het domein is ontgrendeld. * `not-supported` — niet ondersteund voor deze extensie. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### get-authkey — Verhuiscode opvragen ``` m: domains, a: get-authkey ``` Vraagt de verhuiscode (EPP-code / authcode) op voor een domeinnaam. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | Statuswaardes: * `success` — de verhuiscode is opgevraagd. * `warning` — er is geen verhuiscode beschikbaar. * `error` — het ophalen is mislukt. * `not-supported` — niet ondersteund voor deze extensie. * `not-authorized` — geen toegang tot dit domein. * `not-found` — het domein bestaat niet. ### list, t: contact — Contacten-overzicht ``` m: domains, a: list, t: contact ``` Haalt een overzicht op van alle contacten gekoppeld aan het account. Geen parameters vereist. Statuswaardes: * `success` — de contacten zijn opgehaald. * `pending` — de verwerking is nog bezig. * `not-authorized` — geen toegang. * `not-found` — geen contacten gevonden. ### show, t: contact — Contactgegevens bekijken ``` m: domains, a: show, t: contact ``` Haalt de details van een specifiek contact op. | Variabele | Verplicht | Toelichting | | ---- | | `Handle` | Ja | Unieke ID van het contact | Statuswaardes: * `success` — het contact is gevonden. * `pending` — de verwerking is nog bezig. * `not-authorized` — geen toegang. * `not-found` — het contact is niet gevonden. ### add, t: contact — Contact toevoegen ``` m: domains, a: add, t: contact ``` Maakt een nieuw contact aan. Gebruikt dezelfde parameters als [edit, t: contact](#3-edit-t-contact-contact-wijzigen). Statuswaardes: * `success` — het contact is toegevoegd. * `error-processing` — het contact kon niet worden toegevoegd. * `validation-handle` — ongeldige Handle. * `validation-emailaddress` — ongeldig e-mailadres. * `validation-address` — ongeldig adres. * `validation-phonenumber` — ongeldig telefoonnummer. * `not-found` — het contact is niet gevonden. ### edit, t: contact — Contact wijzigen ``` m: domains, a: edit, t: contact ``` Wijzigt de gegevens van een bestaand contact. | Variabele | Verplicht | Toelichting | | ---- | | `Handle` | Ja | Unieke ID van het contact | | `CompanyName` | Nee | Bedrijfsnaam | | `CompanyNumber` | Nee | KvK-nummer, alleen voor Nederlandse bedrijven | | `TaxNumber` | Nee | Btw-nummer, alleen voor EU-bedrijven | | `Initials` | Ja | Voorletters of voornaam | | `SurName` | Ja | Achternaam | | `Address` | Ja | Straatnaam en huisnummer — postbussen zijn niet toegestaan | | `ZipCode` | Ja | Postcode, bijv. `1234AB` | | `City` | Ja | Woonplaats — alleen letters en spaties | | `Country` | Ja | ISO 3166-1 landcode, bijv. `NL` | | `EmailAddress` | Ja | Geldig e-mailadres | | `PhoneNumber` | Ja | Telefoonnummer, alleen cijfers | Statuswaardes: * `success` — het 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` — contact wordt aangepast. * `pending-deletion` — contact wordt verwijderd. * `not-found` — het contact is niet gevonden. ### check, t: contact — Contact controleren ``` m: domains, a: check, t: contact ``` Controleert of een contact al bestaat op basis van naam. | Variabele | Verplicht | Toelichting | | ---- | | `Initials` | Ja | Voorletters of voornaam | | `SurName` | Ja | Achternaam | | `CompanyName` | Nee | Bedrijfsnaam | Statuswaardes: * `success` — het contact bestaat. * `not-found` — het contact is niet gevonden. ### del, t: contact — Contact verwijderen ``` m: domains, a: del, t: contact ``` Verwijdert een bestaand contact. | Variabele | Verplicht | Toelichting | | ---- | | `Handle` | Ja | Unieke ID van het contact | Statuswaardes: * `success` — het contact is verwijderd. * `pending-processing` — verwerking gestart. * `pending-modification` — contact in wijziging. * `pending-deletion` — contact al in verwijdering. * `not-found` — het contact is niet gevonden. ### show-dns-zone — DNS-zone bekijken ``` m: domains, a: show-dns-zone ``` Haalt de DNS-zone van een domeinnaam op. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | Statuswaardes: * `success` — de DNS-zone is gevonden. * `not-found` — de zone is niet gevonden. ### edit-dns-zone — DNS-zone bewerken ``` m: domains, a: edit-dns-zone ``` Past de DNS-zone van een domeinnaam aan. | Variabele | Verplicht | Toelichting | | ---- | | `Domain` | Ja | Domeinnaam zonder extensie | | `Tld` | Ja | Extensie zonder punt | | `DNSZone` | Ja | Gewijzigde zone als array | Statuswaardes: * `success` — de DNS-zone is aangepast. * `error-processing` — wijziging mislukt. * `not-found` — de zone is niet gevonden. --- Problemen of vragen over een specifieke call? Zie [API-call troubleshooting](https://help.xynta.com/nl/article/api-call-troubleshooting-s3i2s8/) of [neem contact op](https://www.xynta.com/contact).