WAPI - WEDOS DNS

Cet article traite des commandes WAPI spécifiques au service DNS de WEDOS. Pour plus d'informations sur la configuration de WAPI et la résolution des problèmes courants, voir l'article WAPI - Manuel.

Cet article fournit des informations sur les demandes suivantes :

Liste des domaines DNS

Utilisez la requête dns-domains-list pour dresser la liste des domaines DNS de l'utilisateur.

Paramètres

  • search - chaîne de caractères à rechercher parmi les noms de domaine - facultatif
  • statut - filtre par statut (actif, désactivé) - optionnel
  • type - filtre par type de domaine (primaire, secondaire) - optionnel
  • page - numéro de page (par défaut : 1) - optionnel
  • page_limit - nombre d'entrées par page (par défaut : 50) - optionnel
  • orderby - ordonne les entrées par created_date ou domain, suivi par asc/desc - optionnel, voir modèle

Valeurs de retour

  • 1000 - OK

Données de réponse

La demande renvoie une liste de domaines utilisant ce modèle :

  • domaine
    • nom - nom de domaine
    • status - statut du domaine dans le système
    • type - type (primaire/secondaire)

Modèles

Demande 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": "počet položek celkem",
      "page": "číslo stránky",
      "page_limit": "počet položek na stránku"
    }
  }
}

dns-domain-info

Utilisez la requête dns-domain-info pour obtenir des informations de base sur le domaine dans le système DNS de WEDOS (WDNS).

Paramètres

  • name - nom de domaine - obligatoire

Valeurs de retour

  • 1000 = OK
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide
  • 3222 = échec de l'ouverture du domaine
  • 3223 = erreur d'autorisation
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de retour

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

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-info",
    "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-info",
    "data": {
      "domain": {
        "name": "domain name",
        "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": ""
      }
    }
  }
}

dns-domain-add

Utilisez la requête dns-domain-add pour ajouter un nouveau domaine au DNS.

Paramètres

  • name - nom de domaine - obligatoire
  • type - type d'enregistrement de domaine (primaire/secondaire) - facultatif (par défaut : primaire)
  • axfr_enabled - l'axfr sortant est-il activé ? (0/1) - domaines primaires uniquement - optionnel (défaut : 0)
  • axfr_ip - liste des adresses IP activées pour axfr (uniquement pour l'entrée principale, obligatoire si axfr_enabled=1)
  • ip - adresse IP pour l'axfr sortant
  • primary_ip - adresse IP du serveur DNS primaire (obligatoire si type=secondary)

Valeurs de retour

  • 1000 = ok
  • 2100 = paramètre requis manquant
  • 2101 = paramètres d'entrée non valides
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide
  • 2301 = format incorrect du type 
  • 2302 = paramètre primary_ip manquant
  • 2303 = mauvais format de primary_ip
  • 2304 = format non valide axfr_enabled
  • 2305 = paramètre requis manquant axfr_ips
  • 2306 = format non valide de axfr_ips
  • 2308 = format non valide de ns
  • 2322 = limite atteinte de domaines dans le DNS par utilisateur
  • 3302 = l'ajout d'un domaine au DNS a échoué
  • 3303 = le domaine existe déjà dans le DNS

Données de retour

La demande ne renvoie aucune donnée.

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-add",
    "clTRID": "your ID",
    "data": {
      "name": "domain name",
      "axfr_enabled": "0 or 1",
      "axfr_ips": {
        "ip1": "allowed AXFR address"
      }
    }
  }
}

Réponse JSON (OK) :

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

dns-domain-delete

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

Paramètres

  • name - nom de domaine - obligatoire

Valeurs de retour

  • 1000 = ok
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3301 = l'enregistrement ne peut pas être supprimé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de retour

La demande ne renvoie aucune donnée.

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-delete",
    "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-delete"
  }
}

dns-domain-axfr-run

La requête dns-domain-axfr-run met à jour les enregistrements DNS du serveur primaire faisant autorité via AXFR dès que possible (en quelques minutes). Elle est utilisée pour les domaines secondaires, pour lesquels nous téléchargeons le contenu de la zone sur notre système à partir d'un autre serveur.

