WAPI – NSSET

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

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 is available for registration
  • 2201 = invalid TLD
  • 2247 = unsupported NSSET format
  • 3242 = NSSET is unavailable
  • 3245 = NSSET is already registered
  • 3246 = unavailable
  • 3247 = unavailable
  • 3248 = unavailable – quarantine
  • 3249 = unavailable – reserved
  • 3250 = unavailable – blocked
  • 3251 = already registered (with us)
  • 4218 = sending failed – communication error

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 = invalid TLD
  • 2209 = syntax error
  • 2247 = unsupported NSSET format 
  • 3214 = error – NSSET not loaded
  • 3242 = NSSET is unavailable
  • 4204 = connection error, try again later

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
  • tech_c – technical contact – optional

Return Values

  • 1000 = OK, NSSET created
  • 2201 = wrong TLD entered
  • 2210 = invalid format of ns servers
  • 2211 = too much ns servers
  • 2216 = invalid syntax in technical contact 
  • 2247 = unsupported NSSET format 
  • 3228 = not support working with contacts
  • 3229 = error loading contact
  • 3242 = NSSET is unavailable
  • 3244 = NSSET creation failed
  • 3245 = NSSET is already registered
  • 3246 = unavailable
  • 3247 = unavailable
  • 3248 = unavailable – quarantine
  • 3249 = unavailable – reserved
  • 3250 = unavailable – blocked
  • 3251 = already registered
  • 4212 = connection error
  • 4218 = check failed – communication error
  • 4219 = creation failed – communication error

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
  • name – NSSET name
  • dns – list of ns servers, each server entry contains information about that ns server
    • server
      • name – server domain name
      • addr_ipv4 – IPv4 address
      • addr_ipv6 – IPv6 address
  • tech_c – technical contact ID – optional

Return Values

  • 1000 = OK, NSSET modified
  • 2201 = entered wrong TLD
  • 2209 = syntax error
  • 2210 = invalid format of list of dns servers
  • 2211 = too many dns servers
  • 2216 = invalid syntax in contact
  • 2247 = invalid NSSET
  • 3214 = error – NSSET not loaded
  • 3228 = not support working with contacts
  • 3229 = error loading contact
  • 3242 = NSSET is not supported for this domain 
  • 3252 = authorization error
  • 3254 = NSSET modification failed nsset
  • 4204 = NSSET is unavailable – connection error
  • 4220 = NSSET modification failed – connection error
  • 4212 = contact is unavailable – connection error

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",
      "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-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 = required parameter is missing
  • 2101 = invalid input parameters
  • 2201 = unsupported TLD
  • 2209 = syntax error
  • 2215 = missing auth_info
  • 2247 = invalid NSSET name 
  • 2249 = NSSET transfer is  not allowed for this TLD
  • 3214 = error – NSSET not loaded
  • 3242 = NSSET not supported
  • 3251 = NSSET is already registered with this registrar 
  • 3255 = authorization error
  • 3256 = NSSET transfer failed
  • 4204 = NSSET not loaded – connection error
  • 4221 = NSSET transfer failed – connection error

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 sent to the contact e-mail
  • 2201 = unsupported TLD
  • 2209 =  NSSET syntax error
  • 2216 = contact syntax error
  • 2243 = for this NSSET is not allowed to send the authorization code
  • 2247 = unsupportes NSSET format
  • 3214 = error – NSSET read failed
  • 3217 = sending of authorization code failed
  • 3228 = does not support working with contacts
  • 3229 = contact read failed
  • 3242 = NSSET is not available
  • 3257 = sending failed, NSSET is not available
  • 4204 = NSSET is not available – connection failed
  • 4212 = contact is not available – connection failed
  • 4222 = sending failed – connection failed

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"
  }
}

Was this helpful?

Thanks for your feedback!
Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Article TOC
Browse Categories