WAPI – WEDOS Protection (WGP)

Ten artykuł zawiera informacje o następujących poleceniach:

• wgp-domain-create – dodanie domeny do WEDOS Protection
• wgp-domain-info – wyświetlenie informacji o domenie w WEDOS Protection
• wgp-domain-renew – przedłużenie usługi
• wgp-domain-delete – zakończenie usługi
• wgp-domain-update-subscription – zmiana taryfy
• wgp-domain-create-retry – rozwiązanie niektórych błędów
• wgp-domain-cache-purge – wyczyszczenie pamięci podręcznej WP
• wgp-domain-template-replicate – replikacja szablonu do istniejącej domeny
• wgp-domain-templates-list – lista szablonów domen
• wgp-services-list – lista domen WEDOS Protection

---

wgp-domain-create

Użyj polecenia wgp-domain-create , aby utworzyć wpis domeny w WEDOS Protection. To żądanie jest asynchroniczne i komunikuje się przez powiadomienia ⧉.

Parametry

• domena = nazwa domeny (wymagane)
• variant_id = taryfa usługi (wymagane) – 1 = Start, 2 = Advanced, 3 = Expert (taryfy i ich ceny znajdziesz na stronie produktu ⧉)
• period_id = okres usługi (wymagane) – 1 = miesięcznie, 4 = rocznie
• upstream_ips = tablica docelowych adresów IP (opcjonalne) – więcej informacji o docelowych IP znajdziesz w artykule Protection – Cele upstream .
• template_domain_id = ID domeny szablonowej (opcjonalne)
• tryb = tryb domeny (opcjonalne)
  • ns = używa WEDOS NS (domyślnie); system aktywuje domenę tylko wtedy, gdy pomyślnie sprawdzi, że używa WEDOS DNS.
  • cname = umożliwia korzystanie z serwerów DNS innego dostawcy lub dodawanie subdomen za pomocą rekordu CNAME; tryb dla domen 3. i wyższego poziomu to zawsze cname.

Wartości zwracane

• 1000 = OK
• 1001 = Żądanie oczekuje
• 2101 = Niezgodność parametrów
• 2202 = Nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2203 = Nieprawidłowy period_id
• 2206 = Nieprawidłowe żądanie – błąd wewnętrzny
• 2272 = Nieprawidłowy format adresu ip
• 2273 = Nieprawidłowy wariant
• 2274 = Błąd wewnętrzny – brak parametru user_id
• 2275 = Błąd wewnętrzny – nie znaleziono użytkownika
• 2276 = Nieobsługiwany TLD lub przekroczony maksymalny poziom domeny
• 2277 = Nie można jawnie dodawać www. przed nazwą domeny
• 2278 = Nazwy domeny nie można użyć – istnieje usługa o tej nazwie domeny
• 2279 = Konto kredytowe jest zablokowane
• 2280 = Konto kredytowe aktywne
• 2281 = Nieaktywne konto kredytowe
• 2282 = Nieprawidłowa waluta konta kredytowego
• 2283 = Nieprawidłowa kwota lub niewystarczający kredyt
• 2284 = Błąd informacji o koncie kredytowym
• 2285 = Nieprawidłowe ustawienia VAT
• 2286 = Konto kredytowe – błąd wewnętrzny
• 2290 = Konto kredytowe – operacja nie została dodana do konta kredytowego
• 2291 = Domena już istnieje dla tego konta klienta w WGP API
• 2293 = Nie można pobrać salda kredytu na koncie kredytowym
• 2294 = Nie można pobrać ceny usługi
• 2295 = Nie można utworzyć domeny w WGP. Płatność została anulowana.
• 2296 = Nie można anulować operacji na koncie kredytowym
• 2400 = Wewnętrzny błąd WGP
• 2401 = Nie można zastosować szablonu do domeny
• 2402 = Nieprawidłowy szablon domeny
• 2403 = Niezgodność szablonu domeny i użytkownika
• 2404 = Niezgodność szablonu domeny i taryfy domeny
• 2405 = Osiągnięto dzienny limit domen szablonowych
• 2416 = Nieprawidłowy tryb domeny

Dane odpowiedzi