Sans cette demande, AXFR utilise les données 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 = peut être fait pour le type de domaine secondaire seulement
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de retour

  • next_run - heure de la prochaine mise à jour

Modèles

Demande 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-copy

La commande dns-domain-copy permet d'ajouter un domaine au DNS en copiant les paramètres et les enregistrements d'un autre domaine existant.

Paramètres

  • name - nom du domaine original (celui que vous voulez copier) - obligatoire
  • name_new - nom du domaine nouvellement créé - obligatoire

Valeurs de retour

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

Données de retour

La demande ne renvoie aucune donnée.

Modèles

Demande 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-update-keyset

La requête dns-domain-update-keyset permet de modifier les paramètres KEYSET du domaine, c'est-à-dire d'activer, de désactiver ou de mettre à jour les paramètres DNSSEC.

Paramètres

  • name - nom de domaine - obligatoire
  • keyset - Paramètres du KEYSET - obligatoire
    0 = pas de KEYSET / DNSSEC désactivé
    1 = notre KEYSET / notre DNSSEC (si le domaine utilise nos serveurs DNS et est défini comme primaire)
    string = le nom de votre propre KEYSET (si le domaine n'utilise pas nos serveurs DNS ou est défini comme secondaire)

Valeurs de retour

  • 1000 = OK
  • 2202 = nom de domaine existant invalide ou non pris en charge
  • 2264 = nom de KEYSET non valide
  • 2265 = pas de support DNSSEC
  • 2266 = action non prise en charge pour le domaine secondaire
  • 2267 = action non prise en charge pour le domaine primaire
  • 3260 = l'ordre DNSSEC en attente existe déjà
  • 3258 = temps d'arrêt du registre en cours
  • 3263 = le domaine n'utilise pas notre DNS
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3259 = Le jeu de clés n'est pas disponible
  • 3262 = Échec de la configuration DNSSEC
  • 3264 = KEYSET est bloqué

Données de retour

La demande ne renvoie aucune donnée.

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-domain-update-keyset",
    "clTRID": "your ID",
    "data": {
      "name": "domain name",
      "keyset": "0/1/string",
    }
  }
}

Réponse JSON (OK) :

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

dns-domain-commit

Utilisez la requête dns-domain-commit après avoir apporté des modifications au domaine ou à ses enregistrements DNS. Vous confirmez les modifications et demandez leur distribution aux serveurs DNS.

Si vous n'exécutez pas la commande dns-domain-commit, le système l'exécutera 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 non valide ou non pris en charge
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de retour

La demande ne renvoie aucune donnée.

Modèles

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

liste des rangées de noms (dns-rows-list)

Utilisez la requête dns-rows-list pour obtenir une liste des enregistrements de domaine dans le DNS ainsi que des informations de base.

Pour obtenir des informations plus détaillées sur un enregistrement particulier, utilisez la requête dns-row-detail.

Paramètres

  • domain - nom de domaine - obligatoire

Valeurs de retour

  • 1000 = ok
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide ou non pris en charge
  • 2318 = ne peut pas être effectué au niveau du type de domaine secondaire
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de réponse

  • rangée - enregistrer
    • ID - ID de l'enregistrement
    • nom - nom de l'enregistrement
    • ttl - enregistrement TTL
    • rdtype - type d'enregistrement
    • rdata - données d'enregistrement
    • changed_date - date de modification
    • author_comment - commentaire

Modèles

Demande 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 requête dns-row-detail renvoie des informations détaillées sur un enregistrement DNS d'un domaine spécifique.

Pour obtenir une liste complète des enregistrements d'un domaine, utilisez la requête dns-rows-list.

Paramètres

  • name - nom de domaine - obligatoire
  • row_id - ID de l'enregistrement - obligatoire, extrait de dns-rows-list

Valeurs de retour

  • 1000 = ok
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide ou non pris en charge
  • 2318 = Cette action ne peut pas être effectuée sur le type de domaine secondaire
  • 3222 = l'ouverture du domaine a échoué
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé
  • 3309 = l'enregistrement DNS requis pour le domaine n'existe pas

