WAPI - Protection WEDOS (WGP)

Cet article fournit des informations sur les commandes suivantes :

• wgp-domain-create - ajouter un domaine à la protection WEDOS
• wgp-domain-info - liste les informations relatives au domaine de protection WEDOS
• wgp-domain-renew - renouveler le service
• wgp-domain-delete - mettre fin au service
• wgp-domain-update-subscription - changer de plan
• wgp-domain-retry - résoudre certaines erreurs
• wgp-domain-cache-purge - purge le cache de WP
• wgp-domain-template-replicate - réplique un modèle dans un domaine existant
• wgp-domain-templates-list - liste de modèles de domaines
• wgp-services-list - Liste des domaines de protection WEDOS

---

wgp-domain-create

Utilisez la requête wgp-domain-create pour créer un enregistrement de domaine dans WEDOS Protection. Cette requête est asynchrone et communique via les notifications &boxbox ;.

Paramètres

• domain = nom de domaine (obligatoire)
• variant_id = plan de service (obligatoire) - 1 = Start, 2 = Advanced, 3 = Expert(vous trouverez les plans et leurs prix sur le site du produit &boxbox ;)
• period_id = période de service (obligatoire) - 1 = mensuel, 4 = annuel
• upstream_ips = tableau d'adresses IP cibles (facultatif) - vous trouverez plus d'informations sur les adresses IP cibles dans l'article Protection - DNS et adresses IP cibles.
• template_domain_id = ID du domaine du modèle (facultatif)
• mode = mode domaine (optionnel)
  • ns = utilise WEDOS NS (par défaut) ; le système n'activera le domaine que s'il vérifie avec succès qu'il utilise WEDOS DNS.
  • cname = permet d'utiliser les serveurs DNS d'un autre fournisseur, ou d'ajouter des sous-domaines via un enregistrement CNAME ; le mode pour tout domaine de troisième niveau ou de niveau supérieur est toujours cname.

Valeurs de retour

• 1000 = OK
• 1001 = Demande en attente
• 2101 = Inadéquation des paramètres
• 2202 = Format de nom de domaine non valide ou non pris en charge
• 2203 = Numéro d'identification de la période invalide
• 2206 = Demande non valide - erreur interne
• 2272 = Format invalide de l'adresse IP
• 2273 = Variante non valide
• 2274 = Erreur interne - paramètre user_id manquant
• 2275 = Erreur interne - utilisateur introuvable
• 2276 = TLD non pris en charge ou niveau de domaine maximal dépassé
• 2277 = Interdit de faire précéder le nom de domaine de www.
• 2278 = Le nom de domaine ne peut pas être utilisé - il y a un service avec ce nom de domaine
• 2279 = Le compte de crédit est bloqué
• 2280 = Compte de crédit actif
• 2281 = Compte de crédit inactif
• 2282 = Devise du compte de crédit invalide
• 2283 = Montant invalide ou crédit insuffisant
• 2284 = Erreur d'information sur le compte de crédit
• 2285 = Paramètres de TVA incorrects
• 2286 = Compte créditeur - erreur interne
• 2290 = Compte de crédit - l'activité n'a pas été ajoutée au compte de crédit
• 2291 = Le domaine existe déjà pour ce compte client dans l'API WGP
• 2293 = Impossible d'obtenir le solde créditeur du compte de crédit
• 2294 = Impossible de retirer le prix du service
• 2295 = Impossible de créer un domaine vers WGP. Le paiement a été annulé.
• 2296 = Le mouvement du compte de crédit ne peut pas être annulé
• 2400 = Erreur WGP Intenral
• 2401 = Impossible d'appliquer le modèle au domaine
• 2402 = Modèle de domaine invalide
• 2403 = Inadéquation entre le modèle de domaine et l'utilisateur
• 2404 = Inadéquation entre le modèle de domaine et le plan de domaine
• 2405 = Domaine du modèle journalier atteint
• 2416 = Mode de domaine non valide

Données de réponse

• WGP_ID = ID de l'enregistrement du domaine WGP
• domaine = nom de domaine
• order_num = numéro de commande
• devise = devise du compte de crédit
• montant = prix du service
• acc_amount_before = créditer le solde du compte avant l'activation du service
• acc_amount_current = solde créditeur du compte après l'activation du service

Données de réponse à la notification

• WGP_ID = ID de l'enregistrement du domaine WGP
• domaine = nom de domaine
• order_num = numéro de commande

Modèles

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

Réponse JSON (demande en cours) :

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

Notification JSON une fois l'installation terminée :

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

Utilisez la requête wgp-domain-info pour afficher les informations sur l'état du domaine dans le service de protection WEDOS.

Paramètres

