WAPI - WEDOS DNS - WEDOS documentation & base de connaissances

Cet article traite des commandes WAPI propres au service WEDOS DNS. Pour savoir comment configurer WAPI et résoudre les problèmes courants, consultez l’article WAPI – Manuel.

Cet article présente les commandes suivantes :

dns-domains-list – liste des domaines DNS du compte utilisateur
dns-domain-info – informations sur le domaine
dns-domain-add – ajout d’un domaine au DNS
dns-domain-update – mise à jour d’un domaine dans le DNS
dns-domain-delete – suppression d’un domaine du DNS
dns-domain-axfr-run – demande de transfert AXFR depuis le serveur primaire vers notre DNS
dns-domain-axfr-tsig – mise à jour ou vérification des paramètres AXFR TSIG
dns-domain-copy – ajout d’un domaine au DNS par copie d’un autre domaine
dns-domain-commit – enregistrement des modifications DNS
dns-rows-list – récupération de la liste des enregistrements du domaine
dns-row-detail – récupération du détail d’un enregistrement
dns-row-add – ajout d’un enregistrement
dns-row-update – modification d’un enregistrement
dns-row-delete – suppression d’un enregistrement

dns-domains-list

Utilisez la commande dns-domains-list pour afficher la liste des domaines DNS de l’utilisateur.

Paramètres

recherche – chaîne à rechercher dans les noms de domaine – facultatif
statut – filtre par statut (active, disabled) – facultatif
type – filtre par type de domaine (primary, secondary) – facultatif
page – numéro de page (default: 1) – facultatif
page_limit – nombre d’entrées par page (default: 50) – facultatif
orderby – tri des entrées par created_date ou domain, suivi de asc/desc – facultatif, voir le modèle

Valeurs de retour

1000 – OK

Données de réponse

La commande renvoie la liste des domaines selon ce modèle :

domaine
- name – nom de domaine
- statut – statut du domaine dans le système
- type – type de domaine (primary/secondary)

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domains-list",
    "clTRID": "your ID",
    "data": { 
      "search": "search term in domain name",
      "status": "active|disabled",
      "type": "primary|secondary",
      "page": "page number",
      "page_limit": "number of entries per page",
      "orderby":"domain|created_date asc|desc"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domains-list",
    "data": {
      "domain": [
        {
          "name": "domain1 name in DNS",
          "type": "type (primary|secondary)",
          "status": "active|disabled"
        }
      ],
      "total": "nombre total d'éléments",
      "page": "numéro de page",
      "page_limit": "nombre d'éléments par page"
    }
  }
}

dns-domain-info

Utilisez la commande dns-domain-info pour obtenir les informations de base sur un ou plusieurs domaines du système WEDOS DNS (WDNS).

Paramètres

name – nom de domaine ; pour plusieurs domaines, utilisez une chaîne séparée par des virgules (voir le modèle) – obligatoire

Valeurs de retour

1000= OK
2201 = TLD non pris en charge
2202 = nom de domaine invalide
3222 = échec de l’ouverture du domaine
3223 = erreur d’autorisation
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Pour plusieurs domaines, la valeur de retour est toujours 1000. Les éventuelles valeurs d’erreur sont affichées dans les données domaine , comme le montre le modèle.

Données retournées

En cas de succès, la commande renvoie le détail du domaine dans WDNS, dans le nœud data/domain.

Modèles

Requête JSON avec 2 domaines :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-info",
    "clTRID": "your ID",
    "data": {
      "name": "domain.name1, domain.name2"
    }
  }
}

