REST API – Domaines

GET /domains

Renvoie la liste de tous les domaines du client connecté, éventuellement filtrée par statut. Le chemin équivalent GET /domains/list fait la même chose (aucun changement de comportement, simplement une autre forme d’URL).

Paramètres :

• status – facultatif, query, string – renvoie uniquement les domaines ayant le statut indiqué ; si le paramètre n’est pas précisé, les domaines de tous les statuts sont renvoyés

Codes de retour :

• 1000 – OK
• 2101 – format invalide du paramètre status
• 2242 – statut de domaine inconnu
• 5001 – personne n’est connecté

Données de réponse :

• domain – tableau des domaines du client ; chaque élément contient :
  • name – nom de domaine
  • status – statut du domaine

Exemple :

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

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active" },
      { "name": "domain2.tld", "status": "active" }
    ]
  }
}

GET /domains/{name}

Renvoie des informations détaillées sur un domaine à partir de son nom indiqué dans le chemin de l’URL.

Paramètres :

• name – obligatoire, path – nom de domaine

Codes de retour :

• 1000 – OK
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 3216 – erreur lors du chargement des informations du domaine
• 3222 – échec du chargement de l’objet domaine
• 3223 – le domaine se trouve dans un autre compte client
• 4205 – erreur de connexion au registre

Données de réponse :

• domain – objet contenant les informations du domaine :
  • name – nom de domaine
  • status – statut du domaine auprès du registre
  • reg_owner, reg_creator, reg_update – identifiants du bureau d’enregistrement (le nôtre / un autre)
  • setup_date, expiration, updated_date, transfer_date – dates d’enregistrement, d’expiration et de mise à jour
  • owner_c, admin_c, tech_c – identifiants des contacts associés (selon le registre)
  • dns.server – tableau des serveurs DNS configurés (name, addr_ipv4, addr_ipv6)
  • dnssec_keys – clés DNSSEC configurées (le cas échéant)
  • own_* (own_name, own_company, own_email, own_addr_street, …) – instantané des coordonnées du contact propriétaire au moment de la requête

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domena1.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d5",
  "data": {
    "domain": {
      "name": "domena1.tld",
      "status": "active",
      "reg_owner": "WEDOS",
      "setup_date": "2024-01-10",
      "expiration": "2027-01-10",
      "owner_c": "CONTACT-1",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      },
      "own_name": "Esmeralda Excavadora",
      "own_email": "esmeralda@wedos.com"
    }
  }
}

GET /domains/info

Fonctionnellement identique à GET /domains/{name}, mais permet de demander des informations sur plusieurs domaines à la fois (noms séparés par des virgules) via un paramètre de requête.

Paramètres :

• name – obligatoire, query, string – nom de domaine, ou plusieurs noms séparés par des virgules (sans espaces)

Codes de retour :

• 1000 – OK (pour les requêtes portant sur plusieurs domaines, l’API renvoie toujours ce code ; le résultat de chaque domaine se trouve dans son propre nœud, voir ci-dessous)
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 3216, 3222, 3223, 4205 – voir GET /domains/{name}

Données de réponse :

• Pour un seul domaine : domain – un objet ayant la même structure que GET /domains/{name}
• Pour plusieurs domaines : domain – un tableau d’objets, chacun contenant en plus code (le code de retour du traitement pour ce domaine) et result (sa description textuelle). Dans une requête groupée, l’état du traitement est suivi domaine par domaine, et non au niveau de la réponse entière.

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/info?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d6",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active", "expiration": "2027-01-10" },
      { "name": "domain2.tld", "code": 3223, "result": "Domain belongs to another account" }
    ]
  }
}

GET /domains/check

Vérifie si un ou plusieurs domaines sont disponibles à l’enregistrement (chez nous ou, de manière générale, selon la disponibilité auprès du registre).

Paramètres :

• name – obligatoire, query, string – nom de domaine, ou plusieurs noms séparés par des virgules

Codes de retour :

• 1000 – le domaine est disponible à l’enregistrement (pour les requêtes portant sur plusieurs domaines, l’API renvoie toujours ce code ; le résultat de chaque domaine se trouve dans son propre nœud, voir ci-dessous)
• 2100 – paramètre name manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 2250 – limite de vérifications dépassée (bloqué)
• 2251 – échec de la vérification de la limite
• 3201 – le domaine est déjà enregistré
• 3203 – le domaine n’est pas disponible
• 3204 – le domaine est en quarantaine
• 3205 – le domaine est réservé
• 3206 – le domaine est bloqué (la raison – premium, marque déposée, réservation ou nom court – est indiquée dans la description textuelle)
• 4201 – échec de la vérification – erreur de connexion au registre
• autres codes de statut spécifiques à la vérification de disponibilité

Données de réponse :

