REST API – NSSETy domén

GET /nssets/check

Kontroluje, či je handle NSSET voľný na použitie a aký je jeho stav v registri.

Parametre:

• tld – povinný, query, string – TLD, pre ktorú sa NSSET kontroluje
• name – povinný, query, string – handle NSSET
• reg_key – voliteľný, query, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – NSSET je dostupný na registráciu
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2247 – nepodporovaný formát NSSET
• 3242 – NSSET nie je dostupný
• 3245 – NSSET je už zaregistrovaný
• 3248 – NSSET nie je dostupný – karanténa
• 3249 – NSSET nie je dostupný – rezervovaný
• 3250 – NSSET nie je dostupný – blokovaný
• 3251 – NSSET je už zaregistrovaný u nás
• 4218 – kontrola zlyhala – chyba komunikácie
• 5001 – interná chyba autentizácie

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/check?tld=cz&name=NSSET'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g1"
}

GET /nssets/{name}

Vráti podrobné informácie o NSSET vrátane jeho DNS serverov.

Parametre:

• name – povinný, path – handle NSSET
• tld – povinný, query, string – TLD
• reg_key – voliteľný, query, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – neplatná TLD
• 2209 – syntaktická chyba
• 2247 – nepodporovaný formát NSSET
• 3214 – nepodarilo sa načítať NSSET
• 3242 – NSSET nie je dostupný
• 4204 – chyba spojenia

Dáta odpovede:

• nsset – objekt s údajmi NSSET:
  • name – handle NSSET
  • status – stav NSSET v registri
  • reg_owner, reg_creator, reg_update – identifikátory registrátora
  • created_date, updated_date, transfer_date – dátumy vytvorenia/aktualizácie/prenosu
  • tech_c – identifikátor technického kontaktu
  • dns.server – pole DNS serverov NSSET (name, addr_ipv4, addr_ipv6)

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/NSSET?tld=cz'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g2",
  "data": {
    "nsset": {
      "name": "NSSET",
      "status": "ok",
      "tech_c": "CONTACT",
      "created_date": "2024-01-10",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      }
    }
  }
}

POST /nssets

Vytvorí nový NSSET.

Parametre:

• tld – povinný, string – TLD, pre ktorú sa NSSET vytvára
• name – voliteľný, string – požadovaný handle NSSET; ak nie je uvedený, vygeneruje sa automaticky
• dns – povinný, array – pole DNS serverov v tvare [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 sú pre každý server voliteľné; rovnaký tvar ako pri POST /domains/create)
• tech_c – voliteľný, string – identifikátor technického kontaktu; ak nie je uvedený, použije sa predvolený
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK, NSSET vytvorený
• 2100 – chýba povinný parameter
• 2101 – neplatný formát vstupných parametrov
• 2201 – nesprávne zadaná TLD
• 2210 – neplatný formát poľa DNS serverov
• 2211 – príliš veľa DNS serverov
• 2216 – neplatná syntax kontaktu
• 2247 – nepodporovaný formát NSSET
• 3228 – register nepodporuje kontakty
• 3229 – chyba pri načítaní kontaktu
• 3242 – NSSET nie je dostupný
• 3244 – vytvorenie NSSET zlyhalo
• 3245 – NSSET je už zaregistrovaný
• 4212 – chyba spojenia
• 4218, 4219 – kontrola/vytvorenie zlyhalo – chyba komunikácie

Dáta odpovede:

• nsset – handle vytvoreného NSSET

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets' \
  --data '{
    "tld": "cz",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g3",
  "data": {
    "nsset": "NSSET"
  }
}

POST /nssets/{name}/transfer

Prenáša NSSET k nám od iného registrátora.

Parametre:

• name – povinný, path – handle NSSET
• tld – povinný, string – TLD
• auth_info – povinný, string – autorizačný kód NSSET
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – nepodporovaná TLD
• 2215 – auth_info chýba
• 2247 – neplatný názov NSSET
• 2249 – prenos NSSET nie je pre túto TLD povolený
• 3214 – nepodarilo sa načítať NSSET
• 3242 – NSSET nie je podporovaný
• 3251 – NSSET je už zaregistrovaný u cieľového registrátora
• 3255 – chyba autorizácie
• 3256 – prenos NSSET zlyhal
• 4221 – prenos zlyhal – chyba spojenia

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g4"
}

POST /nssets/{name}/auth-info/send

Odosiela autorizačný kód NSSET na e-mail technického kontaktu.

Parametre:

• name – povinný, path – handle NSSET
• tld – povinný, string – TLD
• reg_key – voliteľný, string – identifikátor konkrétneho registra

Návratové kódy:

• 1000 – OK, autorizačný kód odoslaný na kontaktný e-mail
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – nepodporovaná TLD
• 2243 – odoslanie autorizačného kódu nie je pre tento NSSET povolené
• 3214 – nepodarilo sa načítať NSSET
• 3217 – odoslanie autorizačného kódu zlyhalo
• 3242 – NSSET nie je dostupný
• 4222 – odoslanie zlyhalo – chyba spojenia
• 5001 – interná chyba autorizácie

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/auth-info/send' \
  --data '{"tld": "cz"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g5"
}

PATCH /nssets/{name}

Upravuje existujúci NSSET – jeho DNS servery, technický kontakt alebo rozsah testov.

Parametre:

• name – povinný, path – handle NSSET
• tld – povinný, string – TLD
• dns – povinný, array – pole DNS serverov v rovnakom tvare ako pri POST /nssets
• auth_info – povinný, string – autorizačný kód NSSET
• tech_c – voliteľný, string – identifikátor technického kontaktu; ak nie je uvedený, zostane nezmenený
• reg_key – voliteľný, string – identifikátor konkrétneho registra
• report_level – voliteľný – rozsah testov, ktoré register vykoná pri úprave

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatné vstupné parametre
• 2201 – nesprávne zadaná TLD
• 2209 – syntaktická chyba
• 2210 – neplatný formát poľa DNS serverov
• 2211 – príliš veľa DNS serverov
• 2216 – neplatná syntax kontaktu
• 2247 – neplatný NSSET
• 3214 – nepodarilo sa načítať NSSET
• 3242 – túto doménu/register NSSET nepodporuje
• 3252 – chyba autorizácie
• 3254 – úprava NSSET zlyhala
• 4204, 4220 – NSSET nie je dostupný/úprava zlyhala – chyba spojenia
• 4212 – kontakt nie je dostupný – chyba spojenia

Dáta odpovede: Žiadne – výsledok nesie priamo odpoveď v poliach code/msg.

Príklad:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET-1' \
  --data '{
    "tld": "cz",
    "auth_info": "AUTHCODE123",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g6"
}