Réponse JSON (domain.name1 OK, domain.name2 erreur) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-info",
    "data": {
      "domain": [{
        "name": "domain.name1",
        "status": "",
        "type": "",
        "tlock": "",
        "autocommit": "",
        "axfr_enabled": "outgoing axfr enabled? (0/1)",
        "axfr_ips": "allowed axfr IPs list",
        "changed": "",
        "changed_date": "",
        "commit_date": "",
        "reload_pending": "",
        "reload_pending_date": "",
        "reload_date": "",
        "disabled_date": "",
        "enabled_date": "",
        "add_date": "",
        "rname": "",
        "serial": "",
        "refresh": "",
        "retry": "",
        "expire": "",
        "minimum": "",
        "rr_cnt6": "",
        "ns_out": "",
        "ns1": ""
      },
      {
        "name": "domain.name2",
        "code": 3222,
        "result": "Domain open failed"
      }]
    }
  }
}

dns-domain-add

Utilisez la commande dns-domain-add pour ajouter un nouveau domaine au DNS.

Paramètres

name – nom de domaine, ou plusieurs noms séparés par des virgules (obligatoire)
type – type d’enregistrement du domaine (primary/secondary) – facultatif (default: primary)
axfr_enabled – l’axfr sortant est-il activé ? (0/1) – domaines primary uniquement, facultatif (default: 0)
axfr_ips – liste des adresses ip autorisées pour l’axfr (uniquement pour une entrée primary ; saisissez plusieurs adresses séparées par des espaces ; obligatoire si axfr_enabled=1)
primary_ip – adresses ip du serveur dns primaire (obligatoire si type=secondary)
primary_tsig_enabled – TSIG est-il activé ? (0/1) – domaines secondary uniquement, facultatif
primary_tsig_name – identifiant TSIG – domaines secondary uniquement, obligatoire si TSIG est activé
primary_tsig_alg – algorithme TSIG – domaines secondary uniquement, obligatoire si TSIG est activé
primary_tsig_key – clé TSIG – domaines secondary uniquement, obligatoire si TSIG est activé
template_id – ID d’un domaine de type modèle – domaine primary uniquement, facultatif

Valeurs de retour

1000 = ok
2007 = taille maximale de la requête dépassée
2100 = paramètre obligatoire manquant
2101 = paramètres d’entrée invalides
2201 = TLD non pris en charge
2202 = nom de domaine invalide
2301 = format de type incorrect
2302 = paramètre primary_ip manquant
2303 = format incorrect de primary_ip
2304 = format invalide de axfr_enabled
2305 = paramètre obligatoire axfr_ips manquant
2306 = format invalide de axfr_ips
2308 = format invalide de ns
2322 = limite de domaines dans le DNS par utilisateur atteinte
2323 = modèle introuvable
2324 = impossible de créer un domaine primary via un modèle
2325 = modèle non défini
2330 = Requête invalide – domaine WDNS – TSIG primary – configuration invalide
2331 = Requête invalide – domaine WDNS – TSIG primary – format de nom invalide
2332 = Requête invalide – domaine WDNS – TSIG primary – format d'algorithme invalide
2333 = Requête invalide – domaine WDNS – TSIG primary – format de clé invalide
2340 = nombre max. de domaines par action dépassé
3302 = échec de l’ajout du domaine au DNS
3303 = le domaine existe déjà dans le DNS

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON – domaine primary :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-add",
    "clTRID": "your ID",
    "data": {
      "name": "domain1.tld, domain2.tld",
      "axfr_enabled": "0 or 1",
      "axfr_ips": "allowed AXFR address(es)",
      "template_id": "ID of domain records template"
    }
  }
}

Requête JSON – domaine secondary :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-add",
    "clTRID": "your ID",
    "data": {
      "name": "domain1.tld, domain2.tld",
      "type": "secondary",
      "primary_ip": "primary IP address",
      "primary_tsig_enabled": "0 or 1",
      "primary_tsig_name": "tsig_identifier",
      "primary_tsig_alg": "hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512 or hmac-md5",
      "primary_tsig_key": "TSIG_key_value"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-add"
  }
}

Réponse JSON pour plusieurs domaines :

