WAPI – WEDOS Protection (WGP)

Tento článek popisuje následující příkazy:

• wgp-domain-create – přidání domény do WEDOS Protection
• wgp-domain-info – výpis informací o doméně WEDOS Protection
• wgp-domain-renew – prodloužení služby
• wgp-domain-delete – ukončení služby
• wgp-domain-update-subscription – změna tarifu
• wgp-domain-create-retry – vyřešení některých chyb
• wgp-domain-cache-purge – vymazání WP cache
• wgp-domain-template-replicate – replikuje šablonu na existující doménu
• wgp-domain-templates-list – seznam šablonových domén
• wgp-services-list – seznam domén WEDOS Protection

---

wgp-domain-create

Použijte požadavek wgp-domain-create k vytvoření záznamu domény ve WEDOS Protection. Tento požadavek je asynchronní a komunikuje přes oznámení ⧉.

Parametry

• doména = název domény (povinné)
• variant_id = tarif služby (povinné) – 1 = Start, 2 = Advanced, 3 = Expert (tarify a jejich ceny najdete na stránce produktu ⧉)
• period_id = období služby (povinné) – 1 = měsíčně, 4 = ročně
• upstream_ips = pole cílových IP adres (nepovinné) – více informací o cílových IP najdete v článku Protection – cílové servery (upstream) .
• template_domain_id = ID šablonové domény (nepovinné)
• režim = režim domény (nepovinné)
  • ns = používá WEDOS NS (výchozí); systém doménu aktivuje pouze tehdy, když úspěšně ověří, že používá WEDOS DNS.
  • cname = umožňuje použít DNS servery jiného poskytovatele nebo přidat subdomény pomocí CNAME záznamu; režim pro jakoukoli doménu 3. a vyšší úrovně je vždy cname.

Návratové hodnoty

• 1000 = OK
• 1001 = Požadavek se zpracovává
• 2101 = Neodpovídající parametry
• 2202 = Neplatný nebo nepodporovaný formát názvu domény
• 2203 = Neplatné period_id
• 2206 = Neplatný požadavek – interní chyba
• 2272 = Neplatný formát IP adresy
• 2273 = Neplatná varianta
• 2274 = Interní chyba – chybí parametr user_id
• 2275 = Interní chyba – uživatel nenalezen
• 2276 = Nepodporovaná TLD nebo překročena maximální úroveň domény
• 2277 = Před název domény není povoleno explicitně uvádět www.
• 2278 = Název domény nelze použít – s tímto názvem domény již existuje služba
• 2279 = Kreditní účet je uzamčen
• 2280 = Kreditní účet aktivní
• 2281 = Neaktivní kreditní účet
• 2282 = Neplatná měna kreditního účtu
• 2283 = Neplatná částka nebo nedostatečný kredit
• 2284 = Chyba při zjišťování informací o kreditním účtu
• 2285 = Nesprávné nastavení DPH
• 2286 = Kreditní účet – interní chyba
• 2290 = Kreditní účet – pohyb nebyl na kreditní účet přidán
• 2291 = Doména již pro tento zákaznický účet ve WGP API existuje
• 2293 = Nelze zjistit zůstatek na kreditním účtu
• 2294 = Nelze zjistit cenu služby
• 2295 = Doménu nelze ve WGP vytvořit. Platba byla stornována.
• 2296 = Pohyb na kreditním účtu nelze stornovat
• 2400 = Interní chyba WGP
• 2401 = Šablonu nelze na doménu použít
• 2402 = Neplatná šablonová doména
• 2403 = Šablonová doména neodpovídá uživateli
• 2404 = Šablonová doména neodpovídá tarifu domény
• 2405 = Dosažen denní limit šablonových domén
• 2416 = Neplatný režim domény

Návratová data

• WGP_ID = ID záznamu domény ve WGP
• doména = název domény
• order_num = číslo objednávky
• měna = měna kreditního účtu
• částka = cena služby
• acc_amount_before = zůstatek kreditního účtu před aktivací služby
• acc_amount_current = zůstatek kreditního účtu po aktivaci služby

