API Documentation: Domains Module
This is the guide for the domains module of our API. Below you'll find an overview of all available actions within this module. Click on an action to jump directly to its description.
🔍 m: domains, a: check – Check Availability
📄 m: domains, a: list – Retrieve Domain List
🛒 m: domains, a: order – Register or Transfer Domain
📋 m: domains, a: show – View Domain Details
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Cancel Domain
✍️ m: domains, a: edit-contact – Update WHOIS Details
🛠️ m: domains, a: edit-nameserver – Update Nameservers
🔒 m: domains, a: lock – Lock Domain
🔓 m: domains, a: unlock – Unlock Domain
🔑 m: domains, a: get-authkey – Retrieve Transfer Code
👥 m: domains, a: list, t: contact – Contact Overview
👤 m: domains, a: show, t: contact – View Contact Details
➕ m: domains, a: add, t: contact – Add Contact
✏️ m: domains, a: edit, t: contact – Edit Contact
🔎 m: domains, a: check, t: contact – Check Contact
🗑️ m: domains, a: del, t: contact – Delete Contact
📡 m: domains, a: show-dns-zone – View DNS Zone
⚙️ m: domains, a: edit-dns-zone – Edit DNS Zone
Status values:
available – the domain name is available
unavailable – the domain name is already registered
Status values:
success – domain list successfully retrieved
⚠️ See also: Real-time domain registration via the API
Status values:
success – domain was successfully registered
not-authorized – post-payment not enabled
not-found-service – TLD not supported
not-found-contact – contact not found
not-available – domain already ordered
validation-domain – invalid domain format
Status values:
success – domain was found
not-authorized – no access to domain
not-found – domain not found
Status values:
success – domain successfully cancelled
pending-deletion – already marked for deletion
not-supported – cancellation not supported
not-authorized – no access to domain
not-found – domain not found
Status values:
success – contacts updated
error – update failed
not-authorized – no access to domain
not-found – domain not found
Status values:
success – nameservers updated
warning – no changes applied
error – update failed
not-authorized – no access to domain
not-found – domain not found
Status values:
success – domain locked
not-supported – not supported for this TLD
not-authorized – no access
not-found – domain not found
Status values:
success – domain unlocked
not-supported – not supported
not-authorized – no access
not-found – domain not found
Status values:
success – transfer code retrieved
warning – no code available
error – failed to retrieve
not-supported – TLD not supported
not-authorized – no access
not-found – domain not found
Status values:
success – contacts retrieved
pending – still processing
not-authorized – no access
not-found – no contacts found
Status values:
success – contact found
pending – still being created
not-authorized – no access
not-found – contact not found
(same fields as in edit, see below)
Status values:
success – contact added
error-processing – add failed
validation-handle – invalid handle
validation-emailaddress – invalid email
validation-address – invalid address
validation-phonenumber – invalid phone number
not-found – contact not found
Status values:
success – contact updated
error-processing – update failed
validation-handle – invalid handle
validation-emailaddress – invalid email
validation-address – invalid address
validation-phonenumber – invalid phone number
pending-processing – still processing
pending-modification – being updated
pending-deletion – being deleted
not-found – contact not found
Status values:
success – contact exists
not-found – contact not found
Status values:
success – contact deleted
pending-processing – processing started
pending-modification – contact being updated
pending-deletion – contact already scheduled for removal
not-found – contact not found
Status values:
success – DNS zone found
not-found – DNS zone not found
Status values:
success – DNS zone updated
error-processing – update failed
not-found – zone not found
📑 Table of Contents
🔍 m: domains, a: check – Check Availability
📄 m: domains, a: list – Retrieve Domain List
🛒 m: domains, a: order – Register or Transfer Domain
📋 m: domains, a: show – View Domain Details
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Cancel Domain
✍️ m: domains, a: edit-contact – Update WHOIS Details
🛠️ m: domains, a: edit-nameserver – Update Nameservers
🔒 m: domains, a: lock – Lock Domain
🔓 m: domains, a: unlock – Unlock Domain
🔑 m: domains, a: get-authkey – Retrieve Transfer Code
👥 m: domains, a: list, t: contact – Contact Overview
👤 m: domains, a: show, t: contact – View Contact Details
➕ m: domains, a: add, t: contact – Add Contact
✏️ m: domains, a: edit, t: contact – Edit Contact
🔎 m: domains, a: check, t: contact – Check Contact
🗑️ m: domains, a: del, t: contact – Delete Contact
📡 m: domains, a: show-dns-zone – View DNS Zone
⚙️ m: domains, a: edit-dns-zone – Edit DNS Zone
🔍 m: domains, a: check – Check Availability
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | e.g. example.nl |
Status values:
available – the domain name is available
unavailable – the domain name is already registered
📄 m: domains, a: list – Retrieve Domain List
| Variable | Required | Description |
|---|---|---|
| ❌ | No input needed |
Status values:
success – domain list successfully retrieved
🛒 m: domains, a: order – Register or Transfer Domain
⚠️ See also: Real-time domain registration via the API
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | e.g. example |
| Tld | ✅ | e.g. nl |
| OwnerHandle | ✅ | Unique ID of registrant |
| AdminHandle | ✅ | Unique ID of admin contact |
| TechHandle | ✅ | Unique ID of tech contact |
| DNS1 | ✅ | Primary nameserver |
| DNS2 | ✅ | Secondary nameserver |
| DNS3 | ❌ | Tertiary nameserver (optional) |
| AuthKey | ❌ | Transfer code if required |
Status values:
success – domain was successfully registered
not-authorized – post-payment not enabled
not-found-service – TLD not supported
not-found-contact – contact not found
not-available – domain already ordered
validation-domain – invalid domain format
📋 m: domains, a: show – View Domain Details
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | e.g. example |
| Tld | ✅ | e.g. nl |
Status values:
success – domain was found
not-authorized – no access to domain
not-found – domain not found
❌ m: domains, a: del, t: cancel / cancel-direct / undo – Cancel Domain
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | e.g. example |
| Tld | ✅ | e.g. nl |
Status values:
success – domain successfully cancelled
pending-deletion – already marked for deletion
not-supported – cancellation not supported
not-authorized – no access to domain
not-found – domain not found
✍️ m: domains, a: edit-contact – Update WHOIS Details
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
| OwnerHandle | ✅ | Registrant contact handle |
| AdminHandle | ✅ | Admin contact handle |
| TechHandle | ✅ | Tech contact handle |
Status values:
success – contacts updated
error – update failed
not-authorized – no access to domain
not-found – domain not found
🛠️ m: domains, a: edit-nameserver – Update Nameservers
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
| DNS1 | ✅ | First nameserver |
| DNS2 | ✅ | Second nameserver |
| DNS3 | ❌ | Third nameserver |
Status values:
success – nameservers updated
warning – no changes applied
error – update failed
not-authorized – no access to domain
not-found – domain not found
🔒 m: domains, a: lock – Lock Domain
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
Status values:
success – domain locked
not-supported – not supported for this TLD
not-authorized – no access
not-found – domain not found
🔓 m: domains, a: unlock – Unlock Domain
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
Status values:
success – domain unlocked
not-supported – not supported
not-authorized – no access
not-found – domain not found
🔑 m: domains, a: get-authkey – Retrieve Transfer Code
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
Status values:
success – transfer code retrieved
warning – no code available
error – failed to retrieve
not-supported – TLD not supported
not-authorized – no access
not-found – domain not found
👥 m: domains, a: list, t: contact – Contact Overview
| Variable | Required | Description |
|---|---|---|
| ❌ |
Status values:
success – contacts retrieved
pending – still processing
not-authorized – no access
not-found – no contacts found
👤 m: domains, a: show, t: contact – View Contact Details
| Variable | Required | Description |
|---|---|---|
| Handle | ✅ | Unique contact handle |
Status values:
success – contact found
pending – still being created
not-authorized – no access
not-found – contact not found
➕ m: domains, a: add, t: contact – Add Contact
(same fields as in edit, see below)
Status values:
success – contact added
error-processing – add failed
validation-handle – invalid handle
validation-emailaddress – invalid email
validation-address – invalid address
validation-phonenumber – invalid phone number
not-found – contact not found
✏️ m: domains, a: edit, t: contact – Edit Contact
| Variable | Required | Description |
|---|---|---|
| Handle | ✅ | Unique name |
| CompanyName | ❌ | Optional |
| CompanyNumber | ❌ | Dutch companies only |
| TaxNumber | ❌ | EU companies only |
| Initials | ✅ | First name or initials |
| SurName | ✅ | Last name |
| Address | ✅ | No P.O. boxes allowed |
| ZipCode | ✅ | e.g. 1234AB |
| City | ✅ | Only letters and spaces allowed |
| Country | ✅ | ISO 3166-1 code |
| EmailAddress | ✅ | Must be valid and reachable |
| PhoneNumber | ✅ | Digits only |
Status values:
success – contact updated
error-processing – update failed
validation-handle – invalid handle
validation-emailaddress – invalid email
validation-address – invalid address
validation-phonenumber – invalid phone number
pending-processing – still processing
pending-modification – being updated
pending-deletion – being deleted
not-found – contact not found
🔎 m: domains, a: check, t: contact – Check Contact
| Variable | Required | Description |
|---|---|---|
| Initials | ✅ | First name/initials |
| SurName | ✅ | Last name |
| CompanyName | ❌ | Optional |
Status values:
success – contact exists
not-found – contact not found
🗑️ m: domains, a: del, t: contact – Delete Contact
| Variable | Required | Description |
|---|---|---|
| Handle | ✅ | Unique contact handle |
Status values:
success – contact deleted
pending-processing – processing started
pending-modification – contact being updated
pending-deletion – contact already scheduled for removal
not-found – contact not found
📡 m: domains, a: show-dns-zone – View DNS Zone
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
Status values:
success – DNS zone found
not-found – DNS zone not found
⚙️ m: domains, a: edit-dns-zone – Edit DNS Zone
| Variable | Required | Description |
|---|---|---|
| Domain | ✅ | Domain name |
| Tld | ✅ | Extension |
| DNSZone | ✅ | Modified zone as array |
Status values:
success – DNS zone updated
error-processing – update failed
not-found – zone not found
Updated on: 23/05/2025
Thank you!