• WGP_ID = ID wpisu domeny w WGP
• domena = nazwa domeny
• order_num = numer zamówienia
• waluta = waluta konta kredytowego
• kwota = cena usługi
• acc_amount_before = saldo konta kredytowego przed aktywacją usługi
• acc_amount_current = saldo konta kredytowego po aktywacji usługi

Dane odpowiedzi powiadomienia

• WGP_ID = ID wpisu domeny w WGP
• domena = nazwa domeny
• order_num = numer zamówienia

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (żądanie oczekuje):

{
  "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"
    }
  } 
}

Powiadomienie JSON po zakończeniu konfiguracji:

{
  "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

Użyj polecenia wgp-domain-info , aby wyświetlić informacje o stanie domeny w usłudze WEDOS Protection.

Parametry

• domena = nazwa domeny (wymagane)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2202 = Nieprawidłowy lub nieobsługiwany format nazwy domeny
• 2206 = Nieprawidłowe żądanie – błąd wewnętrzny
• 2292 = Nie znaleziono domeny dla tego konta klienta w WGP API

Dane odpowiedzi

• wgp = stan domeny w WEDOS Protection; parametr stan ma jedną z następujących wartości, a niektóre z nich mogą zawierać różne dane:
  • pending_dns = trwa rozpoznawanie rekordów DNS domeny
  • przetwarzanie = oczekiwanie na konfigurację usługi
  • zablokowane = oczekiwanie na wymagania oprogramowania
  • pending_txt = oczekiwanie na weryfikację rekordu TXT (szablon częściowy)
  • pending_ns = oczekiwanie na konfigurację serwerów nazw (szablon częściowy dla trybu NS i tryb CNAME)
  • pending_dns_refresh = powtórne rozpoznawanie DNS, jeśli poprzedni pending_dns nie znalazł żadnych rekordów DNS
  • pending_crt = oczekiwanie na certyfikat Let’s Encrypt dla WG
  • aktywny = domena aktywna (pełny szablon)
• usługa = stan domeny w systemie WEDOS

Bardziej szczegółowe informacje o zwracanych danych znajdziesz w szablonie.

Szablony

Żądanie JSON:

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

Odpowiedź JSON (OK, stan aktywny):

{
  "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"
      }
    }
  }
}

Dane JSON (OK, stan 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"
        }
    }
}

Dane JSON (OK, stan pending_ns w ns trybie):

{
    ...
    "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"
        }
    }
}

Dane JSON (OK, stan pending_ns w cname trybie; crt_name i cname to nazwy i wartości rekordów, które użytkownik ma ustawić u swojego dostawcy 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

Użyj polecenia wgp-domain-renew , aby przedłużyć domenę w usłudze WEDOS Protection o kolejny okres.

Parametry

• service_id = ID usługi (wymagane)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2152 = Przedłużenie usługi zablokowane
• 2206 = Brak user_id
• 2279 = Konto kredytowe zablokowane
• 2281 = Nieaktywne konto kredytowe
• 2282 = Nieprawidłowa waluta konta kredytowego
• 2283 = Nieprawidłowa kwota lub niewystarczający kredyt
• 2284 = Błąd informacji o koncie kredytowym
• 2286 = Konto kredytowe – błąd wewnętrzny
• 2293 = Nie można pobrać salda kredytu na koncie kredytowym
• 2406 = Nie znaleziono domeny/usługi
• 2409 = Przedłużenie usługi nie powiodło się

Dane odpowiedzi

• service_id = ID usługi
• nazwa = Nazwa domeny
• date_from = Data ważności usługi
• date_to = Data wygaśnięcia usługi
• fakt_order_num = Numer zamówienia przedłużenia usługi
• waluta = Waluta konta kredytowego
• cena = Cena przedłużenia
• kredyt = Saldo konta kredytowego po przedłużeniu

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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

Użyj polecenia wgp-domain-delete , aby usunąć domenę z usługi WEDOS Protection.

Parametry

• service_id = ID usługi (wymagane)
• wymuś = Wymuszenie usunięcia niezależnie od rekordów A/AAAA domeny (opcjonalne, jeśli istnieje token do przepisania rekordów DNS)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2274 = Błąd wewnętrzny – brak parametru user_id
• 2292 = Nie znaleziono domeny na tym koncie użytkownika
• 2400 = Błąd wewnętrzny
• 2410 = Nie znaleziono usługi
• 2411 = Niedostępny token do przepisania DNS
• 2412 = Nieudane żądanie API do przepisania DNS
• 2413 = Żądanie nie powiodło się, WGP nie ma uprawnień do aktualizacji DNS
• 2414 = WGP nie ma tokenu, a użytkownik nie ustawił flagi force w WAPI

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = ID domeny
• wedos_client_id = ID klienta
• service_id = ID usługi
• service_type = typ usługi
• wdns_data = tablica aktualizacji IP

Szablony

Żądanie JSON:

{
  "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)
    }
  }
}