Návratová data oznámení

• WGP_ID = ID záznamu domény ve WGP
• doména = název domény
• order_num = číslo objednávky

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-create",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld",
      "variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
      "period_id": "1 = monthly billing, 4 = yearly billing",
      "upstream_ips": ["IP address 1", "IP address 2", "(optional)"],
      "template_domain_id": "ID of the template domain (optional)",
      "mode": "domain mode (optional)"
    }
  }
}

JSON odpověď (požadavek se zpracovává):

{
  "response": {
    "code": 1001,
    "result": "Request pending",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
      "currency": "currency code",
      "amount": "price",
      "acc_amount_before": "credit account balance before transaction",
      "acc_amount_current": "credit account balance after transaction"
    }
  } 
}

JSON oznámení po dokončení nastavení:

{
  "notify": {
    "code": "1000",
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "id": "POLL queue ID",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
    }
  }
}

---

wgp-domain-info

Použijte požadavek wgp-domain-info k zobrazení informací o stavu domény ve službě WEDOS Protection.

Parametry

• doména = název domény (povinné)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2101 = Neodpovídající parametry
• 2202 = Neplatný nebo nepodporovaný formát názvu domény
• 2206 = Neplatný požadavek – interní chyba
• 2292 = Doména nebyla pro tento zákaznický účet ve WGP API nalezena

Návratová data

• wgp = stav domény ve WEDOS Protection; parametr state nabývá jedné z následujících hodnot, přičemž některé mohou obsahovat různá data:
  • pending_dns = probíhá zjišťování DNS záznamů domény
  • zpracování = čeká se na nastavení služby
  • zaseknuto = čeká se na softwarové požadavky
  • pending_txt = čeká se na ověření TXT záznamu (částečná šablona)
  • pending_ns = čeká se na nastavení nameserverů (částečná šablona pro režim NS a režim CNAME)
  • pending_dns_refresh = opakované zjišťování DNS, pokud předchozí pending_dns nenašlo žádné DNS záznamy
  • pending_crt = čeká se na certifikát Let’s Encrypt pro WG
  • aktivní = doména aktivní (úplná šablona)
• služba = stav domény v systému WEDOS

Podrobnější informace o návratových datech najdete v šabloně.

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-info",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

JSON odpověď (OK, stav aktivní):

