REST API – NSSETy domén

GET /nssets/check

Kontroluje, zda je handle NSSETu volný k použití a jaký má stav v registru.

Parametry:

• tld – povinný, query, string – TLD, pro kterou se NSSET kontroluje
• name – povinný, query, string – handle NSSETu
• reg_key – volitelný, query, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – NSSET je dostupný k registraci
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2247 – nepodporovaný formát NSSETu
• 3242 – NSSET není dostupný
• 3245 – NSSET je již registrovaný
• 3248 – NSSET není dostupný – karanténa
• 3249 – NSSET není dostupný – rezervovaný
• 3250 – NSSET není dostupný – blokovaný
• 3251 – NSSET je již registrovaný u nás
• 4218 – kontrola se nezdařila – chyba komunikace
• 5001 – interní chyba autentizace

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Pří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}

Vrací podrobné informace o NSSETu včetně jeho DNS serverů.

Parametry:

• name – povinný, path – handle NSSETu
• tld – povinný, query, string – TLD
• reg_key – volitelný, query, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – neplatná TLD
• 2209 – chyba syntaxe
• 2247 – nepodporovaný formát NSSETu
• 3214 – nepodařilo se načíst NSSET
• 3242 – NSSET není dostupný
• 4204 – chyba spojení

Data odpovědi:

• nsset – objekt s údaji NSSETu:
  • name – handle NSSETu
  • status – stav NSSETu v registru
  • reg_owner, reg_creator, reg_update – identifikátory registrátora
  • created_date, updated_date, transfer_date – data vytvoření/aktualizace/přeregistrace
  • tech_c – identifikátor technického kontaktu
  • dns.server – pole DNS serverů NSSETu (name, addr_ipv4, addr_ipv6)

Pří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

Vytvoří nový NSSET.

Parametry:

• tld – povinný, string – TLD, pro kterou se NSSET vytváří
• name – volitelný, string – požadovaný handle NSSETu; pokud není uveden, vygeneruje se automaticky
• dns – povinný, array – pole DNS serverů ve tvaru [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 jsou u každého serveru volitelné; stejný tvar jako u POST /domains/create)
• tech_c – volitelný, string – identifikátor technického kontaktu; pokud není uveden, použije se výchozí
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK, NSSET vytvořen
• 2100 – chybí povinný parametr
• 2101 – neplatný formát vstupního parametru
• 2201 – chybně zadaná TLD
• 2210 – neplatný formát pole DNS serverů
• 2211 – příliš mnoho DNS serverů
• 2216 – neplatná syntaxe kontaktu
• 2247 – nepodporovaný formát NSSETu
• 3228 – registr nepodporuje kontakty
• 3229 – chyba při načítání kontaktu
• 3242 – NSSET není dostupný
• 3244 – vytvoření NSSETu se nezdařilo
• 3245 – NSSET je již registrovaný
• 4212 – chyba spojení
• 4218, 4219 – kontrola/vytvoření se nezdařilo – chyba komunikace

Data odpovědi:

• nsset – handle vytvořeného NSSETu

Pří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

Přeregistruje NSSET k nám od jiného registrátora.

Parametry:

• name – povinný, path – handle NSSETu
• tld – povinný, string – TLD
• auth_info – povinný, string – autorizační kód NSSETu
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – nepodporovaná TLD
• 2215 – auth_info chybí
• 2247 – neplatný název NSSETu
• 2249 – přeregistrace NSSETu není pro tuto TLD povolena
• 3214 – nepodařilo se načíst NSSET
• 3242 – NSSET není podporován
• 3251 – NSSET je již registrovaný u cílového registrátora
• 3255 – chyba autorizace
• 3256 – přeregistrace NSSETu se nezdařila
• 4221 – přeregistrace se nezdařila – chyba spojení

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Pří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

Odešle autorizační kód NSSETu na e-mail technického kontaktu.

Parametry:

• name – povinný, path – handle NSSETu
• tld – povinný, string – TLD
• reg_key – volitelný, string – identifikátor konkrétního registru

Návratové kódy:

• 1000 – OK, autorizační kód odeslán na kontaktní e-mail
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – nepodporovaná TLD
• 2243 – odeslání autorizačního kódu není pro tento NSSET povoleno
• 3214 – nepodařilo se načíst NSSET
• 3217 – odeslání autorizačního kódu se nezdařilo
• 3242 – NSSET není dostupný
• 4222 – odeslání se nezdařilo – chyba spojení
• 5001 – interní chyba autorizace

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Pří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}

Upraví existující NSSET – jeho DNS servery, technický kontakt nebo rozsah testů.

Parametry:

• name – povinný, path – handle NSSETu
• tld – povinný, string – TLD
• dns – povinný, array – pole DNS serverů ve stejném tvaru jako u POST /nssets
• auth_info – povinný, string – autorizační kód NSSETu
• tech_c – volitelný, string – identifikátor technického kontaktu; pokud není uveden, zůstává beze změny
• reg_key – volitelný, string – identifikátor konkrétního registru
• report_level – volitelný – rozsah testů, které registr při úpravě provádí

Návratové kódy:

• 1000 – OK
• 2100 – chybí povinný parametr
• 2101 – neplatné vstupní parametry
• 2201 – chybně zadaná TLD
• 2209 – chyba syntaxe
• 2210 – neplatný formát pole DNS serverů
• 2211 – příliš mnoho DNS serverů
• 2216 – neplatná syntaxe kontaktu
• 2247 – neplatný NSSET
• 3214 – nepodařilo se načíst NSSET
• 3242 – NSSET není touto doménou/registrem podporován
• 3252 – chyba autorizace
• 3254 – úprava NSSETu se nezdařila
• 4204, 4220 – NSSET není dostupný / úprava se nezdařila – chyba spojení
• 4212 – kontakt není dostupný – chyba spojení

Data odpovědi: Žádná – výsledek nesou přímo pole odpovědi code/msg.

Pří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"
}