• Pour un seul domaine : name – le nom de domaine interrogé (le résultat de la vérification se trouve directement dans les champs de la réponse code/msg)
• Pour plusieurs domaines : un tableau d’objets, chacun avec name, code (le résultat de la vérification pour ce domaine) et result (sa description textuelle)

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/check?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d7",
  "data": [
    { "name": "domain1.tld", "code": 3201, "result": "Domain is already registered" },
    { "name": "domain2.tld", "code": 1000, "result": "OK" }
  ]
}

GET /domains/{name}/transfer/check

Vérifie si le domaine peut nous être transféré depuis un autre bureau d’enregistrement, sans qu’il soit nécessaire de connaître le code d’autorisation.

Paramètres :

• name – obligatoire, path – nom de domaine

Codes de retour :

• 1000 – le domaine est disponible pour le transfert
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 3207 – le domaine est déjà enregistré chez nous
• 3208 – transfert impossible, l’expiration est trop proche
• 3266 – transfert impossible, le domaine a expiré
• 4206 – erreur de connexion au registre

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domain1.tld/transfer/check'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d8"
}

GET /domains/tld-periods

Vérifie si un domaine sous le TLD indiqué peut être enregistré ou renouvelé pour le nombre d’années indiqué.

Paramètres :

• tld – obligatoire, query, string – TLD (sans le point, par ex. cz)
• period – obligatoire, query, integer – période demandée en années

Codes de retour :

• 1000 – OK, la période est valide pour ce TLD
• 2100 – paramètre d’entrée manquant
• 2101 – paramètres d’entrée invalides
• 2203 – la période n’est pas valide pour ce TLD

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/tld-periods?tld=eu&period=1'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d9"
}

POST /domains/create

Enregistre un nouveau domaine. Vous devez indiquer exactement un des paramètres dns ou nsset (pour définir le DNS/NSSET du domaine), jamais les deux.

Paramètres :

• name – obligatoire, string – nom du domaine à enregistrer
• period – obligatoire, integer – durée d’enregistrement en années
• owner_c – obligatoire, string – identifiant (handle) du contact propriétaire du domaine
• admin_c – facultatif, string – identifiant du contact administratif
• dns – facultatif, array – tableau de serveurs DNS sous la forme [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 sont facultatifs pour chaque serveur) ; mutuellement exclusif avec nsset
• nsset – facultatif, string – handle d’un NSSET existant à affecter au domaine (uniquement pour les registres qui prennent en charge les NSSETs, par ex. .cz) ; mutuellement exclusif avec dns
• rules – facultatif, array – confirmation de l’acceptation des règles d’enregistrement (requis uniquement pour les TLD qui l’exigent)

Codes de retour :

• 1000 – OK, domaine enregistré
• 1001 – requête acceptée, elle sera traitée de manière asynchrone
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 2203 – période invalide
• 2204 – paramètre owner_c manquant
• 2207 – format invalide de owner_c
• 2208 – format invalide de admin_c
• 2209 – erreur de syntaxe du NSSET
• 2210 – erreur de syntaxe du serveur DNS
• 2211 – trop de serveurs DNS
• 2245 – acceptation des conditions d’enregistrement non donnée
• 3001 – devise invalide
• 3002 – crédit insuffisant
• 3211 – contact owner_c indisponible
• 3212 – contact admin_c indisponible
• 3221 – échec de la création du domaine
• 4002 – échec du débit du crédit sur le compte
• autres codes d’erreur spécifiques à l’enregistrement de domaine

Données de réponse :

• num – numéro de commande
• expiration – date d’expiration du domaine
• credit – solde du crédit après paiement

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/create' \
  --data '{
    "name": "domain1.tld",
    "period": 1,
    "owner_c": "CONTACT-1",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e1",
  "data": {
    "num": "202610010001",
    "expiration": "2027-10-01",
    "credit": "1234.50"
  }
}

POST /domains/{name}/renew

Renouvelle l’enregistrement du domaine pour le nombre d’années indiqué. Ce n’est pas possible pour les domaines .eu – ils se renouvellent automatiquement.

Paramètres :

• name – obligatoire, path – nom de domaine
• period – obligatoire, integer – nombre d’années de renouvellement

Codes de retour :

• 1000 – OK
• 1001 – requête acceptée, elle sera traitée de manière asynchrone
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2203 – période invalide
• 2269 – une nouvelle période impayée existe déjà
• 3001 – devise invalide
• 3002 – crédit insuffisant
• 3222 – échec de l’ouverture du domaine
• 3223 – le domaine n’appartient pas à ce compte client
• 3224 – échec du renouvellement du domaine
• 3265 – le domaine ne peut pas être renouvelé maintenant – le nombre de jours avant l’expiration dépasse la limite autorisée
• 4208 – échec du renouvellement – erreur de connexion

Données de réponse :

• num – numéro de commande
• expiration – nouvelle date d’expiration du domaine
• credit – solde du crédit après paiement

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/renew' \
  --data '{"period": 1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e2",
  "data": {
    "num": "202610010002",
    "expiration": "2028-10-01",
    "credit": "1134.50"
  }
}

POST /domains/{name}/transfer