{
  "response": {
    "code": 1000,
    "result": "ok",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-info",
    "data": {
    "wgp":{
        "domain": "domain_name.tld",
        "domain_id": "assigned domain ID",
        "domain_tld": "tld",
        "modes": ["režim domény"],
        "settings": {
          "cache": "cache status (empty off, 1 on)"
        },
        "url": "https://client.wedos.global/protection/domains/domain_name.tld",
        "state": "active",
        "state_data": {
          "dns_ip_addresses": ["WG proxy IPv4 address", "WG proxy IPv6 address"],
          "dns_pointing_to_proxy": "DNS proxy routing check, empty false, 1 true",
          "dns_records_new": [
            {
              "name": "",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ],
          "dns_records": [
            {
              "name": "",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ]
        }
      },
      "service": {
        "ID": "service ID in the system",
        "name": "domain_name.tld",
        "num": "order number",
        "user_id": "user ID in the system",
        "lang": "language code",
        "currency": "currency code",
        "cli_legal_type": "Billing - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "cli_company" :"Billing – Company name",
        "cli_fname": "Billing – Name",
        "cli_lname": "Billing – Surname",
        "cli_email": "Billing – Email",
        "cli_email2": "Billing – Backup email",
        "cli_phone": "Billing – Phone",
        "cli_mobile": "Billing – Mobile",
        "cli_fax": "Billing – Fax",
        "cli_ic": "Billing – Company ID",
        "cli_dic": "Billing – VAT ID",
        "cli_taxpayer": "Billing – VAT payer (0/1)",
        "cli_addr_street": "Billing – Street and number",
        "cli_addr_city": "Billing – Town",
        "cli_addr_zip": "Billing – ZIP",
        "cli_addr_country": "Billing – Country code",
        "cli_name_vies": "Billing – VIES name",
        "own_legal_type": "Operator - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "own_company": "Operator – Company name",
        "own_fname": "Operator - Name",
        "own_lname": "Operator - Surname",
        "own_email": "Operator - Email",
        "own_phone": "Operator - Phone",
        "own_ic": "Operator - Company ID",
        "own_dic": "Operator - VAT ID",
        "own_addr_street": "Operator – Street and number",
        "own_addr_city": "Operator - Town",
        "own_addr_zip": "Operator - ZIP",
        "own_addr_country": "Operator – Country code",
        "status": "service status in WEDOS customer administration",
        "expiration": "expiration date YYYY-MM-DD"
      }
    }
  }
}

JSON data (OK, stav pending_txt):

{
    ...
    "data": {
        ...
        "state": "pending_txt",
        "state_data": {
            "name": "_TXT_record_name",
            "name_formatted": "_TXT_record_name_with_domain.tld",
            "value": "TXT-record-value--verification-code"
        }
    }
}

JSON data (OK, stav pending_ns v režimu ns ):

{
    ...
    "data": {
        ...
        "state": "pending_ns",
        "state_data": {
            "assigned": [ 
                "assigned-nameserver.ns.wedos.net",
                "assigned-nameserver.ns.wedos.com",
                "assigned-nameserver.ns.wedos.eu",
                "assigned-nameserver.ns.wedos.cz"
            ],
            "assigned_own": [ 
                [
                    "own-ns1.if-permitted.tld",
                    "own-ns2.if-permitted.tld"
                ]
            ],
            "resolved": [ 
                "current-resolved-ns1.domain.tld",
                "current-resolved-ns2.domain.tld"
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }
    }
}

JSON data (OK, stav pending_ns v režimu cname ; crt_name a cname jsou názvy a hodnoty záznamů, které si uživatel nastaví u svého poskytovatele DNS):

{
    ...
    "state_data": {
            "crt_cname": [
                {
                    "name": "_acme-challenge",
                    "value": "_acme-challenge.verification_code.wgp123.wedos.global"
                }
            ],
            "cname": [
                {
                    "name": "*",
                    "value": "verification_code.wgp123.wedos.global"
                },
                {
                    "name": "www",
                    "value": "verification_code.wgp123.wedos.global"
                }
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }

    }
}

---

wgp-domain-renew

Použijte požadavek wgp-domain-renew k prodloužení domény ve službě WEDOS Protection o další období.

Parametry

• service_id = ID služby (povinné)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2101 = Neodpovídající parametry
• 2152 = Prodloužení služby zablokováno
• 2206 = Chybí user_id
• 2279 = Kreditní účet zablokován
• 2281 = Neaktivní kreditní účet
• 2282 = Neplatná měna kreditního účtu
• 2283 = Neplatná částka nebo nedostatečný kredit
• 2284 = Chyba při zjišťování informací o kreditním účtu
• 2286 = Kreditní účet – interní chyba
• 2293 = Nelze zjistit zůstatek na kreditním účtu
• 2406 = Doména/služba nenalezena
• 2409 = Prodloužení služby se nezdařilo

Návratová data

• service_id = ID služby
• name = Název domény
• date_from = Datum platnosti služby
• date_to = Datum expirace služby
• fakt_order_num = Číslo objednávky pro prodloužení služby
• měna = Měna kreditního účtu
• price = Cena prodloužení
• kredit = Zůstatek kreditního účtu po prodloužení

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-renew",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-renew",
    "data": {
      "service_id":"service ID",
      "domain":"domain_name.tld",
      "date_from":"YYYY-MM-DD",
      "date_to":"YYYY-MM-DD",
      "fakt_order_num":"Order nr.",
      "currency":"Currency code",
      "price": Amount,
      "credit":"Credit account balance"
    }
  }
}

---

wgp-domain-delete

Použijte požadavek wgp-domain-delete ke smazání domény ze služby WEDOS Protection.

Parametry

• service_id = ID služby (povinné)
• vynutit = Vynucené smazání bez ohledu na A/AAAA záznamy domény (nepovinné, pokud existuje token pro přepis DNS záznamů)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2274 = Interní chyba – chybí parametr user_id
• 2292 = Doména nebyla v tomto uživatelském účtu nalezena
• 2400 = Interní chyba
• 2410 = Služba nenalezena
• 2411 = Není dostupný token pro přepis DNS
• 2412 = Nezdařil se API požadavek na přepis DNS
• 2413 = Požadavek selhal, WGP nemá oprávnění aktualizovat DNS
• 2414 = WGP nemá token a uživatel ve WAPI nenastavil příznak force

Návratová data

• doména = název domény
• domain_id = ID domény
• wedos_client_id = ID klienta
• service_id = ID služby
• service_type = typ služby
• wdns_data = pole aktualizací IP

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "force": true (forces delete without updating DNS) | false (restores original DNS if able)
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id",
      "service_id":id,
      "service_type":"hosting_wedos_protection",
      "wdns_data":{
        "domain":"domain_name.tld",
        "rows_a":{
          "rem":{
            "removed A record ID":{
              "name":"removed A record name",
              "ttl":"removed A record TTL",
              "rdtype":"A",
              "rdata":"removed A record IP"
            }
          },
          "add":{
            "added A record ID":{
              "name":"added A record name",
              "ttl":"added A record TTL",
              "rdtype":"A",
              "rdata":"added A record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        },
      "rows_aaaa":
        "rem":{
            "removed AAAA record ID":{
              "name":"removed AAAA record name",
              "ttl":"removed AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"removed AAAA record IP"
            }
          },
          "add":{
            "added AAAA record ID":{
              "name":"added AAAA record name",
              "ttl":"added AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"added AAAA record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        }
      }
    }
  }
}

---

wgp-domain-delete-order

Použijte požadavek wgp-domain-delete ke smazání objednávky domény ze služby WEDOS Protection. Hodí se ke smazání služeb, jejichž vytvoření selhalo.

Tento požadavek nesmaže existující služby. K tomu použijte wgp-domain-delete.

Parametry

• doména = název domény (povinné)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2274 = Interní chyba – chybí parametr user_id
• 2292 = Doména nebyla v tomto uživatelském účtu nalezena
• 2400 = Interní chyba
• 2410 = Služba nenalezena
• 2421 = Služba WGP existuje, doména nebude smazána

Návratová data

• doména = název domény
• domain_id = ID domény
• wedos_client_id = ID klienta

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete-order",
    "clTRID": "your ID",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id"WGP service exists, the domain will not be deleted
    }
  }
}

