REST API – Domény

GET /domains

Vráti zoznam všetkých domén prihláseného zákazníka, voliteľne filtrovaný podľa stavu. Ekvivalentná cesta GET /domains/list robí to isté (bez zmeny správania, iba alternatívny tvar URL).

Parametre:

• status – voliteľný, query, string – vráti iba domény v danom stave; ak nie je uvedený, vrátia sa domény vo všetkých stavoch

Návratové kódy:

• 1000 – OK
• 2101 – neplatný formát parametra status
• 2242 – neznámy stav domény
• 5001 – nikto nie je prihlásený

Dáta odpovede:

• domain – pole domén zákazníka; každá položka obsahuje:
  • name – názov domény
  • status – stav domény

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains?status=active'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active" },
      { "name": "domain2.tld", "status": "active" }
    ]
  }
}

GET /domains/{name}

Vráti podrobné informácie o jednej doméne podľa jej názvu v ceste URL.

Parametre:

• name – povinný, path – názov domény

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 3216 – chyba pri načítaní informácií o doméne
• 3222 – nepodarilo sa načítať objekt domény
• 3223 – doména je v inom zákazníckom účte
• 4205 – chyba spojenia s registrom

Dáta odpovede:

• domain – objekt s informáciami o doméne:
  • name – názov domény
  • status – stav domény v registri
  • reg_owner, reg_creator, reg_update – identifikátory registrátora (náš/iný)
  • setup_date, expiration, updated_date, transfer_date – dátumy registrácie/expirácie/aktualizácie
  • owner_c, admin_c, tech_c – identifikátory priradených kontaktov (podľa registra)
  • dns.server – pole nastavených DNS serverov (name, addr_ipv4, addr_ipv6)
  • dnssec_keys – nastavené DNSSEC kľúče (ak existujú)
  • own_* (own_name, own_company, own_email, own_addr_street, …) – snímka údajov kontaktu vlastníka v čase dotazu

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domena1.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d5",
  "data": {
    "domain": {
      "name": "domena1.tld",
      "status": "active",
      "reg_owner": "WEDOS",
      "setup_date": "2024-01-10",
      "expiration": "2027-01-10",
      "owner_c": "CONTACT-1",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      },
      "own_name": "Esmeralda Excavadora",
      "own_email": "esmeralda@wedos.com"
    }
  }
}

GET /domains/info

Funkčne rovnaké ako GET /domains/{name}, ale umožňuje cez query parameter získať informácie o viacerých doménach naraz (názvy oddelené čiarkami).

Parametre:

• name – povinný, query, string – názov domény alebo viac názvov oddelených čiarkami (bez medzier)

Návratové kódy:

• 1000 – OK (pri dotazoch na viac domén vracia API vždy tento kód; výsledok pre každú doménu je vo vlastnom uzle, pozri nižšie)
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 3216, 3222, 3223, 4205 – pozri GET /domains/{name}

Dáta odpovede:

• Pre jednu doménu: domain – objekt s rovnakou štruktúrou ako GET /domains/{name}
• Pre viac domén: domain – pole objektov, pričom každý navyše obsahuje code (návratový kód spracovania danej domény) a result (jeho textový popis). Pri hromadnom dotaze sa stav spracovania sleduje pre každú doménu zvlášť, nie na úrovni celej odpovede.

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/info?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d6",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active", "expiration": "2027-01-10" },
      { "name": "domain2.tld", "code": 3223, "result": "Domain belongs to another account" }
    ]
  }
}

GET /domains/check

Kontroluje, či sú jedna alebo viaceré domény dostupné na registráciu (u nás, prípadne všeobecne podľa dostupnosti v registri).

Parametre:

• name – povinný, query, string – názov domény alebo viac názvov oddelených čiarkami

Návratové kódy:

• 1000 – doména je dostupná na registráciu (pri dotazoch na viac domén vracia API vždy tento kód; výsledok pre každú doménu je vo vlastnom uzle, pozri nižšie)
• 2100 – parameter name chýba
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 2250 – prekročený limit kontrol (zablokované)
• 2251 – kontrola limitu zlyhala
• 3201 – doména je už zaregistrovaná
• 3203 – doména nie je dostupná
• 3204 – doména je v karanténe
• 3205 – doména je rezervovaná
• 3206 – doména je blokovaná (dôvod – premium/ochranná známka/rezervácia/krátky názov – je uvedený v textovom popise)
• 4201 – kontrola zlyhala – chyba spojenia s registrom
• ďalšie stavové kódy špecifické pre kontrolu dostupnosti

Dáta odpovede:

• Pre jednu doménu: name – zadaný názov domény (výsledok kontroly nesie priamo odpoveď v poliach code/msg)
• Pre viac domén: pole objektov, každý s name, code (výsledok kontroly danej domény) a result (jeho textový popis)

Príklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/check?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d7",
  "data": [
    { "name": "domain1.tld", "code": 3201, "result": "Domain is already registered" },
    { "name": "domain2.tld", "code": 1000, "result": "OK" }
  ]
}

GET /domains/{name}/transfer/check

Kontroluje, či je možné doménu preniesť k nám od iného registrátora, bez nutnosti poznať autorizačný kód.

Parametre:

• name – povinný, path – názov domény

Návratové kódy:

• 1000 – doménu je možné preniesť
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 3207 – doména je už zaregistrovaná u nás
• 3208 – nie je možné preniesť, expirácia je príliš blízko
• 3266 – nie je možné preniesť, doména expirovala
• 4206 – chyba spojenia s registrom

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/domains/domain1.tld/transfer/check'

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

GET /domains/tld-periods

Kontroluje, či je možné doménu pod danou TLD zaregistrovať/predĺžiť na daný počet rokov.

Parametre:

• tld – povinný, query, string – TLD (bez bodky, napr. cz)
• period – povinný, query, integer – požadované obdobie v rokoch

Návratové kódy:

• 1000 – OK, obdobie je pre TLD platné
• 2100 – chýba vstupný parameter
• 2101 – neplatné vstupné parametre
• 2203 – obdobie nie je pre TLD platné

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/domains/tld-periods?tld=eu&period=1'

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

POST /domains/create

Registruje novú doménu. Musíte uviesť práve jeden z parametrov dns alebo nsset (nastavenie DNS/NSSET domény), nikdy oba.

Parametre:

• name – povinný, string – názov domény na registráciu
• period – povinný, integer – dĺžka registrácie v rokoch
• owner_c – povinný, string – identifikátor (handle) kontaktu vlastníka domény
• admin_c – voliteľný, string – identifikátor administratívneho kontaktu
• dns – voliteľný, 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é); vzájomne sa vylučuje s nsset
• nsset – voliteľný, string – handle existujúceho NSSET, ktorý sa priradí doméne (iba pre registre, ktoré NSSET podporujú, napr. .cz); vzájomne sa vylučuje s dns
• rules – voliteľný, array – potvrdenie súhlasu s pravidlami registrácie (povinné iba pre TLD, ktoré to vyžadujú)

Návratové kódy:

• 1000 – OK, doména zaregistrovaná
• 1001 – požiadavka prijatá, dokončí sa asynchrónne
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 2203 – neplatné obdobie
• 2204 – parameter owner_c chýba
• 2207 – neplatný formát parametra owner_c
• 2208 – neplatný formát parametra admin_c
• 2209 – syntaktická chyba NSSET
• 2210 – syntaktická chyba DNS servera
• 2211 – príliš veľa DNS serverov
• 2245 – nebol udelený súhlas s podmienkami registrácie
• 3001 – neplatná mena
• 3002 – nedostatočný kredit
• 3211 – kontakt owner_c nie je dostupný
• 3212 – kontakt admin_c nie je dostupný
• 3221 – vytvorenie domény zlyhalo
• 4002 – odpočítanie kreditu z účtu zlyhalo
• ďalšie chybové kódy špecifické pre registráciu domény

Dáta odpovede:

• num – číslo objednávky
• expiration – dátum expirácie domény
• credit – zostatok kreditu po zaplatení

Príklad:

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

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e1",
  "data": {
    "num": "202610010001",
    "expiration": "2027-10-01",
    "credit": "1234.50"
  }
}

POST /domains/{name}/renew

Predlžuje registráciu domény o daný počet rokov. Pre domény .eu to nie je možné – predlžujú sa automaticky.

Parametre:

• name – povinný, path – názov domény
• period – povinný, integer – počet rokov na predĺženie

Návratové kódy:

• 1000 – OK
• 1001 – požiadavka prijatá, dokončí sa asynchrónne
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2203 – neplatné obdobie
• 2269 – už existuje nezaplatené (nové) obdobie
• 3001 – neplatná mena
• 3002 – nedostatočný kredit
• 3222 – nepodarilo sa otvoriť doménu
• 3223 – doména nepatrí do tohto zákazníckeho účtu
• 3224 – predĺženie domény zlyhalo
• 3265 – doménu teraz nie je možné predĺžiť – počet dní do expirácie presahuje povolený limit
• 4208 – predĺženie zlyhalo – chyba spojenia

Dáta odpovede:

• num – číslo objednávky
• expiration – nový dátum expirácie domény
• credit – zostatok kreditu po zaplatení

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/renew' \
  --data '{"period": 1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e2",
  "data": {
    "num": "202610010002",
    "expiration": "2028-10-01",
    "credit": "1134.50"
  }
}

POST /domains/{name}/transfer

