REST API – WEDOS.protection Services

GET /services

Renvoie la liste des services WEDOS Global Protection autonomes appartenant à l’utilisateur OAuth2 connecté (créés directement comme service WGP, table hosting_wedos_protection).

Paramètres :

• status – facultatif, query – filtre selon un état de service précis (la valeur n’est pas vérifiée par rapport à la liste de codes d’état)

Codes de retour :

• 1000 – OK

Données de la réponse : Un tableau de services ; chaque élément contient ID, name, status, expiration.

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services?status=active'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": [
    {
      "ID": 435,
      "name": "domain1.tld",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  ]
}

POST /services/{service_id}/cache/purge

Purge le cache CDN d’un domaine connecté à WGP. L’opération peut viser soit un service WGP autonome, soit un domaine dont WGP est un module complémentaire (hosting_domain) ; le type de service est défini par le paramètre service_type .

Paramètres :

• service_id – requis, path – ID local du service
• service_type – facultatif – type de service, hosting_wedos_protection (par défaut) ou hosting_domain
• limiter_decay – facultatif, nombre – durée en secondes pendant laquelle une purge répétée est limitée ; 5 par défaut
• limiter_reset – facultatif, booléen – annule la limite en cours ; par défaut false

Codes de retour :

• 1000 – OK
• 2100 – paramètre requis manquant
• 2101 – valeur de paramètre invalide
• 2406 – domaine ou service introuvable
• 2415 – le limiteur est toujours actif – la purge ne peut pas être répétée pour l’instant
• 3223 – le service appartient à un autre compte client
• 2400 – erreur interne – code de retour non enregistré

Données de la réponse :

• domain – nom de domaine
• domain_id – ID du domaine dans WGP
• domain_tld – TLD du domaine
• service_id – ID du service
• wedos_client_id – ID du client dans WGP
• limiter_available_in – dans combien de secondes la fonction pourra être réutilisée (documenté uniquement pour l’erreur 2415; l’implémentation actuelle ne renvoie toutefois pas la partie data en cas d’erreur, voir les Remarques)

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/cache/purge' \
  --data '{"limiter_decay":5,"limiter_reset":0}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "domain_tld": "tld",
    "service_id": 435,
    "wedos_client_id": 10234
  }
}

POST /services/{service_id}/renew

Renouvelle le service WGP pour une nouvelle période de facturation.

Paramètres :

• service_id – requis, path – ID du service

Codes de retour :

• 1000 – OK
• 2100 – paramètre requis manquant
• 2101 – valeur de paramètre invalide
• 2152 – le renouvellement n’est pas autorisé dans l’état actuel du service
• 2279 – le compte prépayé est bloqué
• 2281 – le compte prépayé n’est pas actif
• 2282 – impossible de payer depuis le compte prépayé dans la devise indiquée
• 2283 – solde insuffisant sur le compte prépayé
• 2284 – erreur dans les coordonnées du compte prépayé
• 2293 – impossible d’obtenir le solde du compte prépayé
• 2297 – impossible de déterminer si le compte prépayé inclut la TVA
• 2406 – service introuvable
• 2409 – le renouvellement du service a échoué

Données de la réponse :

• service_id – ID du service
• name – nom de domaine
• date_from, date_to – dates de validité de la nouvelle période
• fakt_order_num – numéro de commande du renouvellement
• currency – devise du compte prépayé
• price – montant du renouvellement
• credit – solde du compte prépayé après l’opération (null pour les services FREE/TRIAL)

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435/renew'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "service_id": 435,
    "name": "domain1.tld",
    "date_from": "2027-10-01",
    "date_to": "2028-10-01",
    "fakt_order_num": "2026123457",
    "currency": "CZK",
    "price": 499,
    "credit": 502
  }
}

POST /services/{service_id}/template-replicate

Réplique (applique) les réglages d’un domaine modèle sur un domaine ou service WGP existant.

Paramètres :

• service_id – requis, path – ID du service vers lequel les réglages sont répliqués
• template_domain_id – requis – ID du domaine modèle (voir GET /domains/templates)
• service_type – facultatif – type de service, hosting_wedos_protection (par défaut) ou hosting_domain

