This article deals with WAPI commands specifically for the WEDOS DNS (NSSET) service. For information on how to set up WAPI and troubleshoot common issues, see the article WAPI – Manual.
This tutorial deals with WAPI commands for NSSET, which is only used by CZ domains. You can find instructions for DNS in the article WAPI – DNS.
This article provides information on the following requests:
- nsset-check – NSSET availability check
- nsset-info – NSSET information
- nsset-create – create NSSET
- nsset-update – update NSSET
- nsset-transfer – transfer NSSET from another registrar
- nsset-send-auth-info – send NSSET AUTH-ID
nsset-check
Use the nsset-check request to check whether the NSSET name is free for registration, or is in some other state.
Parameters
- tld – domain TLD
- name – NSSET name
Return Values
- 1000 = NSSET доступний для реєстрації
- 2201 = недійсний TLD
- 2247 = непідтримуваний формат NSSET
- 3242 = NSSET недоступний
- 3245 = NSSET уже зареєстровано
- 3246 = недоступно
- 3247 = недоступно
- 3248 = недоступно – карантин
- 3249 = недоступно – зарезервовано
- 3250 = недоступно – заблоковано
- 3251 = уже зареєстровано (у нас)
- 4218 = не вдалося надіслати – помилка зв’язку
Return Data
The request returns no data.
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-check",
"clTRID": "your ID",
"data": {
"tld": "cz",
"name": "NSSET name"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-check"
}
}
nsset-info
Use the nsset-info request to download information about an NSSET.
Parameters
- tld – TLD
- name – NSSET name
Return Values
- 1000 = OK
- 2201 = недійсний TLD
- 2209 = синтаксична помилка
- 2247 = непідтримуваний формат NSSET
- 3214 = помилка – NSSET не завантажено
- 3242 = NSSET недоступний
- 4204 = помилка з’єднання, спробуйте пізніше
Return Data
If successful, the request returns an nsset element in the data node with the following entries:
- name – NSSET name
- status – status
- reg_owner – current registrar
- reg_creator – NSSET creator (registrar)
- reg_update – registrar who made last update
- created_date – date of creation
- updated_date – date of last update
- transfer_date – date of transfer to another registrar
- tech_c – NSSET technical contact
- dns – DNS server list
- server
- name – server name
- addr_ipv4 – IPv4 server address
- addr_ipv6 – IPv6 server address
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-info",
"clTRID": "your ID",
"data": {
"tld": "cz",
"name": "NSSET name"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-info",
"data": {
"nsset": {
"name": "NSSET name",
"status": "status",
"reg_owner": "current registrar",
"reg_creator": "NSSET creator (registrar)",
"reg_update": "last update registrar",
"created_date": "date and time of creation",
"updated_date": "date and time of last update",
"transfer_date": "date and time of last transfer",
"tech_c": "technical contact ID",
"dns": {
"server1": {
"name": "DNS server name",
"addr_ipv4": "DNS server IPv4",
"addr_ipv6": "DNS server IPv6"
}
}
}
}
}
}
nsset-create
Use the nsset-create request to create a new NSSET. NSSET contains a list of NS servers, each server contains a name entry and possibly also its IP address. You can also set a technical contact – if you do not, the default (WEDOS) will be set.
Parameters
- tld – TLD
- name – NSSET name
- dns – list of ns servers, each server entry contains information about that ns server
- server
- name – name (domain address)
- addr_ipv4 – IPv4 address
- addr_ipv6 – IPv6 adsress
- server
- tech_c – technical contact – optional
Return Values
- 1000 = OK, NSSET створено
- 2201 = введено неправильний TLD
- 2210 = недійсний формат ns-серверів
- 2211 = забагато ns-серверів
- 2216 = недійсний синтаксис у технічному контакті
- 2247 = непідтримуваний формат NSSET
- 3228 = не підтримує роботу з контактами
- 3229 = помилка завантаження контакту
- 3242 = NSSET недоступний
- 3244 = Не вдалося створити NSSET
- 3245 = NSSET уже зареєстровано
- 3246 = недоступно
- 3247 = недоступно
- 3248 = недоступно – карантин
- 3249 = недоступно – зарезервовано
- 3250 = недоступно – заблоковано
- 3251 = уже зареєстровано
- 4212 = помилка з’єднання
- 4218 = перевірка не вдалася – помилка зв’язку
- 4219 = не вдалося створити – помилка зв’язку
Return Data
If successful, the command in the data node returns:
- nsset – the created NSSET name
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-create",
"clTRID": "your ID",,
"data": {
"tld": "cz",
"name": "NSSET name",
"dns": {
"server1": {
"name": "DNS server name",
"addr_ipv4": "DNS server IPv4 address",
"addr_ipv6": "DNS server IPv6 address"
}
},
"tech_c": "technical contact ID"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-create",
"data": {
"nsset": "NSSET name"
}
}
}
nsset-update
Use the nsset-update request to modify an existing NSSET. The old entry will be completely overwritten, so enter all data carefully.
Parameters
- tld – TLD – required
- auth_info – NSSET AUTH-ID – required
- name – NSSET name – required
- dns – list of ns servers, each server entry contains information about that ns server – required
- server – at least 2 required
- name – server domain name – required
- addr_ipv4 – IPv4 address – optional
- addr_ipv6 – IPv6 address – optional
- server – at least 2 required
- tech_c – technical contact ID – required
Return Values
- 1000 = OK, NSSET змінено
- 2201 = указано неправильний TLD
- 2209 = синтаксична помилка
- 2210 = недійсний формат списку DNS-серверів
- 2211 = забагато DNS-серверів
- 2216 = недійсний синтаксис у контакті
- 2247 = недійсний NSSET
- 3214 = помилка – NSSET не завантажено
- 3228 = не підтримує роботу з контактами
- 3229 = помилка завантаження контакту
- 3242 = NSSET не підтримується для цього домену
- 3252 = помилка авторизації
- 3254 = Не вдалося змінити NSSET
- 4204 = NSSET недоступний – помилка з’єднання
- 4220 = Не вдалося змінити NSSET – помилка з’єднання
- 4212 = контакт недоступний – помилка з’єднання
Return Data
The request returns no data.
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-update",
"clTRID": "your ID",
"data": {
"tld": "cz",
"name": "NSSET name",
"auth_info": "NSSET AUTH-ID",
"dns": {
"server1": {
"name": "DNS server name"
},
"server2": {
"name": "DNS server name"
}
},
"tech_c": "technical contact ID"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-update"
}
}
nsset-transfer
The nsset-transfer request changes the NSSET registrar to WEDOS.
Parameters
- tld – TLD
- name – NSSET name
- auth_info – NSSET AUTH-ID
Return Values
- 1000 = OK
- 2100 = відсутній обов’язковий параметр
- 2101 = недійсні вхідні параметри
- 2201 = непідтримуваний TLD
- 2209 = синтаксична помилка
- 2215 = відсутній auth_info
- 2247 = недійсна назва NSSET
- 2249 = Перенесення NSSET не дозволено для цього TLD
- 3214 = помилка – NSSET не завантажено
- 3242 = NSSET не підтримується
- 3251 = NSSET уже зареєстровано в цього реєстратора
- 3255 = помилка авторизації
- 3256 = Не вдалося перенести NSSET
- 4204 = NSSET не завантажено – помилка з’єднання
- 4221 = Не вдалося перенести NSSET – помилка з’єднання
Return Data
The request returns no data.
Templates
JSON command:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-transfer",
"clTRID": "your ID",
"data": {
"tld": "cz",
"name": "NSSET name",
"auth_info": "NSSET AUTH-ID"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-transfer"
}
}
nsset-send-auth-info
The nsset-send-auth-info request sends the NSSET AUTH-ID to the NSSET technical contact email.
Parameters
- tld – TLD
- name – NSSET name
Return Values
- 1000 = OK, auth_info надіслано на контактну електронну адресу
- 2201 = непідтримуваний TLD
- 2209 = Синтаксична помилка NSSET
- 2216 = синтаксична помилка контакту
- 2243 = для цього NSSET надсилання коду авторизації не дозволено
- 2247 = непідтримуваний формат NSSET
- 3214 = помилка – не вдалося прочитати NSSET
- 3217 = не вдалося надіслати код авторизації
- 3228 = не підтримує роботу з контактами
- 3229 = не вдалося прочитати контакт
- 3242 = NSSET недоступний
- 3257 = не вдалося надіслати, NSSET недоступний
- 4204 = NSSET недоступний – не вдалося встановити з’єднання
- 4212 = контакт недоступний – не вдалося встановити з’єднання
- 4222 = не вдалося надіслати – не вдалося з’єднатися
Return Data
The request returns no data.
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "nsset-send-auth-info",
"clTRID": "your ID",
"data": {
"tld": "cz",
"name": "NSSET name"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "nsset-send-auth-info"
}
}