WAPI - WEDOS-Schutz (WGP)

Dieser Artikel enthält Informationen zu den folgenden Befehlen:

• wgp-domain-create - Hinzufügen einer Domäne zum WEDOS-Schutz
• wgp-domain-info - Liste der WEDOS-Schutzdomäneninformationen
• wgp-domain-renew - Dienst erneuern
• wgp-domain-delete - Dienst beenden
• wgp-domain-update-subscription - Plan ändern
• wgp-domain-retry - Behebung einiger Fehler
• wgp-domain-cache-purge - WP-Cache bereinigen
• wgp-domain-template-replicate - repliziert eine Vorlage in eine bestehende Domäne
• wgp-domain-templates-list - Liste der Domänenvorlagen
• wgp-services-list - Liste der WEDOS-Schutzdomänen

---

wgp-domain-create

Verwenden Sie die Anforderung wgp-domain-create, um einen Domäneneintrag in WEDOS Protection zu erstellen. Diese Anforderung ist asynchron und kommuniziert über Benachrichtigungen ⧉.

Parameter

• domain = Domänenname (erforderlich)
• variant_id = Serviceplan (erforderlich) - 1 = Start, 2 = Advanced, 3 = Expert(die Pläne und ihre Preise finden Sie auf der Produktseite ⧉)
• period_id = Dienstzeitraum (erforderlich) - 1 = monatlich, 4 = jährlich
• upstream_ips = Array von IP-Zieladressen (optional) - weitere Informationen über Ziel-IPs finden Sie im Artikel Schutz - DNS und Ziel-IPs
• template_domain_id = ID der Vorlagendomäne (optional)
• Modus = Domänenmodus (optional)
  • ns = verwendet WEDOS NS (Standard); das System aktiviert die Domäne nur, wenn es erfolgreich überprüft, dass sie WEDOS DNS verwendet.
  • cname = ermöglicht die Nutzung der DNS-Server eines anderen Anbieters oder das Hinzufügen von Subdomains über einen CNAME-Eintrag; der Modus für jede Domain der dritten oder höheren Ebene ist immer cname.

Rückgabewerte

• 1000 = OK
• 1001 = Anforderung ausstehend
• 2101 = Parameter stimmen nicht überein
• 2202 = Ungültiges oder nicht unterstütztes Domänennamenformat
• 2203 = Ungültige period_id
• 2206 = Ungültige Anfrage - interner Fehler
• 2272 = Ungültiges Format der IP-Adresse
• 2273 = Ungültige Variante
• 2274 = Interner Fehler - Parameter user_id fehlt
• 2275 = Interner Fehler - Benutzer nicht gefunden
• 2276 = Nicht unterstützte TLD oder maximale Domänenebene überschritten
• 2277 = Es ist nicht erlaubt, www. ausdrücklich vor den Domänennamen zu setzen
• 2278 = Domainname kann nicht verwendet werden - es gibt einen Dienst mit diesem Domainnamen
• 2279 = Guthabenkonto ist gesperrt
• 2280 = Guthabenkonto aktiv
• 2281 = Inaktives Kreditkonto
• 2282 = Ungültige Kreditkontowährung
• 2283 = Ungültiger Betrag oder unzureichendes Guthaben
• 2284 = Fehler in der Kreditkontoinformation
• 2285 = Falsche Mehrwertsteuereinstellungen
• 2286 = Kreditkonto - interner Fehler
• 2290 = Guthabenkonto - Leistung wurde dem Guthabenkonto nicht hinzugefügt
• 2291 = Domain existiert bereits für dieses Kundenkonto in der WGP API
• 2293 = Das Guthaben auf dem Kreditkonto kann nicht abgefragt werden
• 2294 = Preis der Dienstleistung kann nicht zurückgezogen werden
• 2295 = Domäne zu WGP kann nicht erstellt werden. Die Zahlung wurde storniert.
• 2296 = Kontobewegung im Haben kann nicht storniert werden
• 2400 = Intenraler WGP-Fehler
• 2401 = Vorlage kann nicht auf Domäne angewendet werden
• 2402 = Ungültige Domänenvorlage
• 2403 = Domänenvorlage und Benutzer stimmen nicht überein
• 2404 = Domänenvorlage und Domänenplan stimmen nicht überein
• 2405 = Täglicher Vorlagenbereich erreicht
• 2416 = Ungültiger Domänenmodus