Prenáša doménu k nám od iného registrátora. Parameter dns funguje takto: ak nie je v požiadavke uvedený vôbec, automaticky sa preberie aktuálne nastavenie DNS serverov domény; false alebo prázdne pole nastaví predvolené servery WEDOS; pole objektov nastaví konkrétne servery.

Parametre:

• name – povinný, path – názov domény
• auth_info – povinný, string – autorizačný kód domény (transfer kód)
• owner_c – voliteľný, string – identifikátor kontaktu vlastníka (povinný iba pre TLD, kde to register vyžaduje)
• dns – voliteľný, array – pole DNS serverov v rovnakom tvare ako pri POST /domains/create
• rules – voliteľný, array – potvrdenie súhlasu s pravidlami (iba pre TLD, ktoré to vyžadujú)

Návratové kódy:

• 1000 – prenos prebehol úspešne
• 1001 – požiadavka prijatá, vykoná sa asynchrónne
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 2204 – chýba identifikátor kontaktu vlastníka
• 2207 – neplatný identifikátor kontaktu vlastníka
• 2210 – neplatný formát DNS servera
• 2215 – auth_info chýba, pričom je pre túto TLD povinný
• 3001 – neplatná mena
• 3207 – doména je už zaregistrovaná u nás
• 3208 – nie je možné preniesť, expirácia je príliš blízko
• 3219 – pre túto doménu existuje čakajúca požiadavka na prenos
• 3220 – doména je už v našej evidencii
• 3226 – prenos domény zlyhal
• 3227 – chyba autorizácie v registri domén
• 3266 – nie je možné preniesť, doména expirovala
• ďalšie chybové kódy špecifické pre prenos domény

Dáta odpovede:

• num – číslo objednávky
• expiration – dátum expirácie domény
• credit – zostatok kreditu po zaplatení

Príklad:

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

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e3",
  "data": {
    "num": "202610010003",
    "expiration": "2027-10-01",
    "credit": "1134.50"
  }
}

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

Odosiela autorizačný kód domény (transfer kód) na e-mail kontaktu vlastníka domény.

Parametre:

• name – povinný, path – názov domény

Návratové kódy:

• 1000 – OK, autorizačný kód odoslaný na e-mail vlastníka domény
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• 2243 – odoslanie autorizačného kódu nie je pre túto doménu povolené
• 3209 – odoslanie autorizačného kódu zlyhalo
• 3210 – odoslanie zlyhalo – doména nie je dostupná
• 3222 – nepodarilo sa načítať doménu
• 3223 – doména nepatrí do tohto zákazníckeho účtu
• 4214 – odoslanie zlyhalo – chyba spojenia

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

Príklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domain1.cz/auth-info/send'

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

PATCH /domains/{name}/nsset/update

Nastaví doméne nové DNS servery alebo ju naviaže na existujúci NSSET. Musíte uviesť práve jeden z parametrov dns alebo nsset, nikdy oba.

Parametre:

• name – povinný, path – názov domény
• dns – voliteľný, array – pole DNS serverov v rovnakom tvare ako pri POST /domains/create; vzájomne sa vylučuje s nsset
• nsset – voliteľný, string – handle existujúceho NSSET; vzájomne sa vylučuje s dns

Návratové kódy:

• 1000 – OK
• 1001 – OK, vykonané asynchrónne
• 2100 – chýba povinný parameter (nie je uvedený ani dns ani nsset )
• 2101 – neplatné parametre (uvedené sú dns a nsset naraz, alebo neplatný formát)
• 2201 – nepodporovaná TLD
• 2202 – neplatný názov domény
• 2209 – syntaktická chyba NSSET
• 2210 – syntaktická chyba DNS servera
• 2211 – príliš veľa DNS serverov
• 3214 – NSSET nie je dostupný
• 3222 – nepodarilo sa otvoriť doménu
• 3223 – doména patrí do iného zákazníckeho účtu
• 3225 – aktualizácia DNS/NSSET zlyhala
• 3315 – doména má už nastavené rovnaké NS servery
• 4204 – chyba spojenia (NSSET)
• 4210 – chyba spojenia (DNS)

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/domains/domain1.tld/nsset/update' \
  --data '{
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

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

PATCH /domains/{name}/keyset/update

Nastaví, vypne alebo prepne DNSSEC pre doménu.

Parametre:

• name – povinný, path – názov domény
• keyset – povinný – nastavenie DNSSEC:
  • 0 – DNSSEC vypnutý
  • 1 – DNSSEC spravovaný WEDOS
  • akýkoľvek iný reťazec – handle vlastného KEYSET zákazníka

Návratové kódy:

• 1000 – OK
• 2100 – chýba povinný parameter
• 2101 – neplatný formát parametra
• 2201 – nepodporovaná TLD
• 2202 – neplatný formát názvu domény
• ďalšie chybové kódy špecifické pre nastavenie DNSSEC

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/domains/domain1.tld/keyset/update' \
  --data '{"keyset": 1}'

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