WAPI – WEDOS Protection (WGP)

Cet article présente les commandes suivantes :

• wgp-domain-create – ajouter un domaine à WEDOS Protection
• wgp-domain-info – afficher les informations d’un domaine WEDOS Protection
• wgp-domain-renew – renouveler le service
• wgp-domain-delete – résilier le service
• wgp-domain-update-subscription – changer de forfait
• wgp-domain-create-retry – résoudre certaines erreurs
• wgp-domain-cache-purge – vider le cache WP
• wgp-domain-template-replicate – réplique un modèle vers un domaine existant
• wgp-domain-templates-list – liste des domaines modèles
• wgp-services-list – liste des domaines WEDOS Protection

---

wgp-domain-create

Utilisez la commande wgp-domain-create pour créer un enregistrement de domaine dans WEDOS Protection. Cette requête est asynchrone et communique par notifications ⧉.

Paramètres

• domaine = nom de domaine (obligatoire)
• variant_id = forfait du service (obligatoire) – 1 = Start, 2 = Advanced, 3 = Expert (vous trouverez les forfaits et leurs tarifs sur le site du produit ⧉)
• period_id = période du service (obligatoire) – 1 = mensuelle, 4 = annuelle
• upstream_ips = tableau des adresses IP cibles (facultatif) – vous trouverez plus d’informations sur les IP cibles dans l’ Protection – Cibles upstream article
• template_domain_id = ID du domaine modèle (facultatif)
• mode = mode du domaine (facultatif)
  • ns = utilise les NS WEDOS (par défaut) ; le système n’active le domaine que s’il vérifie avec succès qu’il utilise WEDOS DNS.
  • cname = vous permet d’utiliser les serveurs DNS d’un autre fournisseur ou d’ajouter des sous-domaines via un enregistrement CNAME ; pour tout domaine de 3e niveau ou supérieur, le mode est toujours cname.

Valeurs de retour

• 1000 = OK
• 1001 = Requête en attente
• 2101 = Paramètres incohérents
• 2202 = Format de nom de domaine invalide ou non pris en charge
• 2203 = period_id invalide
• 2206 = Requête invalide – erreur interne
• 2272 = Format d’adresse IP invalide
• 2273 = Variante invalide
• 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 = Il est interdit de préfixer explicitement le nom de domaine par www.
• 2278 = Nom de domaine inutilisable – un service porte déjà 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 des informations du compte de crédit
• 2285 = Paramètres de TVA incorrects
• 2286 = Compte de crédit – erreur interne
• 2290 = Compte de crédit – l’opération n’a pas été ajoutée au compte de crédit
• 2291 = Le domaine existe déjà pour ce compte client dans WGP API
• 2293 = Impossible de récupérer le solde du compte de crédit
• 2294 = Impossible de récupérer le prix du service
• 2295 = Impossible de créer le domaine dans WGP. Le paiement a été annulé.
• 2296 = Le mouvement du compte de crédit ne peut pas être annulé
• 2400 = Erreur interne WGP
• 2401 = Impossible d’appliquer le modèle au domaine
• 2402 = Domaine modèle invalide
• 2403 = Le domaine modèle ne correspond pas à l’utilisateur
• 2404 = Le domaine modèle ne correspond pas au forfait du domaine
• 2405 = Limite quotidienne de domaines modèles atteinte
• 2416 = Mode de domaine invalide

Données de la réponse

• WGP_ID = ID de l’enregistrement de domaine WGP
• domaine = nom de domaine
• order_num = numéro de commande
• currency = devise du compte de crédit
• amount = prix du service
• acc_amount_before = solde du compte de crédit avant activation du service
• acc_amount_current = solde du compte de crédit après activation du service

Données de la notification

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

Modèles

Requête 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 = Free, 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 (requête en attente) :