Antwortdaten

• WGP_ID = ID des WGP-Domäneneintrags
• domain = Domänenname
• order_num = Auftragsnummer
• Währung = Währung des Kreditkontos
• Betrag = Preis der Dienstleistung
• acc_amount_before = Guthaben auf dem Konto vor der Aktivierung des Dienstes
• acc_amount_current = Guthaben auf dem Konto nach Aktivierung des Dienstes

Daten der Benachrichtigungsantwort

• WGP_ID = ID des WGP-Domäneneintrags
• domain = Domänenname
• order_num = Auftragsnummer

Schablonen

JSON-Anfrage:

{
  "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-Antwort (Anfrage steht noch aus):

{
  "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-Benachrichtigung nach Abschluss der Einrichtung:

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

Verwenden Sie die Abfrage wgp-domain-info, um Domänenstatusinformationen im WEDOS-Schutzdienst anzuzeigen.

Parameter

• domain = Domänenname (erforderlich)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2101 = Parameter stimmen nicht überein
• 2202 = Ungültiges oder nicht unterstütztes Domänennamenformat
• 2206 = Ungültige Anfrage - interner Fehler
• 2292 = Domäne für dieses Kundenkonto in der WGP-API nicht gefunden

Antwortdaten

• wgp = Domänenstatus im WEDOS-Schutz; die Staat hat einen der folgenden Werte, von denen einige unterschiedliche Daten enthalten können:
  • pending_dns = Auflösung des DNS-Datensatzes der Domäne in Bearbeitung
  • Bearbeitung = Warten auf die Einrichtung des Dienstes
  • festgefahren = Warten auf Softwareanforderungen
  • pending_txt = Warten auf die Überprüfung des TXT-Datensatzes(Teilvorlage)
  • pending_ns = Warten auf Nameserver-Einrichtung(Teilvorlage für NS- und CNAME-Modus)
  • pending_dns_refresh = wiederholte DNS-Auflösung, wenn das vorherige pending_dns keine DNS-Einträge gefunden hat
  • pending_crt = Warten auf Let's Encrypt-Zertifikat für WG
  • aktiv = Domäne aktiv(vollständige Vorlage)
• service = Domänenstatus im WEDOS-System

Nähere Informationen zu den Rücksendedaten finden Sie in der Vorlage.

Schablonen

JSON-Anfrage:

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

JSON-Antwort (OK, Zustand aktiv):

{
  "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-Daten (OK, Status 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-Daten (OK, Status pending_ns im ns-Modus ):

{
    ...
    "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-Daten (OK, Zustand schwebend_n in cName Modus; crt_name und cname sind Datensatznamen und -werte, die der Benutzer bei seinem DNS-Anbieter einstellen muss):

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

Verwenden Sie die Anforderung wgp-domain-renew, um die Domäne im WEDOS-Schutzdienst um einen weiteren Zeitraum zu verlängern.

Parameter

• service_id = Dienst-ID (erforderlich)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2101 = Parameter stimmen nicht überein
• 2152 = Dienstverlängerung blockiert
• 2206 = Fehlende user_id
• 2279 = Kreditkonto gesperrt
• 2281 = Inaktives Kreditkonto
• 2282 = Ungültige Kreditkontowährung
• 2283 = Ungültiger Betrag oder unzureichendes Guthaben
• 2284 = Fehler in der Kreditkontoinformation
• 2286 = Kreditkonto - interner Fehler
• 2293 = Das Guthaben auf dem Kreditkonto kann nicht abgefragt werden
• 2406 = Domäne/Dienst nicht gefunden
• 2409 = Dienstverlängerung fehlgeschlagen

Antwortdaten

• dienst_id = Dienst-ID
• name = Domänenname
• date_from = Gültigkeitsdatum der Dienstleistung
• date_to = Ablaufdatum der Dienstleistung
• fakt_order_num = Auftragsnummer für die Erneuerung der Dienstleistung
• Währung = Währung des Kreditkontos
• Preis = Erneuerungspreis
• credit = Guthaben auf dem Konto nach der Erneuerung

Schablonen

JSON-Anfrage:

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

JSON-Antwort (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

Verwenden Sie den Befehl wgp-domain-delete, um eine Domäne aus dem WEDOS-Schutzdienst zu löschen.

Parameter

• service_id = Dienst-ID (erforderlich)
• force = Löschung unabhängig von A/AAAA-Domäneneinträgen erzwingen (optional, wenn Token zum Umschreiben von DNS-Einträgen vorhanden ist)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2274 = Interner Fehler - Parameter user_id fehlt
• 2292 = Domäne nicht in diesem Benutzerkonto gefunden
• 2400 = Interner Fehler
• 2410 = Dienst nicht gefunden
• 2411 = Nicht verfügbares Token zum Umschreiben von DNS
• 2412 = Fehlgeschlagene API-Anfrage zum Umschreiben von DNS
• 2413 = Anfrage fehlgeschlagen, WGP hat keine Berechtigung, DNS zu aktualisieren
• 2414 = WGP hat kein Token und der Benutzer hat das Force-Flag in der WAPI nicht gesetzt

Antwortdaten

• domain = Domänenname
• domain_id = Domänen-ID
• wedos_client_id = Kunden-ID
• dienst_id = Dienst-ID
• service_type = Art der Dienstleistung
• wdns_data = Array von IP-Aktualisierungen

Schablonen

JSON-Anfrage:

{
  "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-Antwort (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-update-subscription

Verwenden Sie die Anforderung wgp-domain-update-subscription, um den Plan oder den Abrechnungszeitraum des WEDOS-Schutzdienstes zu ändern.

Parameter

• service_id = Dienst-ID (erforderlich)
• variant_id = Dienstplan (optional) - 1 = Start, 2 = Fortgeschritten, 3 = Experte
• period_id = Abrechnungszeitraum (optional) - 1 = monatlich, 4 = jährlich

Damit die Anfrage korrekt funktioniert, müssen Sie mindestens einen der Parameter variant_id oder period_id angeben.

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2101 = Parameter stimmen nicht überein
• 2203 = Ungültige period_id
• 2273 = Ungültige Variante
• 2400 = Intenraler WGP-Fehler
• 2406 = Bereich/Dienst nicht finanziert
• 2408 = Fehlende variant_id oder period_id

Antwortdaten

• domain = Domänenname
• domain_id = Domänen-ID
• wedos_client_id = Kunden-ID
• dienst_id = Dienst-ID
• service_type = Art der Dienstleistung
• variant_id = Dienstplan-ID
• period_id = ID des Abrechnungszeitraums
• schmutzig = Aktualisierungshäkchen (0 = gleich wie vorher, 1 = geändert)

Schablonen

JSON-Anfrage:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-update-subscription",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
      "period_id": "1 = monthly billing, 4 = annual"
    }
  }
}

JSON-Antwort (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-retry

Mit dem Befehl wgp-domain-retry wiederholen Sie die Anforderung zur Ausstellung eines Zertifikats. Sie können ihn verwenden, um den vom Befehl wgp-domain-info zurückgegebenen Status error_crt aufzulösen.

Parametrisierung

• domain = Domänenname (erforderlich)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2292 = Domäne nicht in diesem Benutzerkonto gefunden
• 2400 = Interner Fehler
• 4000 = Interner Fehler

Antwortdaten

• domain = Domänenname
• domain_id = Domänen-ID im WGP
• wedos_client_id = Kunden-ID

Schablonen

JSON-Anfrage:

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

JSON-Antwort (OK):

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

---

wgp-domain-cache-purge

Verwenden Sie wgp-domain-cache-purge, um den WEDOS Protection Domain Cache zu löschen.

Parameter

• service_id = Dienst-ID (erforderlich)
• dienst_art = Dienstart (fakultativ)
  • Werte: hosting_wedos_protection (Standard), hosting_domain
• limiter_decay = Sperrzeit in Sekunden (optional)
  • Standardwert 5
• limiter_reset = Begrenzer abbrechen (optional)
  • 0 (nein, Standard), 1 (ja)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2101 = Parameter stimmen nicht überein
• 2274 = interner Fehler - fehlende user_id
• 2400 = interner Fehler - unbekannter Rückgabecode
• 2406 = Domäne/Dienst nicht gefunden
• 2415 = Begrenzerwert erreicht
• 4000 = Systemfehler

Antwortdaten

• domain = Domänenname
• domain_id = Domänen-ID
• domain_tld = Domäne TLD
• service_id = Dienst-ID
• wedos_client_id = Kunden-ID
• limiter_available_in = Zeit in Sekunden, bis die Funktion wieder verfügbar ist

Schablonen

JSON-Anfrage:

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

Verwenden Sie die Anforderung wgp-domain-template-replicate, um die Einstellungen der Zieldomäne entsprechend der ausgewählten Vorlagendomäne zu ändern.

Parameter

• service_id - Dienst-ID (erforderlich)
• template_domain_id - ID der Zieldomäne der Vorlage (erforderlich)
• dienst_art - Dienstart (optional)
  • Werte: hosting_domain, hosting_wedos_protection

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2101 = Parameter stimmen nicht überein
• 2400 = Interner WGP-Fehler
• 2401 = Vorlage kann nicht auf Domäne angewendet werden
• 2402 = Ungültige Domänenvorlage
• 2403 = Domänenvorlage und Benutzer stimmen nicht überein
• 2404 = Domänenvorlage und Domänenplan stimmen nicht überein
• 2405 = Täglicher Vorlagenbereich erreicht
• 2406 = Domäne/Dienst nicht gefunden
• 2407 = Vorlagendomäne nicht gefunden
• 4000 = Interner Fehler

Antwortdaten

• domain = Domänenname
• domain_id = Domänen-ID
• dienst_id = Dienst-ID
• service_type = Art der Dienstleistung
• template_domain_id = ID der Vorlagendomäne
• replications_count = Anzahl der durchgeführten Replikationen
• replications_limit = maximale Anzahl der Replikationen

Schablonen

JSON-Anfrage:

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

Verwenden Sie die Anfrage wgp-domain-templates-list, um eine Liste der Vorlagendomänen für den ausgewählten WEDOS-Schutzplan abzurufen.

Parameter

• variant_id = Plan-ID (erforderlich)
• per_page = Anzahl der Datensätze pro Seite (Standard = 15, get all records = -1) (optional)
• page = Seitennummer (Standard = 1) (optional)
• locale = Sprache (Standard = en, unterstützt = cs, en) (optional)
• search = Suche nach den Spalten custom_name, name (optional)

Rückgabewerte

• 1000 = OK
• 2100 = Erforderlicher Parameter fehlt
• 2400 = interner Fehler
• 4000 = interner Fehler

Antwortdaten

• Daten = Liste der Vorlagendomänen
  • id = ID des Vorlagenbereichs
  • custom_name = Name der Vorlagendomäne (wie vom Benutzer festgelegt)
  • name = Name der Vorlagendomäne (System)
  • url = URL der Vorlagendomäne
• first_page_url = URL der ersten Listenseite
• from = Beginn der Paginierung
• last_page = Nummer der letzten Seite
• last_page_url = URL der letzten Listenseite
• Links = Paginierung Link arrary
  • url = Link-URL
  • label = Beschriftung der Schaltfläche
  • aktiv = null|1
• next_page_url = URL der nächsten Seite
• Pfad = URL der Vorlagendomänenliste
• per_page = Anzahl der Einträge pro Seite
• prev_page_url = URL der vorherigen Seite
• bis = Paginierung Ende
• total = Gesamtseitenzahl

Schablonen

JSON-Anfrage:

{
  "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-Antwort (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-dienste-liste

Mit der Anfrage wgp-services-list können Sie eine Liste der Domänen mit dem WEDOS-Schutzdienst abrufen. Sie können nach Status filtern.

Parameter

• status = Dienststatus (optional)

Rückgabewerte

• 1000 = OK
• 2206 = Ungültige Anfrage - interner Fehler

Antwortdaten

• ID = ID des Domäneneintrags
• name = Domänenname
• status = Status der Domäne
• expiration = Ablaufdatum des WG-Dienstes

Schablonen

JSON-Anfrage

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-create",
    "clTRID": "own ID code",
    "data": {
      "status": "pending_dns, processing, stuck, pending_txt, pending_ns, pending_dns_refresh, pending_crt, or active"
    }
  }
}

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