Odpowiedź JSON (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

Użyj polecenia wgp-domain-delete , aby usunąć zamówienie domeny z usługi WEDOS Protection. Przydaje się do usuwania usług, których utworzenie się nie powiodło.

To żądanie nie usunie istniejących usług. Do tego użyj wgp-domain-delete.

Parametry

• domena = nazwa domeny (wymagane)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2274 = Błąd wewnętrzny – brak parametru user_id
• 2292 = Nie znaleziono domeny na tym koncie użytkownika
• 2400 = Błąd wewnętrzny
• 2410 = Nie znaleziono usługi
• 2421 = Usługa WGP istnieje, domena nie zostanie usunięta

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = ID domeny
• wedos_client_id = ID klienta

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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
    }
  }
}

Odpowiedź JSON (Błąd – usługa WEDOS Protection już istnieje):

{
  "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

Użyj polecenia wgp-domain-update-subscription , aby zmienić taryfę lub okres rozliczeniowy usługi WEDOS Protection.

Parametry

• service_id = ID usługi (wymagane)
• new_variant_id = taryfa usługi (wymagane) – 1 = Start, 2 = Advanced, 3 = Expert
• new_period_id = okres rozliczeniowy (wymagane) – 1 = miesięcznie, 4 = rocznie

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2203 = Nieprawidłowy period_id
• 2273 = Nieprawidłowy wariant
• 2293 = nie można pobrać wartości kredytu
• 2294 = nie można pobrać ceny usługi
• 2279 = konto kredytowe zablokowane
• 2281 = nieaktywne konto kredytowe
• 2282 = nie można zapłacić w walucie kredytu
• 2283 = nieprawidłowa kwota lub niewystarczający pozostały kredyt
• 2284 = nieprawidłowe dane kontaktowe konta kredytowego
• 2285 = nieprawidłowe fakturowanie VAT
• 2286 = konto kredytowe – nieznany kod odpowiedzi
• 2400 = Wewnętrzny błąd WGP
• 2406 = Nie znaleziono domeny/usługi
• 2408 = Brak variant_id lub period_id

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = ID domeny
• wedos_client_id = ID klienta
• service_id = ID usługi
• service_type = typ usługi
• variant_id = ID taryfy usługi
• period_id = ID okresu rozliczeniowego
• dirty = znacznik aktualizacji (0 = bez zmian, 1 = zmieniono)

Szablony

Żądanie JSON:

{
  "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"
    }
  }
}

Odpowiedź JSON (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

Za pomocą polecenia wgp-domain-create-retry ponawiasz żądanie wydania certyfikatu. Możesz go użyć do rozwiązania stanu error_crt zwracanego przez polecenie wgp-domain-info .

Parametry

• domena = nazwa domeny (wymagane)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2292 = Nie znaleziono domeny na tym koncie użytkownika
• 2400 = Błąd wewnętrzny
• 4000 = Błąd wewnętrzny

Dane odpowiedzi

• domena = Nazwa domeny
• domain_id = ID domeny w WGP
• wedos_client_id = ID klienta

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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

Użyj wgp-domain-cache-purge , aby wyczyścić pamięć podręczną domeny WEDOS Protection.

Parametry

• service_id = ID usługi (wymagane)
• service_type = Typ usługi (opcjonalne)
  • wartości: hosting_wedos_protection (domyślnie), hosting_domain
• limiter_decay = Czas blokady w sekundach (opcjonalne)
  • wartość domyślna 5
• limiter_reset = Anulowanie limitera (opcjonalne)
  • 0 (nie, domyślnie), 1 (tak)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2274 = błąd wewnętrzny – brak user_id
• 2400 = błąd wewnętrzny – nieznany kod zwrotny
• 2406 = nie znaleziono domeny/usługi
• 2415 = osiągnięto wartość limitera
• 4000 = błąd systemu

Dane odpowiedzi

• domena = Nazwa domeny
• domain_id = ID domeny
• domain_tld = TLD domeny
• service_id = ID usługi
• wedos_client_id = ID klienta
• limiter_available_in = Czas w sekundach do ponownej dostępności funkcji

Szablony

Żądanie JSON:

{
  "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)
    }
  }
}