JSON odpověď (Chyba – služba WEDOS Protection již existuje):

{
  "response": {
    "code": 2421,
    "result": "WGP service exists, the domain will not be deleted",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order"
  }
}

---

wgp-domain-update-subscription

Použijte požadavek wgp-domain-update-subscription ke změně tarifu nebo fakturačního období služby WEDOS Protection.

Parametry

• service_id = ID služby (povinné)
• new_variant_id = tarif služby (povinné) – 1 = Start, 2 = Advanced, 3 = Expert
• new_period_id = fakturační období (povinné) – 1 = měsíčně, 4 = ročně

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2101 = Neodpovídající parametry
• 2203 = Neplatné period_id
• 2273 = Neplatná varianta
• 2293 = nelze zjistit výši kreditu
• 2294 = nelze zjistit cenu služby
• 2279 = kreditní účet uzamčen
• 2281 = neaktivní kreditní účet
• 2282 = nelze zaplatit v měně kreditu
• 2283 = neplatná částka nebo nedostatečný zbývající kredit
• 2284 = neplatné kontaktní údaje kreditního účtu
• 2285 = neplatné nastavení DPH při fakturaci
• 2286 = kreditní účet – neznámý návratový kód
• 2400 = Interní chyba WGP
• 2406 = Doména/služba nenalezena
• 2408 = Chybí variant_id nebo period_id