{
  "response":{
    "code":1000,
    "result":"OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command":"dns-domain-add",
    "data": [
      {
        "code":1000,
        "result":"OK",
        "name":"domain1.tld",
        "domain_id":"service ID"
      },
      {
        "code":1000,
        "result":"OK",
        "name":"domain2.tld",
        "domain_id":"service ID"
      }
    ]
  }
}

dns-domain-update

Utilisez la commande dns-domain-update pour modifier le domaine dans le DNS.

Paramètres

name – nom de domaine, ou plusieurs noms séparés par des virgules (obligatoire)
axfr_enabled – l’axfr sortant est-il activé ? (0/1) – domaines primary uniquement, facultatif (default: 0)
axfr_ips – liste des adresses ip autorisées pour l’axfr (uniquement pour une entrée primary, obligatoire si axfr_enabled=1)
ip – adresse ip pour l’axfr sortant
primary_ip – adresses ip du serveur dns primaire (obligatoire si type=secondary)
primary_tsig_enabled – TSIG est-il activé ? (0/1) – domaines secondary uniquement, facultatif
primary_tsig_name – identifiant TSIG – domaines secondary uniquement, obligatoire si TSIG est activé
primary_tsig_alg – algorithme TSIG – domaines secondary uniquement, obligatoire si TSIG est activé
primary_tsig_key – clé TSIG – domaines secondary uniquement, obligatoire si TSIG est activé

Valeurs de retour

1000 = ok
2007 = taille maximale de la requête dépassée
2100 = paramètre obligatoire manquant
2101 = paramètres d’entrée invalides
2201 = TLD non pris en charge
2202 = nom de domaine invalide
2302 = paramètre primary_ip manquant
2303 = format incorrect de primary_ip
2304 = format invalide de axfr_enabled
2305 = paramètre obligatoire axfr_ips manquant
2306 = format invalide de axfr_ips
2308 = format invalide de ns
2322 = limite de domaines dans le DNS par utilisateur atteinte
2330 = Requête invalide – domaine WDNS – TSIG primary – configuration invalide
2331 = Requête invalide – domaine WDNS – TSIG primary – format de nom invalide
2332 = Requête invalide – domaine WDNS – TSIG primary – format d'algorithme invalide
2333 = Requête invalide – domaine WDNS – TSIG primary – format de clé invalide
2340 = nombre max. de domaines par action dépassé
3302 = échec de l’ajout du domaine au DNS
3303 = le domaine existe déjà dans le DNS

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-update",
    "clTRID": "your ID",
    "data": {
      "name": "domain1.tld, domain2.tld",
      "axfr_enabled": "0 or 1",
      "axfr_ips": "allowed AXFR IP address(es)",
      "primary_ip": "primary IP adderess",
      "primary_tsig_enabled": "0 or 1",
      "primary_tsig_name": "tsig_identifier",
      "primary_tsig_alg": "hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512 or hmac-md5",
      "primary_tsig_key": "TSIG_key_value"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-update"
  }
}

Réponse JSON pour plusieurs domaines (OK) :

{
  "response":{
    "code":1000,
    "result":"OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command":"dns-domain-update",
    "data": [
      {
        "code":1000,
        "result":"OK",
        "name":"domain1.tld",
      },
      {
        "code":1000,
        "result":"OK",
        "name":"domain2.tld",
      }
    ]
  }
}

dns-domain-delete

Utilisez la commande dns-domain-delete pour supprimer un domaine du DNS, y compris tous ses enregistrements.

Paramètres

name – nom de domaine, ou plusieurs noms séparés par des virgules (obligatoire)

Valeurs de retour

1000 = ok
2007 = taille maximale de la requête dépassée
2340 = nombre max. de domaines par action dépassé
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3301 = l’enregistrement ne peut pas être supprimé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-delete",
    "clTRID": "your ID",
    "data": {
      "name": "domain1.tld, domain2.tld"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",,
    "command": "dns-domain-delete"
  }
}

Réponse JSON pour plusieurs domaines (OK) :