• domain = nom de domaine (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2101 = Inadéquation des paramètres
• 2202 = Format de nom de domaine non valide ou non pris en charge
• 2206 = Demande non valide - erreur interne
• 2292 = Domaine non trouvé pour ce compte client dans l'API WGP

Données de réponse

• wgp = statut de domaine dans la protection WEDOS ; le État a l'une des valeurs suivantes, dont certaines peuvent contenir des données différentes :
  • pending_dns = domaine Résolution d'enregistrement DNS en cours
  • traitement = attente de la mise en place du service
  • bloqué = en attente des exigences du logiciel
  • pending_txt = en attente de vérification de l'enregistrement TXT(modèle partiel)
  • pending_ns = en attente de l'installation du serveur de noms(modèle partiel pour le mode NS et le mode CNAME)
  • pending_dns_refresh = résolution DNS répétée, si le précédent pending_dns n'a trouvé aucun enregistrement DNS
  • pending_crt = attente d'un certificat Let's Encrypt pour le WG
  • actif = domaine actif(modèle complet)
• service = état du domaine dans le système WEDOS

Vous trouverez des informations plus détaillées sur les données de retour dans le modèle.

Modèles

Demande JSON :

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

Réponse JSON (OK, état actif) :

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

Données JSON (OK, état 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"
        }
    }
}

Données JSON (OK, état pending_ns en mode 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"
        }
    }
}

Données JSON (OK, état en attente_ns en nom mode ; crt_name et cname sont des noms d'enregistrement et des valeurs que l'utilisateur doit définir avec son fournisseur 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

Utilisez la requête wgp-domain-renew pour prolonger le domaine dans le service de protection WEDOS pour une autre période.

Paramètres

• service_id = identifiant du service (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2101 = Inadéquation des paramètres
• 2152 = Renouvellement du service bloqué
• 2206 = ID utilisateur manquant
• 2279 = Compte de crédit bloqué
• 2281 = Compte de crédit inactif
• 2282 = Devise du compte de crédit invalide
• 2283 = Montant invalide ou crédit insuffisant
• 2284 = Erreur d'information sur le compte de crédit
• 2286 = Compte créditeur - erreur interne
• 2293 = Impossible d'obtenir le solde créditeur du compte de crédit
• 2406 = Domaine/service introuvable
• 2409 = Échec du renouvellement du service

Données de réponse

• service_id = identifiant du service
• name = Nom de domaine
• date_from = Date de validité du service
• date_to = Date d'expiration du service
• fakt_order_num = Numéro de commande pour le renouvellement du service
• devise = devise du compte de crédit
• prix = Prix du renouvellement
• crédit = solde du compte après renouvellement

Modèles

Demande JSON :

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

Réponse 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

Utilisez la commande wgp-domain-delete pour supprimer un domaine du service WEDOS Protection.

Paramètres

• service_id = identifiant du service (obligatoire)
• force = Forcer la suppression sans tenir compte des enregistrements de domaine A/AAAA (facultatif si un jeton existe pour réécrire les enregistrements DNS)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2274 = Erreur interne - paramètre user_id manquant
• 2292 = Domaine non trouvé dans ce compte d'utilisateur
• 2400 = Erreur interne
• 2410 = Service non trouvé
• 2411 = Jeton non disponible pour réécrire le DNS
• 2412 = Échec de la demande API de réécriture du DNS
• 2413 = Échec de la demande, le WGP n'a pas la permission de mettre à jour le DNS
• 2414 = Le WGP n'a pas de jeton et l'utilisateur n'a pas activé l'indicateur de force dans l'interface WAPI.

Données de réponse

• domaine = nom de domaine
• domain_id = ID du domaine
• wedos_client_id = ID du client
• service_id = identifiant du service
• service_type = type de service
• wdns_data = tableau de mises à jour d'IP

Modèles

Demande 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)
    }
  }
}

Réponse 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-update-subscription

Utilisez la demande wgp-domain-update-subscription pour modifier le plan ou la période de facturation du service WEDOS Protection.

Paramètres

• service_id = identifiant du service (obligatoire)
• variant_id = plan de service (optionnel) - 1 = Start, 2 = Advanced, 3 = Expert
• period_id = période de facturation (facultatif) - 1 = mensuelle, 4 = annuelle

Pour que la demande fonctionne correctement, il faut saisir au moins un des paramètres variant_id ou period_id.

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2101 = Inadéquation des paramètres
• 2203 = Numéro d'identification de la période invalide
• 2273 = Variante non valide
• 2400 = Erreur WGP Intenral
• 2406 = Domaine/service non financé
• 2408 = ID_variante ou ID_période manquante

Données de réponse

• domaine = nom de domaine
• domain_id = ID du domaine
• wedos_client_id = ID du client
• service_id = identifiant du service
• service_type = type de service
• variant_id = ID du plan de service
• period_id = identifiant de la période de facturation
• sale = coche de mise à jour (0 = identique, 1 = modifié)

Modèles

Demande JSON :

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

Réponse 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-retry