Návratová data

• doména = název domény
• domain_id = ID domény
• wedos_client_id = ID klienta
• service_id = ID služby
• service_type = typ služby
• variant_id = ID tarifu služby
• period_id = ID fakturačního období
• dirty = příznak změny (0 = beze změny, 1 = změněno)

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-update-subscription",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "new_variant_id": "1, 2, or 3",
      "new_period_id": "1, or 4"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-update-subscription",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID",
      "service_id": service ID,
      "service_type": "service type ID",
      "variant_id": plan ID,
      "period_id": billing period ID,
      "dirty": 0|1
    }
  }
}

---

wgp-domain-create-retry

Pomocí příkazu wgp-domain-create-retry , zopakujete požadavek na vydání certifikátu. Lze jej použít k vyřešení stavu error_crt , který vrací příkaz wgp-domain-info .

Parametry

• doména = název domény (povinné)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2292 = Doména nebyla v tomto uživatelském účtu nalezena
• 2400 = Interní chyba
• 4000 = Interní chyba

Návratová data

• doména = Název domény
• domain_id = ID domény ve WGP
• wedos_client_id = ID klienta

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-create-retry",
    "clTRID": "your ID",
    "data": {
      "domain": "nazev_domeny.tld"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-create-retry",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID"
    }
  }
}

---

wgp-domain-cache-purge

Použijte wgp-domain-cache-purge k vymazání cache domény WEDOS Protection.

Parametry

• service_id = ID služby (povinné)
• service_type = Typ služby (nepovinné)
  • hodnoty: hosting_wedos_protection (výchozí), hosting_domain
• limiter_decay = Doba blokování v sekundách (nepovinné)
  • výchozí hodnota 5
• limiter_reset = Zrušení limiteru (nepovinné)
  • 0 (ne, výchozí), 1 (ano)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2101 = Neodpovídající parametry
• 2274 = interní chyba – chybí user_id
• 2400 = interní chyba – neznámý návratový kód
• 2406 = doména/služba nenalezena
• 2415 = dosažena hodnota limiteru
• 4000 = systémová chyba

Návratová data

• doména = Název domény
• domain_id = ID domény
• domain_tld = TLD domény
• service_id = ID služby
• wedos_client_id = ID klienta
• limiter_available_in = Čas v sekundách, než bude funkce znovu dostupná

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-cache-purge",
    "clTRID": "own ID code",
    "data": {
      "service_id": Service ID,
      "service_type": "service type code (optional)",
      "limiter_decay": limiter timeout (in seconds, optional),
      "limiter_reset": 0|1 (optional)
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-cache-purge",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": domain ID,
      "domain_tld":"tld",
      "wedos_client_id":"customer account ID"
    }
  }
}

---

wgp-domain-template-replicate

Použijte požadavek wgp-domain-template-replicate ke změně nastavení cílové domény podle vybrané šablonové domény.

Parametry

• service_id – ID služby (povinné)
• template_domain_id – ID cílové šablonové domény (povinné)
• service_type – typ služby (nepovinné)
  • hodnoty: hosting_domain, hosting_wedos_protection

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2101 = Neodpovídající parametry
• 2400 = Interní chyba WGP
• 2401 = Šablonu nelze na doménu použít
• 2402 = Neplatná šablonová doména
• 2403 = Šablonová doména neodpovídá uživateli
• 2404 = Šablonová doména neodpovídá tarifu domény
• 2405 = Dosažen denní limit šablonových domén
• 2406 = Doména/služba nenalezena
• 2407 = Šablonová doména nenalezena
• 4000 = Interní chyba

Návratová data

