REST API – WEDOS.protection Služby

WEDOS REST API je stále ve vývoji. Přístup a funkce se mohou bez předchozího upozornění změnit.

Tento článek částečně popisuje endpoint WEDOS.protection ve WEDOS REST API. Domény WEDOS.protection a členové mají vlastní články. Pro WEDOS API (WAPI) viz WAPI – WEDOS Protection.

Základní informace o WEDOS REST API najdete v článku WEDOS REST API Manuál.

V tomto článku najdete následující informace:

Přístup k WGP endpointu

WGP HTTP REST API v2 slouží ke správě domén, služeb a pozvánek ke spolusprávě ve WEDOS.protection (WGP).

Základní URL a autentizace

Základní URL pro WGP endpointy je: https://api.wedos.com/v2

Autentizace probíhá pouze přes OAuth2: do hlavičky požadavku vložte platný přístupový token (Authorization: Bearer <TOKEN>) se scope wgp . Bez platného tokenu vrací API chybu 2000.

Můžete přidat parametr example=1 ke kterémukoli endpointu jako GET parametr (?example=1 u endpointů bez vlastních GET parametrů, jinak &example=1). API pak pro dané volání vrátí ukázkový příkaz curl bez nutnosti zadávat skutečné parametry. I v tomto režimu je vyžadována platná autentizace.

Přehled endpointů

MetodaEndpointPopis
GET/servicesSeznam vašich samostatných služeb WGP
POST/services/{service_id}/cache/purgeVymazání cache CDN
POST/services/{service_id}/renewProdloužení služby
POST/services/{service_id}/template-replicateReplikace nastavení ze šablonové domény
PATCH/services/{service_id}Změna varianty/periody předplatného služby
DELETE/services/{service_id}Smazání/zrušení služby

Formát odpovědi

Odpovědí API je vždy objekt JSON s klíči code (návratový kód), msg (textový popis), request_id (identifikátor požadavku) a případně data (vrácená data při úspěchu).

Obecné návratové kódy platné pro všechny endpointy (REST vrstva, nezávisle na konkrétní operaci):

  • 1000 – úspěch (OK)
  • 2000 – chybí nebo je neplatná autentizace (OAuth2 Bearer token)
  • 2004 – překročena maximální velikost požadavku (URL nebo tělo požadavku)
  • 4000 – neznámá/nepodporovaná metoda API (volaná kombinace HTTP metody a cesty neexistuje)
  • 4001 – validace vstupních dat selhala
  • 4005 – pro aktuální endpoint v režimu example=1 není k dispozici žádný příklad
  • 6000 – interní chyba při inicializaci podkladového příkazu WAPI

Každý endpoint navíc vrací vlastní business kódy specifické pro danou operaci (odpovídající podkladovému příkazu WAPI). Ty jsou uvedeny v části Návratové kódy u každého endpointu.

GET /services

Vrací seznam vlastních samostatných služeb WEDOS Global Protection přihlášeného OAuth2 uživatele (vytvořených přímo jako služba WGP, tabulka hosting_wedos_protection).

Parametry:

  • status – volitelný, query – filtr podle konkrétního stavu služby (hodnota se neověřuje proti číselníku stavů)

Návratové kódy:

  • 1000 – OK

Data odpovědi: Pole služeb; každá položka obsahuje ID, name, status, expiration.

Příklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services?status=active'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": [
    {
      "ID": 435,
      "name": "domain1.tld",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  ]
}

POST /services/{service_id}/cache/purge

Vymaže cache CDN pro doménu připojenou k WGP. Může cílit buď na samostatnou službu WGP, nebo na doménu s WGP jako doplňkovou službou (hosting_domain); typ služby se nastavuje parametrem service_type .

Parametry:

  • service_id – povinný, path – ID lokální služby
  • service_type – volitelný – typ služby, hosting_wedos_protection (výchozí) nebo hosting_domain
  • limiter_decay – volitelný, číslo – doba v sekundách, po kterou je opakované vymazání omezeno; výchozí 5
  • limiter_reset – volitelný, bool – zruší aktuální omezení; výchozí false