{
  "response":{
    "code":1000,
    "result":"OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command":"dns-domain-delete",
    "data": [
      {
        "code":1000,
        "result":"OK",
        "name":"domain1.tld",
      },
      {
        "code":1000,
        "result":"OK",
        "name":"domain2.tld",
      }
    ]
  }
}

dns-domain-axfr-run

La commande dns-domain-axfr-run met à jour les enregistrements DNS depuis le serveur primaire faisant autorité via AXFR dès que possible (en quelques minutes). Elle s’utilise pour les domaines secondary, dont le contenu de la zone est téléchargé dans notre système depuis un autre serveur.

Sans cette commande, l’AXFR utilise les valeurs REFRESH et RETRY de l’enregistrement SOA.

Paramètres

name – nom de domaine – obligatoire

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2319 = possible pour le type de domaine secondary uniquement
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Données retournées

next_run – délai avant la prochaine mise à jour

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-axfr-run",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-axfr-run",
    "data": {
      "next_run": "date and time of next update"
    }
  }
}

dns-domain-axfr-tsig

La commande dns-domain-axfr-tsig sert à créer/mettre à jour, supprimer ou afficher les informations de clé AXFR TSIG pour un ou plusieurs domaines.

TSIG (Transaction Signature) est un mécanisme d’authentification des transferts DNS (AXFR/IXFR) qui assure la vérification d’identité entre le serveur primaire et le serveur secondaire. Cette vérification sera exigée pour tous les transferts vers les serveurs DNS secondaires et doit correspondre exactement à sa configuration.

Si le serveur primaire n’utilise pas TSIG, n’activez pas cette option : le transfert AXFR échouerait.

Paramètres

name – nom de domaine, ou plusieurs noms séparés par des virgules (obligatoire)
axfr_tsig_action – action AFXR TSIG – obligatoire
- create – activer ou mettre à jour l’AXFR TSIG
- cancel – désactiver l’AXFR TSIG
- info – afficher les informations AXFR TSIG

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2319 = possible pour le type de domaine secondary uniquement
2334 = AXFR TSIG non défini
2335 = AXFR TSIG non créé
2336 = AXFR TSIG non désactivé
2337 = commande AXFR TSIG invalide
2340 = nombre max. de domaines par action dépassé
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Données retournées

name = nom de domaine
axfr_tsig_action – nom de l’action AFXR TSIG
axfr_tsig_name – nom de la clé AXFR TSIG
axfr_tsig_alg – algorithme de la clé AXFR TSIG
axfr_tsig_key – valeur de la clé AXFR TSIG

Modèles

Requête JSON :

{
  "request":{
    "user": "your@login.tld",
    "auth": "authentication string",
    "command":"dns-domain-axfr-tsig",
    "clTRID": "your ID",
    "data":{
      "name":"domain1.tld, domain2.tld",
      "axfr_tsig_action":"create, cancel, or info"
    }
  }
}

Réponse JSON pour la commande create (plusieurs états de domaine) :

{
  "response":{
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command":"dns-domain-axfr-tsig",
    "data": [
      {
        "name":"domain1.tld",
        "code":1000,
        "result":"OK",
        "axfr_tsig_action":"create",
        "axfr_tsig_name":"keyname",
        "axfr_tsig_alg":"hmac-sha256",
        "axfr_tsig_key":"lbOYAMGHc6eSo3R2h6rWrHcsp3iSBp/0D0S7kjRqxLI="
      },
      {
        "name":"domain-swapi-00003y.cz",
        "code":3222,
        "result":"Domain open failed",
        "axfr_tsig_action":"create"
      }
    ]
  }
}

dns-domain-copy

Utilisez la commande dns-domain-copy pour ajouter un domaine au DNS en copiant les paramètres et les enregistrements d’un domaine existant.

Paramètres