Transfère vers nous un domaine depuis un autre bureau d’enregistrement. Le paramètre dns fonctionne comme suit : s’il n’est pas inclus du tout dans la requête, la configuration actuelle des serveurs DNS du domaine est reprise automatiquement ; false ou un tableau vide définit les serveurs WEDOS par défaut ; un tableau d’objets définit des serveurs précis.

Paramètres :

• name – obligatoire, path – nom de domaine
• auth_info – obligatoire, string – code d’autorisation du domaine (code de transfert)
• owner_c – facultatif, string – identifiant du contact propriétaire (requis uniquement pour les TLD dont le registre l’exige)
• dns – facultatif, array – tableau de serveurs DNS sous la même forme que dans POST /domains/create
• rules – facultatif, array – confirmation de l’acceptation des règles (uniquement pour les TLD qui l’exigent)

Codes de retour :

• 1000 – transfert effectué avec succès
• 1001 – requête acceptée, elle sera exécutée de manière asynchrone
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 2204 – identifiant du contact propriétaire manquant
• 2207 – identifiant du contact propriétaire invalide
• 2210 – format de serveur DNS invalide
• 2215 – auth_info manquant, alors qu’il est obligatoire pour ce TLD
• 3001 – devise invalide
• 3207 – le domaine est déjà enregistré chez nous
• 3208 – transfert impossible, l’expiration est trop proche
• 3219 – une demande de transfert est déjà en attente pour ce domaine
• 3220 – le domaine figure déjà dans nos enregistrements
• 3226 – échec du transfert du domaine
• 3227 – erreur d’autorisation auprès du registre de domaines
• 3266 – transfert impossible, le domaine a expiré
• autres codes d’erreur spécifiques au transfert de domaine

Données de réponse :

• num – numéro de commande
• expiration – date d’expiration du domaine
• credit – solde du crédit après paiement

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/transfer' \
  --data '{"auth_info": "AUTHCODE123", "owner_c": "CONTACT-1"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e3",
  "data": {
    "num": "202610010003",
    "expiration": "2027-10-01",
    "credit": "1134.50"
  }
}

POST /domains/{name}/auth-info/send

Envoie le code d’autorisation du domaine (code de transfert) à l’adresse e-mail du contact propriétaire du domaine.

Paramètres :

• name – obligatoire, path – nom de domaine

Codes de retour :

• 1000 – OK, code d’autorisation envoyé à l’adresse e-mail du propriétaire du domaine
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• 2243 – l’envoi du code d’autorisation n’est pas autorisé pour ce domaine
• 3209 – échec de l’envoi du code d’autorisation
• 3210 – échec de l’envoi – le domaine est indisponible
• 3222 – échec du chargement du domaine
• 3223 – le domaine n’appartient pas à ce compte client
• 4214 – échec de l’envoi – erreur de connexion

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domain1.cz/auth-info/send'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e4"
}

PATCH /domains/{name}/nsset/update

Définit de nouveaux serveurs DNS pour le domaine, ou le relie à un NSSET existant. Vous devez indiquer exactement un des paramètres dns ou nsset, jamais les deux.

Paramètres :

• name – obligatoire, path – nom de domaine
• dns – facultatif, array – tableau de serveurs DNS sous la même forme que dans POST /domains/create ; mutuellement exclusif avec nsset
• nsset – facultatif, string – handle d’un NSSET existant ; mutuellement exclusif avec dns

Codes de retour :

• 1000 – OK
• 1001 – OK, exécuté de manière asynchrone
• 2100 – paramètre obligatoire manquant (ni dns ni nsset n’est indiqué)
• 2101 – paramètres invalides (à la fois dns et nsset sont indiqués, ou format invalide)
• 2201 – TLD non pris en charge
• 2202 – nom de domaine invalide
• 2209 – erreur de syntaxe du NSSET
• 2210 – erreur de syntaxe du serveur DNS
• 2211 – trop de serveurs DNS
• 3214 – NSSET indisponible
• 3222 – échec de l’ouverture du domaine
• 3223 – le domaine appartient à un autre compte client
• 3225 – échec de la mise à jour DNS/NSSET
• 3315 – des serveurs NS identiques sont déjà définis pour le domaine
• 4204 – erreur de connexion (NSSET)
• 4210 – erreur de connexion (DNS)

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/nsset/update' \
  --data '{
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e5"
}

PATCH /domains/{name}/keyset/update

Définit, désactive ou bascule le DNSSEC du domaine.

Paramètres :

• name – obligatoire, path – nom de domaine
• keyset – obligatoire – configuration DNSSEC :
  • 0 – DNSSEC désactivé
  • 1 – DNSSEC géré par WEDOS
  • toute autre chaîne – handle du KEYSET propre au client

Codes de retour :

• 1000 – OK
• 2100 – paramètre obligatoire manquant
• 2101 – format de paramètre invalide
• 2201 – TLD non pris en charge
• 2202 – format de nom de domaine invalide
• autres codes d’erreur spécifiques à la configuration DNSSEC

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/keyset/update' \
  --data '{"keyset": 1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e6"
}