Odpowiedź JSON (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

Użyj polecenia wgp-domain-template-replicate , aby zmienić ustawienia domeny docelowej zgodnie z wybraną domeną szablonową.

Parametry

• service_id – ID usługi (wymagane)
• template_domain_id – ID docelowej domeny szablonowej (wymagane)
• service_type – typ usługi (opcjonalne)
  • wartości: hosting_domain, hosting_wedos_protection

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2101 = Niezgodność parametrów
• 2400 = Wewnętrzny błąd WGP
• 2401 = Nie można zastosować szablonu do domeny
• 2402 = Nieprawidłowy szablon domeny
• 2403 = Niezgodność szablonu domeny i użytkownika
• 2404 = Niezgodność szablonu domeny i taryfy domeny
• 2405 = Osiągnięto dzienny limit domen szablonowych
• 2406 = Nie znaleziono domeny/usługi
• 2407 = Nie znaleziono domeny szablonowej
• 4000 = Błąd wewnętrzny

Dane odpowiedzi

• domena = nazwa domeny
• domain_id = ID domeny
• service_id = ID usługi
• service_type = typ usługi
• template_domain_id = ID domeny szablonowej
• replications_count = liczba wykonanych replikacji
• replications_limit = maksymalna liczba replikacji

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (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

Użyj polecenia wgp-domain-templates-list , aby pobrać listę domen szablonowych dla wybranej taryfy WEDOS Protection.

Parametry

• variant_id = ID taryfy (wymagane)
• per_page = Liczba rekordów na stronę (domyślnie = 15, wszystkie rekordy = -1) (opcjonalne)
• strona = Numer strony (domyślnie = 1) (opcjonalne)
• locale = Język (domyślnie = en, obsługiwane = cs, en) (opcjonalne)
• szukaj = Wyszukiwanie w kolumnach custom_name, name (opcjonalne)

Wartości zwracane

• 1000 = OK
• 2100 = Brak wymaganego parametru
• 2400 = błąd wewnętrzny
• 4000 = błąd wewnętrzny

Dane odpowiedzi

• dane = Lista domen szablonowych
  • id = ID domeny szablonowej
  • custom_name = Nazwa domeny szablonowej (ustawiona przez użytkownika)
  • nazwa = Nazwa domeny szablonowej (systemowa)
  • url = URL domeny szablonowej
• first_page_url = URL pierwszej strony listy
• z = Początek paginacji
• last_page = Numer ostatniej strony
• last_page_url = URL ostatniej strony listy
• linki = Tablica odnośników paginacji
  • url = URL odnośnika
  • etykieta = Etykieta przycisku
  • aktywny = null|1
• next_page_url = URL następnej strony
• path = URL listy domen szablonowych
• per_page = Liczba wpisów na stronę
• prev_page_url = URL poprzedniej strony
• do = Koniec paginacji
• łącznie = Łączna liczba stron

Szablony

Żądanie JSON:

{
  "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)"
    }
  }
}

Odpowiedź JSON (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

Za pomocą polecenia wgp-services-list możesz pobrać listę domen z usługą WEDOS Protection. Możesz filtrować według stanu.

Parametry

• status = stan usługi (opcjonalne)

Wartości zwracane

• 1000 = OK
• 2206 = Nieprawidłowe żądanie – błąd wewnętrzny

Dane odpowiedzi

• ID = ID wpisu domeny
• nazwa = nazwa domeny
• status = stan usługi
• wygaśnięcie = Data wygaśnięcia usługi WG

Szablony

Żądanie JSON

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

Odpowiedź JSON (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"
    }
  }
}