WEDOS REST API je stále vo vývoji. Prístup a funkcie sa môžu bez predchádzajúceho upozornenia zmeniť.
Tento článok popisuje DNS endpoint WEDOS REST API. Pre WEDOS API (WAPI) pozri WAPI – WEDOS DNS.
Základné informácie o WEDOS REST API nájdete v článku WEDOS REST API Manuál.
V tomto článku nájdete nasledujúce informácie:
- Prístup k DNS endpointu
- Podrobnosti DNS endpointu:
- GET /domains
- GET /domains/{domain}
- GET /domains/{domain}/axfr-tsig
- GET /domains/{domain}/rows
- GET /domains/{domain}/rows/{row_id}
- POST /domains/add
- POST /domains/{domain}/commit
- POST /domains/{domain}/copy
- POST /domains/{domain}/axfr-run
- POST /domains/{domain}/axfr-tsig
- POST /domains/{domain}/rows
- POST /domains/{domain}/zone-import
- PATCH /domains/{domain}
- PATCH /domains/{domain}/rows/{row_id}
- DELETE /domains/{domain}
- DELETE /domains/{domain}/rows/{row_id}
- Poznámky
Prístup k DNS endpointu
WDNS HTTP REST API v2 slúži na správu DNS domén a ich DNS záznamov v službe WEDOS DNS (WDNS). API sa riadi princípmi REST a komunikuje cez JSON.
Základné URL a autentizácia
Základné URL pre DNS endpointy je: https://api.wedos.com/v2/dns
Na autentizáciu slúži iba OAuth2 Bearer token odoslaný v hlavičke Authorization: Bearer <TOKEN>. Token musí mať scope wdns . Bez platného tokenu alebo s tokenom bez potrebného scope vráti API chybu autentizácie.
Každý endpoint podporuje režim ?example=1 (alebo &example=1 ak URL už obsahuje iné parametre dotazu). Vráti ukážkové volanie (príkaz curl) pre daný endpoint bez nutnosti zadávať skutočné parametre. Aj v tomto režime je vyžadovaný platný token Bearer.
Prehľad endpointov
| Metóda | Endpoint | Popis |
|---|---|---|
| GET | /domains | Zoznam domén prihláseného používateľa s vyhľadávaním, filtrovaním, zoraďovaním a stránkovaním |
| GET | /domains/{domain} | Detail domény |
| GET | /domains/{domain}/axfr-tsig | Informácie o AXFR TSIG kľúči domény |
| GET | /domains/{domain}/rows | Zoznam DNS záznamov domény |
| GET | /domains/{domain}/rows/{row_id} | Detail jedného DNS záznamu |
| POST | /domains/add | Vytvorenie novej domény |
| POST | /domains/{domain}/commit | Uplatnenie čakajúcich zmien domény (commit) |
| POST | /domains/{domain}/copy | Vytvorenie kópie domény pod novým názvom |
| POST | /domains/{domain}/axfr-run | Okamžité spustenie AXFR prenosu (sekundárna doména) |
| POST | /domains/{domain}/axfr-tsig | Vytvorenie alebo zrušenie AXFR TSIG kľúča domény |
| POST | /domains/{domain}/rows | Pridanie DNS záznamu k doméne |
| POST | /domains/{domain}/zone-import | Import DNS záznamov domény (cez AXFR alebo vložením textu vo formáte BIND) |
| PATCH | /domains/{domain} | Zmena nastavenia domény |
| PATCH | /domains/{domain}/rows/{row_id} | Zmena existujúceho DNS záznamu |
| DELETE | /domains/{domain} | Zmazanie domény |
| DELETE | /domains/{domain}/rows/{row_id} | Zmazanie DNS záznamu |
Formát odpovede
Všetky úspešné aj chybové odpovede majú rovnaký tvar JSON objektu s týmito kľúčmi: code (návratový kód), msg (textový popis kódu), request_id (identifikátor požiadavky) a voliteľne data (dáta odpovede, iba ak ich operácia vracia).
GET /domains
Vracia zoznam domén prihláseného používateľa s podporou vyhľadávania, filtrovania, zoraďovania a stránkovania.
Parametre:
search– voliteľný, reťazec – vyhľadávanie v názve domény (podporuje IDN)status– voliteľný, reťazec – filter podľa stavu domény (napr.active,disabled,deleted)type– voliteľný, reťazec – filter podľa typu domény (primary,secondary)page– voliteľný, celé číslo – číslo stránky, predvolene 1page_limit– voliteľný, celé číslo – počet záznamov na stránku, predvolene 50orderby– voliteľný, reťazec – zoradenie v tvarecolumn [ASC|DESC]; podporované stĺpce súdomainacreated_date; predvolené jedomain ASC. Neplatný stĺpec sa ticho ignoruje a použije sa predvolené zoradenie.
Návratové kódy:
1000– OK5001– interná chyba prihlásenia
Dáta odpovede:
domain– pole domén; každá položka obsahujename,status,typetotal– celkový počet domén zodpovedajúcich filtrupage– aktuálna stránkapage_limit– počet záznamov na stránku
Príklad:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains?search=domain1&status=active&page=1&page_limit=50'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b70",
"data": {
"domain": [
{"name": "domain1.cz", "status": "active", "type": "primary"},
{"name": "domain1.com", "status": "active", "type": "secondary"}
],
"total": 2,
"page": 1,
"page_limit": 50
}
}
GET /domains/{domain}
Vracia podrobné informácie o doméne.
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény3222– nepodarilo sa otvoriť doménu (napr. neexistuje)3223– chyba autorizácie (doména patrí inému používateľovi)3305– doména je uzamknutá3306– doména je zmazaná5001– interná chyba prihlásenia
Dáta odpovede:
domain– objekt s podrobnosťami domény:name,status,type,tlock,autocommit,axfr_enabled,axfr_ips,changed,changed_date,commit_date,reload_pending,reload_pending_date,reload_date,disabled_date,enabled_date,add_date,rname,serial,refresh,retry,expire,minimum,rr_cnt,ns_out,ns
Príklad:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b71",
"data": {
"domain": {
"name": "domain1.tld",
"status": "active",
"type": "primary",
"tlock": 0,
"autocommit": 1,
"axfr_enabled": 0,
"axfr_ips": "",
"changed": 0,
"changed_date": null,
"commit_date": "2026-09-30 12:00:00",
"reload_pending": 0,
"reload_pending_date": null,
"reload_date": "2026-09-30 12:01:00",
"disabled_date": null,
"enabled_date": null,
"add_date": "2026-01-15 09:30:00",
"rname": "wedos.com",
"serial": 2026093001,
"refresh": 10800,
"retry": 3600,
"expire": 604800,
"minimum": 3600,
"rr_cnt": 12,
"ns_out": 1,
"ns": ["ns.wedos.cz", "ns.wedos.net", "ns.wedos.eu"]
}
}
}
GET /domains/{domain}/axfr-tsig
Vracia informácie o AXFR TSIG kľúči domény (slúži na autentizáciu DNS prenosov AXFR/IXFR). Ak nie je pre doménu TSIG nastavený, vráti endpoint chybu 2334.
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2334– AXFR TSIG nie je pre doménu nastavený2337– neplatný AXFR TSIG príkaz2340– prekročený maximálny počet domén v jednej hromadnej akcii- ďalšie chybové kódy súvisiace s otvorením domény – pozri GET /domains/{domain} (napr.
3222,3223,3305,3306)
Dáta odpovede:
name– názov doményaxfr_tsig_action– vykonaná akcia, vždyinfoaxfr_tsig_name– názov TSIG kľúčaaxfr_tsig_alg– algoritmus TSIG kľúčaaxfr_tsig_key– hodnota TSIG kľúča (base64)
Príklad:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/axfr-tsig'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b72",
"data": {
"name": "example.cz",
"axfr_tsig_action": "info",
"axfr_tsig_name": "domain1.tld.",
"axfr_tsig_alg": "hmac-sha256",
"axfr_tsig_key": "asdfghJKL1234567890."
}
}
GET /domains/{domain}/rows
Vracia zoznam DNS záznamov domény. Túto operáciu nemožno vykonať pre sekundárne domény (ich záznamy spravuje primárny server).
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2318– operáciu nemožno vykonať na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná5001– interná chyba prihlásenia
Dáta odpovede:
row– pole DNS záznamov, každý s kľúčmiID,name,ttl,rdtype,rdata,changed_date,author_comment
Príklad:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/rows'
{
"code": 1000,
"msg": "OK",
"request_id": "1d6e8a5f3b73",
"data": {
"row": [
{
"ID": 123,
"name": "www",
"ttl": 1800,
"rdtype": "A",
"rdata": "46.28.105.2",
"changed_date": "2026-09-30 12:00:00",
"author_comment": "production server"
},
{
"ID": 124,
"name": "",
"ttl": 3600,
"rdtype": "MX",
"rdata": "10 mail.wedos.com.",
"changed_date": "2026-09-30 12:00:00",
"author_comment": ""
}
]
}
}
GET /domains/{domain}/rows/{row_id}
Vracia detail jedného DNS záznamu domény.
Parametre:
domain– povinný, reťazec (path) – názov doményrow_id– povinný, celé číslo (path) – ID DNS záznamu
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2318– operáciu nemožno vykonať na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná3309– záznam s týmto ID neexistuje5001– interná chyba prihlásenia
Dáta odpovede:
row– objekt s podrobnosťami záznamu:ID,name,ttl,rdtype,rdata,changed_date,author_comment
Príklad:
curl -X GET -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/rows/123'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2",
"data": {
"row": {
"ID": 123,
"name": "www",
"ttl": 1800,
"rdtype": "A",
"rdata": "46.28.105.2",
"changed_date": "2026-09-30 12:00:00",
"author_comment": "production server"
}
}
}
POST /domains/add
Vytvorí novú doménu vo WDNS, buď ako primárnu doménu (DNS záznamy spravuje WEDOS), alebo ako sekundárnu doménu (záznamy sa prenášajú cez AXFR z externého primárneho servera).
Parametre:
name– povinný, reťazec – názov doménytype– voliteľný, reťazec –primaryalebosecondary, predvoleneprimaryaxfr_enabled– voliteľný, boolean (0/1) – povolený odchádzajúci AXFR, predvolene 0axfr_ips– voliteľný, reťazec alebo pole reťazcov – IP adresy povolené pre odchádzajúci AXFR (reťazec adries oddelených medzerami, alebo JSON pole adries); povinný, akaxfr_enabled=1primary_ip– voliteľný (povinný pretype=secondary), reťazec – IPv4 adresa primárneho servera, z ktorého sa záznamy prenášajúprimary_tsig_enabled– voliteľný, boolean – vyžaduje TSIG autentizáciu prichádzajúceho AXFR (iba pretype=secondary)primary_tsig_name– voliteľný (povinný, akprimary_tsig_enabled=1), reťazec – názov TSIG kľúčaprimary_tsig_alg– voliteľný (povinný, akprimary_tsig_enabled=1), reťazec – algoritmus TSIG kľúča; podporované hodnoty:hmac-md5,hmac-sha1,hmac-sha224,hmac-sha256,hmac-sha384,hmac-sha512primary_tsig_key– voliteľný (povinný, akprimary_tsig_enabled=1), reťazec – hodnota TSIG kľúča kódovaná v base64 (minimálna dĺžka dekódovaného kľúča 8 bajtov)template_id– voliteľný, celé číslo – ID šablóny použitej na vytvorenie domény; platí iba pretype=primary
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2301– neplatný formát parametratype2302– parameterprimary_ipchýba2303– neplatný formát parametraprimary_ip2304– neplatný formát parametraaxfr_enabled2305– povinný parameteraxfr_ipschýba2306– neplatný formát parametraaxfr_ips2322– prekročený limit WDNS domén pre tento účet2323– šablóna nenájdená2324– šablónu možno použiť iba na vytvorenie primárnej domény2325– nie je definovaná žiadna šablóna2330–2333– neplatná konfigurácia TSIG (celkovo, názov, algoritmus, kľúč)2355– AXFR IP adresa nie je platná2366–axfr_ipsreťazec je dlhší ako 255 znakov2367– nie je zadaná žiadna IP adresa pre odchádzajúci AXFR3302– pridanie domény do WDNS sa nepodarilo3303– doména už vo WDNS existuje5001– interná chyba autorizácie
Dáta odpovede:
domain_id– interné ID novo vytvorenej doményname– názov domény
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/add' \
--data '{"name":"domain1.tld","type":"primary"}'
Telo požiadavky:
{
"name": "domain1.tld",
"type": "primary"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b75",
"data": {
"domain_id": 48213,
"name": "domain1.tld"
}
}
POST /domains/{domain}/commit
Uplatní čakajúce zmeny domény (commit) a rozšíri ich na produkčné DNS servery.
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná5001– interná chyba autorizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/commit'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b76"
}
POST /domains/{domain}/copy
Vytvorí kópiu existujúcej domény (vrátane jej DNS záznamov) pod novým názvom.
Parametre:
domain– povinný, reťazec (path) – názov zdrojovej doményname_new– povinný, reťazec (telo požiadavky) – názov novej domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2320– neplatný alebo nepodporovaný názov novej domény2321– nepodporovaná TLD nového názvu domény2322– prekročený limit DNS záznamov na používateľa3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná3311– kopírovanie sa nepodarilo3312– doména s týmto názvom už existuje5001– interná chyba autorizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/copy' \
--data '{"name_new":"domain2.tld"}'
Telo požiadavky:
{
"name_new": "domain2.tld"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b77"
}
POST /domains/{domain}/axfr-run
Okamžite spustí AXFR prenos DNS záznamov pre sekundárnu doménu (mimo pravidelného rozvrhu).
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2319– možno vykonať iba na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná5001– interná chyba autorizácie
Dáta odpovede:
next_run– čas najbližšej plánovanej aktualizácie
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/axfr-run'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b78",
"data": {
"next_run": "2026-10-01 09:15:00"
}
}
POST /domains/{domain}/axfr-tsig
Vytvorí alebo zruší AXFR TSIG kľúč domény (autentizácia odchádzajúcich AXFR/IXFR prenosov).
Parametre:
domain– povinný, reťazec (path) – názov doményaction– voliteľný, reťazec (telo požiadavky) –create(vytvorenie/aktualizácia) alebocancel, predvolenecreate; hodnota sa interne mapuje na WAPI parameteraxfr_tsig_action
Návratové kódy:
1000– OK2335– AXFR TSIG nebol pre doménu vytvorený2336– AXFR TSIG nebol pre doménu zrušený2337– neplatný AXFR TSIG príkaz2340– prekročený maximálny počet domén v jednej hromadnej akcii- ďalšie chybové kódy súvisiace s otvorením domény – pozri GET /domains/{domain} (napr.
3222,3223,3305,3306)
Dáta odpovede:
name– názov doményaxfr_tsig_action– vykonaná akcia (create/cancel)axfr_tsig_name– názov TSIG kľúča (iba precreate)axfr_tsig_alg– algoritmus TSIG kľúča (iba precreate)axfr_tsig_key– hodnota TSIG kľúča, base64 (iba precreate)
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/axfr-tsig' \
--data '{"action":"create"}'
Telo požiadavky:
{
"action": "create"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b79",
"data": {
"name": "example.cz",
"axfr_tsig_action": "create",
"axfr_tsig_name": "example.cz.",
"axfr_tsig_alg": "hmac-sha256",
"axfr_tsig_key": "asdfghJKL1234567890"
}
}
POST /domains/{domain}/rows
Pridá k doméne nový DNS záznam.
Parametre:
domain– povinný, reťazec (path) – názov doményname– povinný, reťazec (telo požiadavky) – názov záznamu; prázdny reťazec znamená záznam na úrovni samotnej domény (apex)ttl– povinný, celé číslo (telo požiadavky) – TTL záznamu v sekundách, nenulová hodnotatype– povinný, reťazec (telo požiadavky) – typ záznamu; podporované hodnoty:A,AAAA,ALIAS,CAA,CNAME,DNAME,HTTPS,MX,NAPTR,NS,SRV,SSHFP,TLSA,TXTrdata– povinný, reťazec (telo požiadavky) – dáta záznamu (formát závisí od typu záznamu)author_comment– voliteľný, reťazec (telo požiadavky) – komentár autora; povolené sú iba písmená bez diakritiky, číslice a medzery; starší klienti môžu namiesto toho posielaťauth_comment(rovnocenný alias)
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2298– parameterauthor_commentobsahuje neplatné znaky2309– neplatný typ záznamu2310– k doméne nemožno pridať ďalší záznam (dosiahnutý limit záznamov)2311– neplatný názov záznamu2312– neplatný názov pre daný typ záznamu2313– neplatný CNAME pre tento názov2314– neplatné dáta záznamu2315– neplatná TLD2316– tento záznam už existuje2317– neplatná TTL2318– operáciu nemožno vykonať na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná3307– pridanie záznamu domény sa nepodarilo5001– interná chyba autorizácie
Dáta odpovede:
domain– názov doményrow_id– ID novo vytvoreného záznamu
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/rows' \
--data '{"name":"www","ttl":1800,"type":"A","rdata":"46.28.105.2"}'
Telo požiadavky:
{
"name": "www",
"ttl": 1800,
"type": "A",
"rdata": "46.28.105.2"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b80",
"data": {
"domain": "domain1.tld",
"row_id": 125
}
}
POST /domains/{domain}/zone-import
Importuje DNS záznamy domény. Podporované sú dva režimy (import_type):
axfr– endpoint sa pokúsi stiahnuť záznamy cez AXFR zo zadanej IP adresy a vráti ich ako text vo formáte BIND na ručnú kontrolu. Toto volanie záznamy neimportuje automaticky. Na ich import ich skopírujte a odošlite v samostatnom volaní simport_type=text.text– záznamy odovzdané vo formáte BIND v parametrirowssa overia a importujú priamo do domény.
Import je možný iba pre primárnu doménu.
Parametre:
domain– povinný, reťazec (path) – názov doményimport_type– povinný, reťazec (telo požiadavky) –axfralebotextaxfr_ip– povinný preimport_type=axfr, reťazec (telo požiadavky) – IPv4 adresa DNS servera, z ktorého sa záznamy stiahnu cez AXFRrows– povinný preimport_type=text, reťazec (telo požiadavky) – DNS záznamy ako text vo formáte BIND (nie JSON pole, ale jediný viacriadkový reťazec)
Návratové kódy:
1000– OK2338– nemáte oprávnenie upravovať túto doménu2350– neplatná hodnota typu importu2351– chýba zoznam DNS záznamov (rowsnebol zadaný simport_type=text)2352– zo zadanej IP sa nepodarilo získať žiadne dáta na import2353– importovaný zoznam DNS obsahuje neplatný záznam; import nebol vykonaný2354– chýba AXFR IP adresa2355– AXFR IP adresa nie je platná2357– z textu sa nepodarilo získať žiadne dáta na import2358– nemožno importovať 2 zhodné záznamy (názov, typ, dáta)2359– prekročený maximálny počet záznamov2360– záznam CNAME nemožno importovať, ak pre jeho názov existuje akýkoľvek iný záznam2363– záznamy rovnakého typu musia mať rovnakú TTL2364– DNS záznamy neboli importované (interná chyba importu)2365– AXFR IP adresa musí byť vo formáte IPv42368– import je povolený iba pre primárnu doménu
Dáta odpovede:
- pre
import_type=axfr:name,import_type,axfr_ip,desc(popisná poznámka),rows(stiahnuté záznamy vo formáte BIND, ohraničené--- BEGIN ---/--- END ---, určené na skopírovanie do nadväzujúceho volania simport_type=text) - pre
import_type=text(úspešný import):name,import_type,source_rows(vstupný text),imported_rows(skutočne importované záznamy, vo formáte BIND)
Príklad:
curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/zone-import' \
--data '{"import_type":"text","rows":"www IN A 46.28.105.2\nmail IN A 46.28.105.3"}'
Telo požiadavky:
{
"import_type": "text",
"rows": "www IN A 46.28.105.2\nmail IN A 46.28.105.3"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b81",
"data": {
"name": "example.cz",
"import_type": "text",
"source_rows": "\n--- BEGIN ---\nwww IN A 46.28.105.2\nmail IN A 46.28.105.3\n--- END ---",
"imported_rows": "\n--- BEGIN ---\nwww 3600 IN A 46.28.105.2\nmail 3600 IN A 46.28.105.3\n--- END ---"
}
}
PATCH /domains/{domain}
Zmení nastavenia existujúcej domény (parametre AXFR a TSIG). Názov a typ domény touto operáciou zmeniť nemožno.
Parametre:
domain– povinný, reťazec (path) – názov doményaxfr_enabled– voliteľný, boolean (0/1) – povolený odchádzajúci AXFRaxfr_ips– voliteľný, reťazec alebo pole reťazcov – IP adresy povolené pre odchádzajúci AXFR (reťazec adries oddelených medzerami, alebo JSON pole adries); povinný pri nastaveníaxfr_enabled=1primary_ip– voliteľný, reťazec – IPv4 adresa primárneho servera (iba sekundárna doména)primary_tsig_enabled– voliteľný, boolean – vyžaduje TSIG autentizáciu prichádzajúceho AXFR (iba sekundárna doména)primary_tsig_name– voliteľný, reťazec – názov TSIG kľúčaprimary_tsig_alg– voliteľný, reťazec – algoritmus TSIG kľúča (hmac-md5,hmac-sha1,hmac-sha224,hmac-sha256,hmac-sha384,hmac-sha512)primary_tsig_key– voliteľný, reťazec – hodnota TSIG kľúča, base64
Návratové kódy:
1000– OK2007– prekročená maximálna veľkosť požiadavky2100– chýba vstupný parameter2101– neplatné vstupné parametre2201– nepodporovaná TLD2202– neplatný alebo nepodporovaný názov domény2303– neplatný formát parametraprimary_ip2304– neplatný formát parametraaxfr_enabled2305– povinný parameteraxfr_ipschýba2306– neplatný formát parametraaxfr_ips2330–2333– neplatná konfigurácia TSIG (celkovo, názov, algoritmus, kľúč)3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3304– aktualizácia záznamu domény sa nepodarila3305– doména je uzamknutá3306– doména je zmazaná5001– interná chyba autentizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld' \
--data '{"axfr_enabled":1,"axfr_ips":"46.28.105.2 46.28.105.3"}'
Telo požiadavky:
{
"axfr_enabled": 1,
"axfr_ips": "46.28.105.2 46.28.105.3"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b82"
}
PATCH /domains/{domain}/rows/{row_id}
Zmení existujúci DNS záznam. Názov a typ záznamu touto operáciou zmeniť nemožno; na ich zmenu pôvodný záznam zmažte a pridajte nový.
Parametre:
domain– povinný, reťazec (path) – názov doményrow_id– povinný, celé číslo (path) – ID DNS záznamuttl– povinný, celé číslo (telo požiadavky) – nová hodnota TTL v sekundáchrdata– povinný, reťazec (telo požiadavky) – nové dáta záznamuauthor_comment– voliteľný, reťazec (telo požiadavky) – komentár autora; povolené sú iba písmená bez diakritiky, číslice a medzery; starší klienti môžu namiesto toho posielaťauth_comment.
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný názov domény2298– parameterauthor_commentobsahuje neplatné znaky2314– neplatné dáta záznamu2316– tento záznam už existuje2317– neplatná TTL2318– operáciu nemožno vykonať na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– chyba autorizácie3305– doména je uzamknutá3306– doména je zmazaná3309– záznam s týmto ID neexistuje3310– zmena záznamu sa nepodarila5001– interná chyba autorizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/rows/123' \
--data '{"ttl":3600,"rdata":"46.28.105.3"}'
Telo požiadavky:
{
"ttl": 3600,
"rdata": "46.28.105.3"
}
Odpoveď:
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b83"
}
DELETE /domains/{domain}
Zmaže doménu z WDNS.
Parametre:
domain– povinný, reťazec (path) – názov domény
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný alebo nepodporovaný názov domény3222– nepodarilo sa otvoriť doménu3223– prístup odmietnutý3301– odstránenie záznamu domény sa nepodarilo3305– doména je uzamknutá3306– doména je už zmazaná5001– interná chyba autorizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b84"
}
DELETE /domains/{domain}/rows/{row_id}
Zmaže DNS záznam domény.
Parametre:
domain– povinný, reťazec (path) – názov doményrow_id– povinný, celé číslo (path) – ID DNS záznamu
Návratové kódy:
1000– OK2100– chýba povinný parameter2101– neplatný vstupný parameter2201– nepodporovaná TLD2202– neplatný alebo nepodporovaný názov domény2318– operáciu nemožno vykonať na sekundárnej doméne3222– nepodarilo sa otvoriť doménu3223– prístup odmietnutý3305– doména je uzamknutá3306– doména je zmazaná3308– zmazanie záznamu sa nepodarilo3309– záznam s týmto ID neexistuje5001– interná chyba autorizácie
Dáta odpovede: Endpoint nevracia žiadne dáta; úspech je indikovaný kódom 1000.
Príklad:
curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
'https://api.wedos.com/v2/dns/domains/domain1.tld/rows/123'
{
"code": 1000,
"msg": "OK",
"request_id": "f3a9c1e2-7b44-4e21-9c2a-1d6e8a5f3b85"
}
Poznámky
- Okrem chybových kódov uvedených pri jednotlivých endpointoch môžu nastať všeobecné chyby REST vrstvy spoločné všetkým endpointom:
2000(chýbajúci alebo neplatný OAuth2 Bearer token),2004(prekročená maximálna veľkosť požiadavky – URL/query string alebo telo požiadavky),4000(neznáma/nepodporovaná kombinácia cesty URL a HTTP metódy),4001(overenie vstupu zlyhalo),4005(pre tento endpoint nie je v režime?example=1definovaný žiadny príklad) a6000(interná chyba inicializácie WAPI vrstvy). Pri metódach PATCH/DELETE, ak chýba segment{domain}v URL, vracia sa chyba6001(povinný parameterdomainchýba). - Nerozpoznaná kombinácia segmentov URL (napr.
/domains/{domain}/rowsbez{row_id}pri metódach PATCH/DELETE) vždy vracia4000. Nikdy ticho neprejde na inú operáciu (napr. na úroveň celej domény). - REST vrstva prijíma parameter
axfr_ipsbuď ako reťazec IP adries oddelených medzerami, alebo ako JSON pole adries. Pred volaním podkladového WAPI príkazu obe varianty normalizuje do interného formátu. Prázdny reťazec sa považuje za nezadanú hodnotu. - Parametre
primary_ipaprimary_tsig_*sa uplatnia iba pri doménach typusecondary. template_idsa pri vytváraní domény (POST /domains/add) uplatní iba pri primárnej doméne (type=primaryalebo neuvedené). Pri sekundárnej doméne vracia chybu2324.rr_limit(maximálny počet DNS záznamov pre doménu) nie je podporovaným parametrom POST /domains/add. Endpoint ho neprijíma; limit je daný účtom/šablónou.- Pri POST /domains/{domain}/zone-import je dôležité rozlišovať dva režimy parametra
import_type:axfriba stiahne záznamy a vráti ich ako text na ručnú kontrolu (nič sa neimportuje), zatiaľ čotextzapíše záznamy do domény priamo po overení. Typický postup je preto najprv zavolaťimport_type=axfr, skontrolovať vrátený text a až potom ho odoslať akoimport_type=text. author_comment(pri pridávaní/zmene DNS záznamu) povoľuje iba písmená bez diakritiky, číslice a medzery. Starší klienti môžu namiesto neho použiť parameterauth_comments rovnakým významom.- Polia
nameatypeDNS záznamu nemožno zmeniť cez PATCH /domains/{domain}/rows/{row_id}. Na ich zmenu záznam zmažte a pridajte znova. - Vlastníctvo domény sa overuje v rámci každej operácie podľa prihláseného používateľa (identifikovaného z OAuth2 tokenu). Ak doména patrí inému používateľovi, vracia sa chyba
3223.