Návratové kódy:

  • 1000 – OK
  • 2100 – chybí povinný parametr
  • 2101 – neplatná hodnota parametru
  • 2406 – doména/služba nenalezena
  • 2415 – limiter stále běží – vymazání nelze nyní opakovat
  • 3223 – služba patří do jiného zákaznického účtu
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • domain – název domény
  • domain_id – ID domény ve WGP
  • domain_tld – TLD domény
  • service_id – ID služby
  • wedos_client_id – ID klienta ve WGP
  • limiter_available_in – za kolik sekund lze funkci znovu použít (dokumentováno pouze pro chybu 2415; aktuální implementace ale při chybě část data nevrací, viz Poznámky)

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/cache/purge' \
  --data '{"limiter_decay":5,"limiter_reset":0}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "domain_tld": "tld",
    "service_id": 435,
    "wedos_client_id": 10234
  }
}

POST /services/{service_id}/renew

Prodlouží službu WGP o další fakturační období.

Parametry:

  • service_id – povinný, path – ID služby

Návratové kódy:

  • 1000 – OK
  • 2100 – chybí povinný parametr
  • 2101 – neplatná hodnota parametru
  • 2152 – prodloužení není v aktuálním stavu služby povoleno
  • 2279 – zálohový účet je zablokován
  • 2281 – zálohový účet není aktivní
  • 2282 – ze zálohového účtu nelze platit v dané měně
  • 2283 – nedostatečný zůstatek na zálohovém účtu
  • 2284 – chyba v kontaktních údajích zálohového účtu
  • 2293 – nelze zjistit zůstatek kreditu na zálohovém účtu
  • 2297 – nelze určit, zda je zálohový účet s DPH
  • 2406 – služba nenalezena
  • 2409 – prodloužení služby se nezdařilo

Data odpovědi:

  • service_id – ID služby
  • name – název domény
  • date_from, date_to – data platnosti nové periody
  • fakt_order_num – číslo objednávky prodloužení
  • currency – měna zálohového účtu
  • price – částka za prodloužení
  • credit – zůstatek zálohového účtu poté (null u služeb FREE/TRIAL)

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435/renew'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "service_id": 435,
    "name": "domain1.tld",
    "date_from": "2027-10-01",
    "date_to": "2028-10-01",
    "fakt_order_num": "2026123457",
    "currency": "CZK",
    "price": 499,
    "credit": 502
  }
}

POST /services/{service_id}/template-replicate

Replikuje (aplikuje) nastavení šablonové domény na existující doménu/službu WGP.

Parametry:

  • service_id – povinný, path – ID služby, na kterou se nastavení replikuje
  • template_domain_id – povinný – ID šablonové domény (viz GET /domains/templates)
  • service_type – volitelný – typ služby, hosting_wedos_protection (výchozí) nebo hosting_domain

Návratové kódy:

  • 1000 – OK
  • 2100 – chybí povinný parametr
  • 2101 – neplatná hodnota parametru
  • 2401 – neplatná doména pro replikaci
  • 2402 – neplatná šablonová doména
  • 2403 – neshoda uživatele mezi doménou a šablonovou doménou
  • 2404 – neshoda tarifu mezi doménou a šablonovou doménou
  • 2405 – dosažen denní limit replikací
  • 2406 – doména/služba nenalezena
  • 2407 – šablonová doména nenalezena
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • domain – název domény
  • domain_id – ID domény
  • service_id – ID služby
  • service_type – typ služby
  • template_domain_id – ID použité šablonové domény
  • replications_count – počet dosud provedených replikací
  • replications_limit – maximální povolený počet replikací

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/template-replicate' \
  --data '{"template_domain_id":123}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "template_domain_id": 123,
    "replications_count": 2,
    "replications_limit": 5
  }
}

PATCH /services/{service_id}

Změní variantu a/nebo periodu předplatného existující služby WGP.

Parametry:

  • service_id – povinný, path – ID služby
  • new_variant_id – volitelný, číslo – nová varianta služby
  • new_period_id – volitelný, číslo – nová perioda předplatného