{
  "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 après la fin de la configuration :

{
  "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 commande wgp-domain-info pour afficher les informations d’état d’un domaine dans le service WEDOS Protection.

Paramètres

• domaine = nom de domaine (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2101 = Paramètres incohérents
• 2202 = Format de nom de domaine invalide ou non pris en charge
• 2206 = Requête invalide – erreur interne
• 2292 = Domaine introuvable pour ce compte client dans WGP API

Données de la réponse

• wgp = état du domaine dans WEDOS Protection ; le paramètre état prend une des valeurs suivantes, dont certaines peuvent contenir des données différentes :
  • pending_dns = résolution des enregistrements DNS du domaine en cours
  • traitement = en attente de la configuration du service
  • bloqué = en attente des prérequis logiciels
  • pending_txt = en attente de la vérification de l’enregistrement TXT (modèle partiel)
  • pending_ns = en attente de la configuration des serveurs de noms (modèle partiel pour le mode NS et mode CNAME)
  • pending_dns_refresh = nouvelle résolution DNS, si le pending_dns précédent n’a trouvé aucun enregistrement DNS
  • pending_crt = en attente du certificat Let’s Encrypt pour WG
  • active = 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

Requête JSON :

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

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

{
  "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 ns mode) :

{
    ...
    "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 pending_ns en cname mode ; crt_name et cname sont les noms et les valeurs des enregistrements que l’utilisateur doit définir chez 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 commande wgp-domain-renew pour prolonger le domaine dans le service WEDOS Protection d’une période supplémentaire.

Paramètres

• service_id = ID du service (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2101 = Paramètres incohérents
• 2152 = Renouvellement du service bloqué
• 2206 = user_id 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 des informations du compte de crédit
• 2286 = Compte de crédit – erreur interne
• 2293 = Impossible de récupérer le solde du compte de crédit
• 2406 = Domaine/service introuvable
• 2409 = Échec du renouvellement du service

Données de la réponse

• service_id = ID 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 du renouvellement du service
• currency = Devise du compte de crédit
• price = Prix du renouvellement
• credit = Solde du compte de crédit après le renouvellement

Modèles

Requête 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 = ID du service (obligatoire)
• force = Forcer la suppression sans tenir compte des enregistrements A/AAAA du domaine (facultatif s’il existe un jeton pour réécrire les enregistrements DNS)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2274 = Erreur interne – paramètre user_id manquant
• 2292 = Domaine introuvable dans ce compte utilisateur
• 2400 = Erreur interne
• 2410 = Service introuvable
• 2411 = Jeton de réécriture des DNS indisponible
• 2412 = Échec de la requête API de réécriture des DNS
• 2413 = Échec de la requête, WGP n’a pas le droit de mettre à jour les DNS
• 2414 = WGP n’a pas de jeton et l’utilisateur n’a pas défini l’indicateur force dans WAPI

Données de la réponse

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

Modèles

Requête 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-delete-order

Utilisez la commande wgp-domain-delete pour supprimer une commande de domaine du service WEDOS Protection. Utile pour supprimer les services dont la création a échoué.

Cette requête ne supprime pas les services existants. Pour ceux-ci, utilisez wgp-domain-delete.

Paramètres

• domaine = nom de domaine (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2274 = Erreur interne – paramètre user_id manquant
• 2292 = Domaine introuvable dans ce compte utilisateur
• 2400 = Erreur interne
• 2410 = Service introuvable
• 2421 = Le service WGP existe, le domaine ne sera pas supprimé

Données de la réponse

• domaine = nom de domaine
• domain_id = ID du domaine
• wedos_client_id = ID du client

Modèles

Requête JSON :

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

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

Réponse JSON (Erreur – le service WEDOS Protection existe déjà) :

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

Utilisez la commande wgp-domain-update-subscription pour changer le forfait ou la période de facturation du service WEDOS Protection.

Paramètres

• service_id = ID du service (obligatoire)
• new_variant_id = forfait du service (obligatoire) – 1 = Start, 2 = Advanced, 3 = Expert
• new_period_id = période de facturation (obligatoire) – 1 = mensuelle, 4 = annuelle

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2101 = Paramètres incohérents
• 2203 = period_id invalide
• 2273 = Variante invalide
• 2293 = impossible de récupérer la valeur du crédit
• 2294 = impossible de récupérer le prix du service
• 2279 = compte de crédit bloqué
• 2281 = compte de crédit inactif
• 2282 = paiement impossible dans la devise du crédit
• 2283 = montant invalide ou crédit restant insuffisant
• 2284 = coordonnées du compte de crédit invalides
• 2285 = facturation de la TVA invalide
• 2286 = compte de crédit – code de réponse inconnu
• 2400 = Erreur interne WGP
• 2406 = Domaine/service introuvable
• 2408 = variant_id ou period_id manquant

Données de la réponse

• domaine = nom de domaine
• domain_id = ID du domaine
• wedos_client_id = ID du client
• service_id = ID du service
• service_type = type de service
• variant_id = ID du forfait du service
• period_id = ID de la période de facturation
• dirty = indicateur de mise à jour (0 = inchangé, 1 = modifié)

Modèles

Requête 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"
    }
  }
}

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-create-retry

Avec la commande wgp-domain-create-retry , vous relancez la demande d’émission du certificat. Vous pouvez l’utiliser pour résoudre l’état error_crt renvoyé par la commande wgp-domain-info .

Paramètres

• domaine = nom de domaine (obligatoire)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2292 = Domaine introuvable dans ce compte utilisateur
• 2400 = Erreur interne
• 4000 = Erreur interne

Données de la réponse

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

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-create-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-create-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 vider le cache du domaine WEDOS Protection.

Paramètres

• service_id = ID du service (obligatoire)
• service_type = Type de service (facultatif)
  • valeurs : hosting_wedos_protection (par défaut), hosting_domain
• limiter_decay = Durée de blocage en secondes (facultatif)
  • valeur par défaut 5
• limiter_reset = Annuler le limiteur (facultatif)
  • 0 (non, par défaut), 1 (oui)

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2101 = Paramètres incohérents
• 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 la réponse

• domaine = Nom de domaine
• domain_id = ID du domaine
• domain_tld = TLD du domaine
• service_id = ID du service
• wedos_client_id = ID du client
• limiter_available_in = Temps en secondes avant que la fonction soit de nouveau disponible

Modèles

Requête 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 commande wgp-domain-template-replicate pour modifier les paramètres du domaine cible selon le domaine modèle sélectionné.

Paramètres

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

Valeurs de retour

• 1000 = OK
• 2100 = Paramètre obligatoire manquant
• 2101 = Paramètres incohérents
• 2400 = Erreur interne WGP
• 2401 = Impossible d’appliquer le modèle au domaine
• 2402 = Domaine modèle invalide
• 2403 = Le domaine modèle ne correspond pas à l’utilisateur
• 2404 = Le domaine modèle ne correspond pas au forfait du domaine
• 2405 = Limite quotidienne de domaines modèles atteinte
• 2406 = Domaine/service introuvable
• 2407 = Domaine modèle introuvable
• 4000 = Erreur interne

Données de la réponse

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

Modèles

Requête 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 commande wgp-domain-templates-list pour récupérer la liste des domaines modèles du forfait WEDOS Protection sélectionné.

Paramètres

• variant_id = ID du forfait (obligatoire)
• per_page = Nombre d’enregistrements par page (par défaut = 15, tous les enregistrements = -1) (facultatif)
• page = Numéro de page (par défaut = 1) (facultatif)
• locale = Langue (par défaut = en, prises en charge = cs, en) (facultatif)
• recherche = Recherche sur les colonnes custom_name, name (facultatif)

Valeurs de retour

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

Données de la réponse

• data = Liste des domaines modèles
  • id = ID du domaine modèle
  • custom_name = Nom du domaine modèle (tel que défini par l’utilisateur)
  • name = Nom du domaine modèle (système)
  • url = URL du domaine modèle
• first_page_url = URL de la première page de la liste
• de = 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 = Tableau des liens de pagination
  • url = URL du lien
  • label = Libellé du bouton
  • active = null|1
• next_page_url = URL de la page suivante
• path = URL de la liste des domaines modèles
• per_page = Nombre d’entrées par page
• prev_page_url = URL de la page précédente
• à = Fin de la pagination
• total = Nombre total de pages

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-templates-list",
    "clTRID": "your ID",
    "data": {
      "variant_id": plan ID 1 = Free, 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
    }
  }
}

---

wgp-services-list

Avec la commande wgp-services-list , vous pouvez récupérer la liste des domaines disposant du service WEDOS Protection. Vous pouvez filtrer par état.

Paramètres

• statut = état du service (facultatif)

Valeurs de retour

• 1000 = OK
• 2206 = Requête invalide – erreur interne

Données de la réponse

• ID = ID de l’enregistrement de domaine
• name = nom de domaine
• statut = état du service
• expiration = Date d’expiration du service WG

Modèles

Requête 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"
    }
  }
}

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