API Documentation: Domains Module

This article describes all available actions within the domains module of the xYnta API. Each action lists its required parameters and the possible status values returned in the response.

Table of contents

Domain actions

• check — Check availability
• list — Retrieve domain overview
• order — Order or transfer domain
• show — Retrieve domain details
• del — Cancel domain
• edit-contact — Modify WHOIS details
• edit-nameserver — Modify nameservers
• lock — Lock domain
• unlock — Unlock domain
• get-authkey — Retrieve transfer code

Contact actions

• list, t: contact — Contacts overview
• show, t: contact — View contact details
• add, t: contact — Add contact
• edit, t: contact — Modify contact
• check, t: contact — Check contact
• del, t: contact — Delete contact

DNS actions

• show-dns-zone — View DNS zone
• edit-dns-zone — Modify DNS zone

check — Check availability

m: domains, a: check

Checks whether a domain name is available for registration.

Status values:

• available — the domain name is available.
• unavailable — the domain name is already registered.

list — Retrieve domain overview

m: domains, a: list

Retrieves an overview of all domain names linked to the account.

No parameters required.

Status values:

• success — the domain overview was retrieved successfully.

order — Order or transfer domain

m: domains, a: order

Orders or transfers a domain name. See also: Ordering domain names in real time via the API.

Status values:

• success — the domain name was ordered successfully.
• not-authorized — post-payment billing is not enabled.
• not-found-service — the extension is not supported.
• not-found-contact — one or more contacts were not found.
• not-available — the domain name has already been ordered.
• validation-domain — invalid domain name format.

show — Retrieve domain details

m: domains, a: show

Retrieves the details of a specific domain name.

Status values:

• success — the domain was found.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

del — Cancel domain

m: domains, a: del, t: cancel / cancel-direct / undo

Cancels a domain name. Use t: cancel to cancel at the end of the contract period, t: cancel-direct for immediate cancellation, or t: undo to reverse a pending cancellation.

Status values:

• success — the domain was cancelled.
• pending-deletion — the cancellation was already active.
• not-supported — cancellation is not possible for this extension.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

edit-contact — Modify WHOIS details

m: domains, a: edit-contact

Modifies the contacts (holder, administrative and technical) linked to a domain name.

Status values:

• success — the contacts were modified.
• error — modification failed.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

edit-nameserver — Modify nameservers

m: domains, a: edit-nameserver

Modifies the nameservers of a domain name.

Status values:

• success — the nameservers were modified.
• warning — the nameservers were not changed.
• error — modification failed.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

lock — Lock domain

m: domains, a: lock

Activates a transfer lock on the domain name to prevent unauthorised transfer.

Status values:

• success — the domain was locked.
• not-supported — not supported for this extension.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

unlock — Unlock domain

m: domains, a: unlock

Removes the transfer lock from a domain name.

Status values:

• success — the domain was unlocked.
• not-supported — not supported for this extension.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

get-authkey — Retrieve transfer code

m: domains, a: get-authkey

Retrieves the transfer code (EPP code / authcode) for a domain name.

Status values:

• success — the transfer code was retrieved.
• warning — no transfer code available.
• error — retrieval failed.
• not-supported — not supported for this extension.
• not-authorized — no access to this domain.
• not-found — the domain does not exist.

list, t: contact — Contacts overview

m: domains, a: list, t: contact

Retrieves an overview of all contacts linked to the account.

No parameters required.

Status values:

• success — the contacts were retrieved.
• pending — processing is still in progress.
• not-authorized — no access.
• not-found — no contacts found.

show, t: contact — View contact details

m: domains, a: show, t: contact

Retrieves the details of a specific contact.

Status values:

• success — the contact was found.
• pending — processing is still in progress.
• not-authorized — no access.
• not-found — the contact was not found.

add, t: contact — Add contact

m: domains, a: add, t: contact

Creates a new contact. Uses the same parameters as edit, t: contact.

Status values:

• success — the contact was added.
• error-processing — the contact could not be added.
• validation-handle — invalid Handle.
• validation-emailaddress — invalid email address.
• validation-address — invalid address.
• validation-phonenumber — invalid phone number.
• not-found — the contact was not found.

edit, t: contact — Modify contact

m: domains, a: edit, t: contact

Modifies the details of an existing contact.

Status values:

• success — the contact was modified.
• error-processing — modification failed.
• validation-handle — invalid Handle.
• validation-emailaddress — invalid email address.
• validation-address — invalid address.
• validation-phonenumber — invalid phone number.
• pending-processing — processing in progress.
• pending-modification — contact is being modified.
• pending-deletion — contact is being deleted.
• not-found — the contact was not found.

check, t: contact — Check contact

m: domains, a: check, t: contact

Checks whether a contact already exists based on name.

Status values:

• success — the contact exists.
• not-found — the contact was not found.

del, t: contact — Delete contact

m: domains, a: del, t: contact

Deletes an existing contact.

Status values:

• success — the contact was deleted.
• pending-processing — processing started.
• pending-modification — contact under modification.
• pending-deletion — contact already being deleted.
• not-found — the contact was not found.

show-dns-zone — View DNS zone

m: domains, a: show-dns-zone

Retrieves the DNS zone of a domain name.

Status values:

• success — the DNS zone was found.
• not-found — the zone was not found.

edit-dns-zone — Modify DNS zone

m: domains, a: edit-dns-zone

Modifies the DNS zone of a domain name.

Status values:

• success — the DNS zone was modified.
• error-processing — modification failed.
• not-found — the zone was not found.

Issues or questions about a specific call? See API call troubleshooting or get in touch.

Updated on: 19/04/2026