Musí být zadán alespoň jeden z parametrů new_variant_id/new_period_id .

Návratové kódy:

  • 1000 – OK
  • 2100 – chybí povinný parametr
  • 2101 – neplatná hodnota parametru
  • 2203 – neplatná hodnota parametru new_period_id
  • 2273 – neplatná hodnota parametru new_variant_id
  • 2279 – zálohový účet je zablokován
  • 2281 – zálohový účet není aktivní
  • 2282 – ze zálohového účtu nelze platit v dané měně
  • 2283 – nedostatečný zůstatek na zálohovém účtu
  • 2284 – chyba v kontaktních údajích zálohového účtu
  • 2293 – nelze zjistit zůstatek kreditu na zálohovém účtu
  • 2294 – nelze zjistit cenu služby
  • 2406 – doména/služba nenalezena
  • 2408 – parametr new_variant_id nebo new_period_id chybí (nebyl zadán ani jeden)
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • domain – název domény
  • domain_id – ID domény
  • wedos_client_id – ID klienta ve WGP
  • service_id – ID služby
  • service_type – typ služby
  • variant_id – aktuální ID varianty služby po změně
  • period_id – aktuální ID periody předplatného po změně
  • dirty – příznak, zda ke změně skutečně došlo (0 = beze změny, 1 = změněno)

Příklad:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435' \
  --data '{"new_variant_id":2,"new_period_id":1}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "variant_id": 2,
    "period_id": 1,
    "dirty": 1
  }
}

DELETE /services/{service_id}

Smaže/zruší službu WGP na žádost zákazníka.

Parametry:

  • service_id – povinný, path – ID služby
  • force – volitelný, query, 0/1 – vynutí smazání i v případě, kdy WGP nemá k dispozici token pro přepis DNS (obnovení záznamů A/AAAA na původní hodnoty)

Návratové kódy:

  • 1000 – OK
  • 2100 – chybí povinný parametr
  • 2292 – doména nebyla ve WGP pro tento zákaznický účet nalezena
  • 2400 – interní chyba
  • 2410 – služba nenalezena
  • 2411 – není k dispozici token pro přepis DNS
  • 2412 – API požadavek na přepis DNS se nezdařil
  • 2413 – příkaz nelze provést, WGP nemá oprávnění manipulovat s DNS domény (force=1 je vyžadováno)
  • 2414 – pro WGP neexistuje token a nebyl zadán parametr force .
  • 3223 – služba patří do jiného zákaznického účtu

Data odpovědi:

  • domain – název domény
  • domain_id – ID domény
  • wedos_client_id – ID klienta ve WGP
  • service_id – ID služby
  • service_type – typ služby
  • wdns_data – pole provedených změn DNS záznamů (IP adresy, které se po zrušení WGP přestanou překládat přes WGP)

Příklad:

curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435?force=1'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "wdns_data": []
  }
}

Poznámky

  • GET /services vrací pouze samostatné služby WGP. Domény, které mají WGP připojené jako doplňkovou službu k jiné službě, v tomto seznamu nejsou a neexistuje pro ně obdobný výpisový endpoint.
  • POST /services/{service_id}/cache/purge a POST /services/{service_id}/template-replicate se adresují přímo pomocí service_id (nikoli podle domény) a podporují parametr service_type pro rozlišení mezi samostatnou službou WGP a doménou s WGP jako doplňkovou službou. Odpovídající příkaz WAPI si dohledá vlastnictví podle user_id sám.
  • U POST /services/{service_id}/cache/purge zmiňuje dokumentační komentář funkce cmd_purge_cache() v datech odpovědi i pole limiter_available_in pro chybu 2415, aktuální implementace však v tomto případě vrací pouze holý chybový kód bez části data – pole se tedy v odpovědi ve skutečnosti neobjeví.

Bylo to užitečné?

Děkujeme za zpětnou vazbu!
Obecné selektory
Pouze přesné shody
Hledat v názvu
Hledat v obsahu
Selektory typů příspěvků
Obsah článku
Procházet kategorie