Codes de retour :

• 1000 – OK
• 2100 – paramètre requis manquant
• 2101 – valeur de paramètre invalide
• 2401 – domaine invalide pour la réplication
• 2402 – domaine modèle invalide
• 2403 – l’utilisateur du domaine et celui du domaine modèle ne concordent pas
• 2404 – la formule d’abonnement du domaine et celle du domaine modèle ne concordent pas
• 2405 – limite quotidienne de réplications atteinte
• 2406 – domaine ou service introuvable
• 2407 – domaine modèle introuvable
• 2400 – erreur interne – code de retour non enregistré

Données de la réponse :

• domain – 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 utilisé
• replications_count – nombre de réplications déjà effectuées
• replications_limit – nombre maximal de réplications autorisées

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/template-replicate' \
  --data '{"template_domain_id":123}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "template_domain_id": 123,
    "replications_count": 2,
    "replications_limit": 5
  }
}

PATCH /services/{service_id}

Modifie la variante et/ou la période d’abonnement d’un service WGP existant.

Paramètres :

• service_id – requis, path – ID du service
• new_variant_id – facultatif, nombre – nouvelle variante de service
• new_period_id – facultatif, nombre – nouvelle période d’abonnement

Au moins l’un des paramètres new_variant_id/new_period_id doit être indiqué.

Codes de retour :

• 1000 – OK
• 2100 – paramètre requis manquant
• 2101 – valeur de paramètre invalide
• 2203 – valeur invalide de new_period_id
• 2273 – valeur invalide de new_variant_id
• 2279 – le compte prépayé est bloqué
• 2281 – le compte prépayé n’est pas actif
• 2282 – impossible de payer depuis le compte prépayé dans la devise indiquée
• 2283 – solde insuffisant sur le compte prépayé
• 2284 – erreur dans les coordonnées du compte prépayé
• 2293 – impossible d’obtenir le solde du compte prépayé
• 2294 – impossible d’obtenir le prix du service
• 2406 – domaine ou service introuvable
• 2408 – le paramètre new_variant_id ou new_period_id est manquant (aucun des deux n’a été indiqué)
• 2400 – erreur interne – code de retour non enregistré

Données de la réponse :

• domain – nom de domaine
• domain_id – ID du domaine
• wedos_client_id – ID du client dans WGP
• service_id – ID du service
• service_type – type de service
• variant_id – ID de la variante de service en vigueur après la modification
• period_id – ID de la période d’abonnement en vigueur après la modification
• dirty – indicateur signalant si une modification a réellement eu lieu (0 = inchangé, 1 = modifié)

Exemple :

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435' \
  --data '{"new_variant_id":2,"new_period_id":1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "variant_id": 2,
    "period_id": 1,
    "dirty": 1
  }
}

DELETE /services/{service_id}

Supprime ou résilie un service WGP à la demande du client.

Paramètres :

• service_id – requis, path – ID du service
• force – facultatif, query, 0/1 – force la suppression même si WGP ne dispose d’aucun token pour réécrire le DNS (rétablissement des enregistrements A/AAAA à leurs valeurs d’origine)

Codes de retour :

• 1000 – OK
• 2100 – paramètre requis manquant
• 2292 – le domaine est introuvable dans WGP pour ce compte client
• 2400 – erreur interne
• 2410 – service introuvable
• 2411 – aucun token disponible pour réécrire le DNS
• 2412 – la requête API de réécriture du DNS a échoué
• 2413 – la commande ne peut pas être exécutée, WGP n’a pas le droit de manipuler le DNS du domaine (force=1 requis)
• 2414 – aucun token n’existe pour WGP et le paramètre force n’a pas été indiqué
• 3223 – le service appartient à un autre compte client

Données de la réponse :

• domain – nom de domaine
• domain_id – ID du domaine
• wedos_client_id – ID du client dans WGP
• service_id – ID du service
• service_type – type de service
• wdns_data – tableau des modifications d’enregistrements DNS effectuées (adresses IP qui cessent d’être résolues via WGP après sa résiliation)

Exemple :

curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435?force=1'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "wdns_data": []
  }
}