name – nom du domaine d’origine (celui à copier) – obligatoire
name_new – nom du nouveau domaine créé – obligatoire

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom du domaine existant invalide ou non pris en charge
2320 = nom du nouveau domaine invalide ou non pris en charge
2321 = TLD du nouveau nom de domaine non pris en charge
2322 = limite du nombre de domaines dans le DNS par utilisateur atteinte
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé
3311 = échec de la copie
3312 = le nouveau domaine existe déjà dans le DNS

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-copy",
    "clTRID": "your ID",
    "data": {
      "name": "original domain name",
      "name_new": "new domain name"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-copy"
  }
}

dns-domain-commit

Utilisez la commande dns-domain-commit après toute modification du domaine ou de ses enregistrements DNS. Vous confirmez ainsi les modifications et demandez leur distribution vers les serveurs DNS.

Si vous n’exécutez pas la commande dns-domain-commit , le système l’exécute automatiquement 5 minutes après la dernière modification.

Paramètres

name – nom de domaine – obligatoire

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-commit",
    "clTRID": "your ID",
    "data": {
      "name": "domain name"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-domain-commit"
  }
}

dns-rows-list

Utilisez la commande dns-rows-list pour obtenir la liste des enregistrements du domaine dans le DNS avec les informations de base.

Pour obtenir des informations plus détaillées sur un enregistrement donné, utilisez la commande dns-row-detail .

Paramètres

domaine – nom de domaine – obligatoire

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2318 = impossible pour le type de domaine secondary
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé

Données de réponse

row – enregistrement
- ID – ID de l’enregistrement
- name – nom de l’enregistrement
- ttl – TTL de l’enregistrement
- rdtype – type de l’enregistrement
- rdata – données de l’enregistrement
- changed_date – date de modification
- author_comment – commentaire

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-rows-list",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-rows-list",
    "data": {
      "row1": {
        "ID": "record ID",
        "name": "record name (may be empty)",
        "ttl": "TTL",
        "rdtype": "record type",
        "rdata": "record data",
        "changed_date": "date and time of last update",
        "author_comment": "comment"
      }
    }
  }
}

dns-row-detail

La commande dns-row-detail renvoie des informations détaillées sur un enregistrement DNS donné d’un domaine.

Pour obtenir la liste complète des enregistrements d’un domaine, utilisez la commande dns-rows-list .

Paramètres

name – nom de domaine – obligatoire
row_id – ID de l’enregistrement – obligatoire, obtenu via dns-rows-list

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2318 = Cette action ne peut pas être effectuée sur le type de domaine secondary
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé
3309 = l’enregistrement DNS demandé n’existe pas pour ce domaine

Données retournées

row – enregistrement
- ID – ID de l’enregistrement
- name – nom de l’enregistrement
- ttl – TTL de l’enregistrement
- rdtype – type de l’enregistrement
- rdata – données de l’enregistrement
- changed_date – date de modification
- author_comment – commentaire

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-detail",
    "clTRID": "your ID",
    "data": {
      "name": "nom de domaine",
      "row_id": "ID de l'enregistrement"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-detail",
    "data": {
      "row1": {
        "ID": "record ID",
        "name": "record name (may be empty)",
        "ttl": "TTL",
        "rdtype": "record type",
        "rdata": "record data",
        "changed_date": "date and time of last update",
        "author_comment": "comment"
      }
    }
  }
}

dns-row-add

La commande dns-row-add ajoute un nouvel enregistrement DNS au domaine.

Par défaut, un domaine peut contenir jusqu’à 50 enregistrements DNS. S’il vous en faut davantage, contactez le support &boxbox;. Indiquez dans votre demande le nom de domaine, le nombre d’enregistrements souhaité et une justification détaillée.

Paramètres

domaine – nom de domaine – obligatoire
name – nom de l’enregistrement – obligatoire, mais peut être vide
ttl – valeur TTL – obligatoire
type – type d’enregistrement – obligatoire
rdata – données de l’enregistrement – obligatoire
author_comment – commentaire de l’auteur – facultatif. L’envoi d’une chaîne vide efface le commentaire précédent.