La commande wgp-domain-retry permet de répéter la demande d'émission d'un certificat. Vous pouvez l'utiliser pour résoudre le statut error_crt renvoyé par la commande wgp-domain-info.

Paramétrie

• domain = nom de domaine (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2292 = Domaine non trouvé dans ce compte d'utilisateur
• 2400 = Erreur interne
• 4000 = Erreur interne

Données de réponse

• domain = Nom de domaine
• domain_id = ID du domaine dans le WGP
• wedos_client_id = ID du client

Modèles

Demande JSON :

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

Réponse JSON (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

Utilisez wgp-domain-cache-purge pour purger le cache du domaine de protection WEDOS.

Paramètres

• service_id = identifiant du service (obligatoire)
• type_de_service = Type de service (facultatif)
  • valeurs : hosting_wedos_protection (par défaut), hosting_domain
• limiter_decay = Temps de blocage en secondes (facultatif)
  • valeur par défaut 5
• limiter_reset = Limiteur d'annulation (en option)
  • 0 (non, par défaut), 1 (oui)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2101 = Inadéquation des paramètres
• 2274 = erreur interne - user_id manquant
• 2400 = erreur interne - code de retour inconnu
• 2406 = domaine/service introuvable
• 2415 = valeur du limiteur atteinte
• 4000 = erreur système

Données de réponse

• domain = Nom de domaine
• domain_id = ID du domaine
• domain_tld = Domaine TLD
• service_id = ID du service
• wedos_client_id = ID du client
• limiter_available_in = Temps en secondes jusqu'à ce que la fonction soit à nouveau disponible

Modèles

Demande 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)
    }
  }
}

Réponse 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

Utilisez la requête wgp-domain-template-replicate pour modifier les paramètres du domaine cible en fonction du domaine modèle sélectionné.

Paramètres

• service_id - identifiant du service (obligatoire)
• template_domain_id - ID du domaine du modèle cible (obligatoire)
• type_de_service - type de service (facultatif)
  • valeurs : hosting_domain, hosting_wedos_protection

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2101 = Inadéquation des paramètres
• 2400 = Erreur interne du WGP
• 2401 = Impossible d'appliquer le modèle au domaine
• 2402 = Modèle de domaine invalide
• 2403 = Inadéquation entre le modèle de domaine et l'utilisateur
• 2404 = Inadéquation entre le modèle de domaine et le plan de domaine
• 2405 = Domaine du modèle journalier atteint
• 2406 = Domaine/service introuvable
• 2407 = Domaine du modèle non trouvé
• 4000 = Erreur interne

Données de réponse

• domaine = nom de domaine
• domain_id = ID du domaine
• service_id = identifiant du service
• service_type = type de service
• template_domain_id = ID du domaine du modèle
• replications_count = nombre de réplications effectuées
• replications_limit = nombre maximal de réplications

Modèles

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

Réponse 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

Utilisez la requête wgp-domain-templates-list pour récupérer une liste de domaines modèles pour le plan de protection WEDOS sélectionné.

Paramètres

• variant_id = ID du plan (obligatoire)
• per_page = Nombre d'enregistrements par page (par défaut = 15, obtenir tous les enregistrements = -1) (facultatif)
• page = Numéro de page (par défaut = 1) (facultatif)
• locale = Langue (par défaut = en, supporté = cs, en) (optionnel)
• search = Recherche par colonnes custom_name, name (optionnel)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre requis manquant
• 2400 = erreur interne
• 4000 = erreur interne

Données de réponse

• données = Liste des domaines modèles
  • id = ID du domaine du modèle
  • custom_name = Nom de domaine du modèle (tel que défini par l'utilisateur)
  • name = Nom de domaine du modèle (système)
  • url = URL du domaine du modèle
• first_page_url = URL de la première page de la liste
• from = Début de la pagination
• last_page = Numéro de la dernière page
• last_page_url = URL de la dernière page de la liste
• liens = Lien de pagination
  • url = URL du lien
  • label = étiquette du bouton
  • actif = null|1
• next_page_url = URL de la page suivante
• path = URL de la liste des domaines du modèle
• per_page = Nombre d'entrées par page
• prev_page_url = URL de la page précédente
• to = Fin de la pagination
• total = Nombre total de pages

Modèles

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

Réponse 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
    }
  }
}

---

Liste des services wgp

La requête wgp-services-list permet d'obtenir la liste des domaines dotés du service WEDOS Protection. Vous pouvez filtrer par état.

Paramètres

• status = état du service (facultatif)

Valeurs de retour

• 1000 = OK
• 2206 = Demande non valide - erreur interne

Données de réponse

• ID = ID de l'enregistrement du domaine
• nom = nom de domaine
• statut = statut du domaine
• expiration = date d'expiration du service du GT

Modèles

Demande JSON

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

Réponse 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"
    }
  }
}