Données de retour

  • rangée - enregistrer
    • ID - ID de l'enregistrement
    • nom - nom de l'enregistrement
    • ttl - enregistrement TTL
    • rdtype - type d'enregistrement
    • rdata - données d'enregistrement
    • changed_date - date de modification
    • author_comment - commentaire

Modèles

Demande JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "dns-row-detail",
    "clTRID": "your ID",
    "data": {
      "name": "název domény",
      "row_id": "ID záznamu"
    }
  }
}

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 requête dns-row-add ajoute un nouvel enregistrement DNS au domaine.

Paramètres

  • domain - 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 d'enregistrement - obligatoire
  • auth_comment - commentaire de l'auteur - optionnel

Valeurs de retour

  • 1000 = ok
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide ou non pris en charge
  • 2309 = type d'enregistrement non valide
  • 2310 = Impossible d'ajouter un autre enregistrement au domaine
  • 2311 = nom non valide
  • 2312 = nom non valide pour ce type d'enregistrement
  • 2313 = CNAME non valide pour ce nom
  • 2314 = données non valides de l'enregistrement
  • 2315 = TLD non valide
  • 2316 = cet enregistrement existe déjà
  • 2317 = TTL non valide
  • 2318 = l'action ne peut pas être effectuée sur le type de domaine secondaire
  • 3222 = l'ouverture du domaine a échoué
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé

Données de retour

La demande ne renvoie aucune donnée.

Modèles

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

Demande 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 requête dns-row-update pour modifier un enregistrement DNS.

Vous ne pouvez pas modifier le nom et le type d'un enregistrement. Dans ce cas, supprimez l'enregistrement original et créez-en un nouveau.

Paramètres

  • domain - nom de domaine - obligatoire
  • row_id - ID de l'enregistrement - obligatoire, extrait de dns-rows-list
  • ttl - Valeur TTL - obligatoire
  • rdata - données d'enregistrement - obligatoire

Valeurs de retour

  • 1000 = ok
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide ou non pris en charge
  • 2309 = type d'enregistrement non valide
  • 2310 = vous ne pouvez pas ajouter un autre enregistrement au domaine
  • 2311 = nom non valide
  • 2312 = nom non valide pour ce type d'enregistrement
  • 2313 = CNAME non valide pour ce titre
  • 2314 = enregistrement de données non valide
  • 2315 = TLD non valide
  • 2316 = cet enregistrement existe déjà
  • 2317 = TTL non valide
  • 2318 = l'action ne peut pas être effectuée sur le type de domaine secondaire
  • 3222 = échec de l'ouverture du domaine
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé
  • 3309 = l'enregistrement de cet ID n'existe pas
  • 3310 = la modification de l'enregistrement a échoué

Données de retour

La demande ne renvoie aucune donnée.

Modèles

JSON příkaz :

{
  "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 requête dns-row-delete pour supprimer un enregistrement DNS pour un domaine.

Paramètres

  • domain - nom de domaine - obligatoire
  • row_id - ID de l'enregistrement - obligatoire, extrait de dns-rows-list

Valeurs de retour

  • 1000 = ok
  • 2201 = TLD non pris en charge
  • 2202 = nom de domaine non valide ou non pris en charge
  • 2318 = action non valide pour le type de domaine secondaire
  • 3222 = l'ouverture du domaine a échoué
  • 3223 = accès refusé
  • 3305 = le domaine est verrouillé pour l'édition
  • 3306 = le domaine est supprimé
  • 3308 = la suppression de l'enregistrement a échoué
  • 3309 = l'enregistrement avec cet ID n'existe pas

Données de retour

La demande ne renvoie aucune donnée.

Modèles

Demande JSON :

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

Demande JSON (OK) :

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

Cela a-t-il été utile ?

Merci pour vos commentaires !
Sélecteurs génériques
Correspondance exacte uniquement
Recherche dans le titre
Recherche dans le contenu
Sélecteurs de type de message
Article TOC
Parcourir les catégories