Valeurs de retour

1000 = ok
2100 = paramètre obligatoire absent
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2309 = type d’enregistrement invalide
2310 = impossible d’ajouter un enregistrement supplémentaire au domaine
2311 = nom invalide
2312 = nom invalide pour ce type d’enregistrement
2313 = CNAME invalide pour ce nom
2314 = données de l’enregistrement invalides
2315 = TLD invalide
2316 = cet enregistrement existe déjà
2317 = TTL invalide
2318 = action impossible sur le type de domaine secondary
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé
3307 = échec de l’ajout de l’enregistrement du domaine
5001 = erreur d’authentification interne

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-add",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "name": "record name (may be empty)",
      "ttl": "TTL",
      "type": "record type",
      "rdata": "record data"
    }
  }
}

Requête JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-add",
  }
}

dns-row-update

Utilisez la commande dns-row-update pour modifier un enregistrement DNS.

Vous ne pouvez pas modifier le nom ni le type d’un enregistrement. Dans ce cas, supprimez l’enregistrement d’origine puis créez-en un nouveau.

Paramètres

domaine – nom de domaine – obligatoire
row_id – ID de l’enregistrement – obligatoire, obtenu via dns-rows-list
ttl – valeur TTL – obligatoire
rdata – données de l’enregistrement – obligatoire
author_comment – commentaire de l’auteur – facultatif. L’envoi d’une chaîne vide efface le commentaire précédent.

Valeurs de retour

1000 = ok
2100 = paramètre obligatoire absent
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2309 = type d’enregistrement invalide
2310 = impossible d’ajouter un enregistrement supplémentaire au domaine
2311 = nom invalide
2312 = nom invalide pour ce type d’enregistrement
2313 = CNAME invalide pour ce nom
2314 = données de l’enregistrement invalides
2315 = TLD invalide
2316 = cet enregistrement existe déjà
2317 = TTL invalide
2318 = action impossible sur le type de domaine secondary
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé
3310 = échec de la mise à jour de l’enregistrement du domaine
5001 = erreur d’authentification interne

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Commande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-update",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "row_id": "row ID",
      "ttl": "TTL",
      "rdata": "record data"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-update"
  }
}

dns-row-delete

Utilisez la commande dns-row-delete pour supprimer un enregistrement DNS d’un domaine.

Paramètres

domaine – nom de domaine – obligatoire
row_id – ID de l’enregistrement – obligatoire, obtenu via dns-rows-list

Valeurs de retour

1000 = ok
2201 = TLD non pris en charge
2202 = nom de domaine invalide ou non pris en charge
2318 = action invalide pour le type de domaine secondary
3222 = l’ouverture du domaine a échoué
3223 = accès refusé
3305 = domaine verrouillé pour modification
3306 = domaine supprimé
3308 = la suppression de l’enregistrement a échoué
3309 = aucun enregistrement avec cet ID n’existe

Données retournées

La commande ne renvoie aucune donnée.

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-delete",
    "clTRID": "your ID",
    "data": {
      "domain": "domain name",
      "row_id": "record ID"
    }
  }
}

Requête JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "dns-row-delete",
  }
}

Cela vous a-t-il été utile ?

Merci pour votre retour !

WAPI – WEDOS DNS

dns-domains-list

Paramètres

Valeurs de retour

Données de réponse

Modèles

dns-domain-info

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-add

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-update

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-delete

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-axfr-run

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-axfr-tsig

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-copy

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-domain-commit

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-rows-list

Paramètres

Valeurs de retour

Données de réponse

Modèles

dns-row-detail

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-row-add

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-row-update

Paramètres

Valeurs de retour

Données retournées

Modèles

dns-row-delete

Paramètres

Valeurs de retour

Données retournées

Modèles

Cela vous a-t-il été utile ?

Sommaire de l’article

Parcourir les catégories