• doména = název domény
• domain_id = ID domény
• service_id = ID služby
• service_type = typ služby
• template_domain_id = ID šablonové domény
• replications_count = počet provedených replikací
• replications_limit = maximální počet replikací

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-template-replicate",
    "clTRID": "your ID",
    "data": {
      "service_id": service ID,
      "template_domain_id": template domain ID,
      "service_type": "hosting_domain, or hosting_wedos_protection (optional)"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-template-replicate",
    "data":{
      "domain":"domain_namey.tld",
      "domain_id": domain ID,
      "service_id": service ID,
      "service_type": "service type",
      "template_domain_id": template domain ID,
      "replications_count": replication count,
      "replications_limit": replication limit
    }
  }
}

---

wgp-domain-templates-list

Použijte požadavek wgp-domain-templates-list k získání seznamu šablonových domén pro vybraný tarif WEDOS Protection.

Parametry

• variant_id = ID tarifu (povinné)
• per_page = Počet záznamů na stránku (výchozí = 15, všechny záznamy = -1) (nepovinné)
• stránka = Číslo stránky (výchozí = 1) (nepovinné)
• locale = Jazyk (výchozí = en, podporováno = cs, en) (nepovinné)
• search = Hledání ve sloupcích custom_name, name (nepovinné)

Návratové hodnoty

• 1000 = OK
• 2100 = Chybí povinný parametr
• 2400 = interní chyba
• 4000 = interní chyba

Návratová data

• data = Seznam šablonových domén
  • id = ID šablonové domény
  • custom_name = Název šablonové domény (nastavený uživatelem)
  • name = Název šablonové domény (systémový)
  • url = URL šablonové domény
• first_page_url = URL první stránky seznamu
• z = Začátek stránkování
• last_page = Číslo poslední stránky
• last_page_url = URL poslední stránky seznamu
• odkazy = Pole odkazů stránkování
  • url = URL odkazu
  • štítek = Popisek tlačítka
  • aktivní = null|1
• next_page_url = URL následující stránky
• path = URL seznamu šablonových domén
• per_page = Počet záznamů na stránku
• prev_page_url = URL předchozí stránky
• na = Konec stránkování
• celkem = Celkový počet stránek

Šablony

JSON požadavek:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-templates-list",
    "clTRID": "your ID",
    "data": {
      "variant_id": plan ID 1 = Start, 2 = Advanced, 3 = Expert,
      "per_page": entries per page (optional),
      "page": page nr. (optional),
      "locale": "cs, or en (optional)",
      "search": "Search by custom_name, name (optional)"
    }
  }
}

JSON odpověď (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-templates-list",
    "data":{
      [
        {
          "id": Template domain ID,
          "custom_name":"termplate domain user name",
          "name":"system-name.template",
          "url":"https://template.domain.url/system-name.template"
        }
      ],
      "first_page_url":"https://first.page.url",
      "from": 1st page number,
      "last_page": last page number,
      "last_page_url":"https://last.page.url",
      "links":[
        {
          "url": "https://page.url",
          "label":"Button label",
          "active": null|1
        }
      ],
      "next_page_url": "https://next.page.url",
      "path":"https://list.url",
      "per_page": entries per page,
      "prev_page_url":"https://previous.page.url",
      "to": last list item,
      "total": total page count
    }
  }
}

---

wgp-services-list

Pomocí příkazu wgp-services-list můžete získat seznam domén se službou WEDOS Protection. Filtrovat lze podle stavu.

Parametry

• status = stav služby (nepovinné)

Návratové hodnoty

• 1000 = OK
• 2206 = Neplatný požadavek – interní chyba

Návratová data

• ID = ID záznamu domény
• name = název domény
• status = stav služby
• expirace = Datum expirace služby WG

Šablony

JSON požadavek

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-services-list",
    "clTRID": "own ID code",
    "data": {
      "status": "active, expired, disabled or deleted"
    }
  }
}

JSON odpověď (OK)

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command":"wgp-services-list",
    "data":{
      "service ID in the system":{
        "ID":"service ID in the system",
        "domain":"domain_name.tld",
        "status":"service status",
        "expiration": "expiration date YYYY-MM-DD"
    }
  }
}