Would you like Dynadot in English ?YES

API de Domaine Avancée

Advanced Domain API from Dynadot - Manage Domains with Your Own Software

Vous cherchez d'autres fonctionnalités pour notre API de Domaines ? Consultez notre API de Domaines Avancée. Cette version de notre API vous permet d'utiliser votre propre logiciel et vos propres serveurs pour effectuer plus de 50 commandes - créer des dossiers, paramétrer le Whois, la confidentialité, la redirection de domaine, et bien plus ! Notre API de Domaines Avancée est disponible pour tous les comptes, alors commencez aujourd'hui en suivant les instructions ci-dessous.

Vous cherchez un moyen simple d'utiliser notre API ? Consultez notre page API de Domaines !

Bien Débuter Avec Notre API de Domaine Avancée

Requests to our Advanced Domain API are sent to the following URL:

https://api.dynadot.com/api3.xml

Notez que les requêtes doivent être envoyées en https (socket sécurisée) pour la sécurité. 1 seule requête peut être traitée à la fois, veuillez donc attendre que la requête en cours soit terminée avant d'en envoyer une autre. La requête doit contenir les paramètres suivants :

Request Parameter
Explication
KeyVotre clé pour accéder à l'API, disponible dans le tableau de bord de votre compte
Commandsearch, register, delete, renew, push, transfer, bulk_register

domain_info, set_whois, set_ns, set_parking, set_forwarding, set_stealth, set_hosting, set_dns, set_dns2, set_email_forward, set_clear_domain_setting, set_folder, set_note, set_renew_option, set_privacy, tld_price, list_domain

create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns

get_listings, get_listing_item, buy_it_now

account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option

create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list

add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

is_processing

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_order_status

Our Advanced Domain API will return results in an XML format. The response you receive should contain 2 or 3 of the following fields:

Balise XML de résultat
Explication
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
 

Commande Search (Chercher)

Si la commande search est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Search
Explication
domain0 - domain99Le nom de domaine que vous cherchez, les comptes normaux peuvent spécifier un domaine par commande, les comptes bulk et super bulk peuvent spécifier jusqu'à 100 domaines.
language0 - language99 (facultatif)Le tag de lagage pour le domaine respectif, à n'utiliser que pour les IDNs
show_price (facultatif)Si vous voulez afficher le prix dans votre devise de compte, paramétrez-le égal à "1".
currency (facultatif)Vous pouvez décider du type de devise, les options sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous n'avez pas configuré ce paramètre, nous utiliserons la devise par défaut du compte
Balise XML de résultat
Explication
<Results></Results>Le nœud racine de la réponse XML à la commande de recherche
<SearchResponse></SearchResponse>Balise de réponse à la commande search
<SearchHeader></SearchHeader>Balise de l'entête de recherche
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<DomainName></DomainName>Le nom de domaine que vous venez de rechercher
<Available></Available>Si le nom de domaine est disponible
<Price></Price>Si vous positionnez "show_price" à "1", cela vous donnera les infos de prix si le domaine est disponible.
<Language></Language>Information de langage pour le nom de domaine

Exemple de Recherche

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD

Response (XML format)
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD

Response (JSON format)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

Commande Register (Enregistrer)

Appeler la commande register créera une commande d'enregistrement qui sera traitée. Vous devez avoir un montant suffisant sur votre compte pour pouvoir payer la commande. Lors d'un appel à la commande register, les paramètres suivants doivent être inclus :

Paramètres de Requête Register
Explication
domainLe nom de domaine que vous voulez enregistrer, seul 1 domaine peut être enregistré par requête
language (facultatif)Le tag de langage pour le domaine en question, à utiliser seulement si le domaine est un IDN
durationEnregistrer le domaine pour combien de temps
registrant_contact (facultatif)The registrant contact you want to use on the domain
admin_contact (facultatif)The admin contact you want to use on the domain
technical_contact (facultatif)The technical contact you want to use on the domain
billing_contact (facultatif)The billing contact you want to use on the domain
option0 (si nécessaire)
Le nom de déclarant (titulaire) de .AT, .BE,
option1 (si nécessaire)The .AT, .BE, registrant organization (optional)
Pour .AT, vous pouvez spécifier soit option0, option1, soit les deux
premium (facultatif)Si vous voulez enregistrer un domaine premium, mettez-le à "1" (facultatif)
currency (facultatif)Vous pouvez décider du type de devise, les options sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous n'avez pas configuré ce paramètre, nous utiliserons la devise par défaut du compte
coupon (facultatif)Le code promo que vous voulez appliquer à cette commande
Balise XML de résultat
Explication
<RegisterResponse></RegisterResponse>Balise de la réponse de registre
<RegisterHeader></RegisterHeader>Balise de l'entête de registre
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<RegisterContent></RegisterContent>La balise du contenu de registre
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC), seulement utilisé quand le résultat est "success"
<Registration></Registration>Date d'enregistrement en temps Unix (millisecondes depuis minuit UTC de janvier 1, 1970), seulement utilisé quand le résultat est "success".

Exemple d'Enregistrement

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Response (XML format)
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Response (JSON format)
{
   "RegisterResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.net",
      "Expiration":"1458379145266"
   }
}
 

Commande Delete (Supprimer)

Appeler la commande de suppression supprimera un domaine qui est encore dans le délai de grâce. Votre solde de compte sera crédité du montant de l'enregistrement. Les domaines qui ont été renouvelés, ou qui ont été déplacés vers un nouveau compte, ne peuvent pas être supprimés avec l'API. Si vous appelez la commande de suppression, les paramètres suivants doivent être inclus :

Paramètres de Requête Delete
Explication
domainLe nom de domaine que vous voulez supprimer, seul 1 domaine peut être supprimé par requête
Balise XML de résultat
Explication
<DeleteResponse></DeleteResponse>Balise de la réponse à la commande delete
<DeleteHeader></DeleteHeader>Balise de l'entête de suppression
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Suppression

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete&domain=domain1.com

Response (XML format)
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete&domain=domain1.com

Response (JSON format)
{
   "DeleteResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
   }
}
 

Commande Renew (Renouveler)

Appeler la commande de renouvellement créera et traitera une commande de renouvellement. Vous devez avoir suffisamment de solde de compte pour payer la commande. Quand la commande de renouvellement est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Renew
Explication
domainLe nom de domaine que vous voulez renouveler, 1 seul domaine peut être renouvelé par requête
durationRenouveler le domaine pour combien d'années
year (facultatif)L'année actuelle d'expiration du domaine
currency (facultatif)Vous pouvez décider du type de devise, les options sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous n'avez pas configuré ce paramètre, nous utiliserons la devise par défaut du compte
price_check (facultatif)Vous pouvez ajouter ce paramètre à la commande pour vérifier les informations de tarifs pour renouveler ce domaine. NOTE : En ajoutant ce paramètre à la commande, notre API ne renouvèlera pas le domaine, mais affichera seulement les tarifs.
coupon (facultatif)Le code promo que vous voulez appliquer à cette commande
no_renew_if_late_renew_fee_needed (facultatif)You can add this parameter to the command to avoid the renewal if the domain requires late renewal fee. If domain does requires late renew fee to renew, and "no_renew_if_late_renew_fee_needed = 1" was passed in command, domain will not be renewed.
Balise XML de résultat
Explication
<RenewResponse></RenewResponse>Balise de réponse de renouvellement, c'est le nœud racine du document XML de réponse
<RenewHeader></RenewHeader>Entête du Renouvellement
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<PriceInfo></PriceInfo>Tag d'info de prix, utilisé seulement quand le statut est "price_check_success"
<RenewContent></RenewContent>Balise du contenu de renouvellement, seulement utilisée quand le statut est "success"
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC), seulement utilisé quand le résultat est "success"

Exemple de Renouvellement

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (XML format)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (JSON format)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domian1.com",
      "Expiration":"73984579834"
   }
}
 

Push Command

La commande push permet de créer et de traiter une commande de push de domaine. Vous devez déverrouiller votre domaine et tenir compte de la commande de push de domaine. Le compte récepteur doit rejeter/accepter le domaine pour finaliser la commande de push de domaine. Si vous appelez la commande push, les paramètres suivants doivent être inclus :

Paramètre de Requête Push
Explication
domainLe nom du domaine que vous voulez transférer (push). Nous supportons également le "push groupé", vous pouvez utiliser ";" pour séparer les domaines. Exemple : domaine1.com;domaine2.com
receiver_push_usernamePush Username of receiver account
currency (facultatif)Vous pouvez décider du type de devise, les options sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous n'avez pas configuré ce paramètre, nous utiliserons la devise par défaut du compte
unlock_domain_for_push(optional)Positionnez ce paramètre à "1". Si le domaine est verrouillé, nous le déverrouillerons automatiquement, pour que vous n'ayez pas à le faire manuellement
Balise XML de résultat
Explication
<PushResponse></PushResponse>Balise de réponse de push, c'est le nœud racine du document XML de réponse
<PushHeader></PushHeader>Entête de Push
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Push

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (XML format)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (JSON format)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Commande Transfer

Appeler la commande de transfert créera et traitera une commande de transfert. Certains TLD peuvent nécessiter la confirmation du régistraire pour finaliser la commande. En cas d'appel de la commande de transfert, les paramètres suivants doivent être inclus :

Paramètre de Demande de Transfert
Explication
domainLe nom de domaine que vous voulez transférer vers Dynadot, seul 1 domaine peut être transféré par requête
authLe code d'autorisation pour la demande de transfert.
currency (facultatif)Vous pouvez décider du type de devise, les options sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous n'avez pas configuré ce paramètre, nous utiliserons la devise par défaut du compte
registrant_contact (facultatif)Le contact de déclarant (titulaire) que vous voulez utiliser quand le transfert est terminé. (Certains TLD ne gèrent pas cette fonctionnalité)
admin_contact (facultatif)Le contact admin que vous voulez utiliser quand le transfert est terminé. (Certains TLD ne gèrent pas cette fonctionnalité)
technical_contact (facultatif)Le contact technique que vous voulez utiliser quand le transfert est terminé. (Certains TLD ne gèrent pas cette fonctionnalité)
billing_contact (facultatif)Le contact de facturation que vous voulez utiliser quand le transfert est terminé. (Certains TLD ne gèrent pas cette fonctionnalité)
coupon (facultatif)Le code promo que vous voulez appliquer à cette commande
Balise XML de résultat
Explication
<TransferResponse></TransferResponse>Tag de réponse de transfert, c'est le noeud racine du document de réponse XML
<TransferHeader></TransferHeader>Entête de Transfert
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Transfert

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (XML format)
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </TransferHeader>
</TransferResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (JSON format)
{
   "TransferResponse":{
      "ResponseCode":"0",
      "Status":"order created",
      "DomainName":"domian1.com"
   }
}
 

Bulk Register Command

Calling the bulk register command will create and process registration orders. You must have enough account balance to pay for the orders. If calling the bulk register command, the following parameters should be included:

Bulk Register Request Parameter
Explication
domain0-domain99The domain name(s) you want to register, maximum 100 domains can be registered per request
premium (facultatif)Si vous voulez enregistrer un domaine premium, mettez-le à "1" (facultatif)
currency (facultatif)You can decide the currency type and this parameter supported are "USD","CNY", "GBP","EUR","INR","CAD" and so on. If you missed this parameter,we will use the account default currency
coupon (facultatif)Le code promo que vous voulez appliquer à cette commande
Balise XML de résultat
Explication
<BulkRegisterResponse></BulkRegisterResponse>Tag of bulk register response
<BulkRegisterHeader></BulkRegisterHeader>Tag of bulk register header
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<BulkRegisterContent></BulkRegisterContent>The tag of bulk register content
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC), seulement utilisé quand le résultat est "success"
<Result></Result>The result of the register action
<Message></Message>Error message of register action, only used when result is "error"

Bulk Register Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (JSON format)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

Commande Domain Info (Informations de Domaine)

This command is only available in XML and JSON format:

Paramètre de Requête Domain Info
Explication
domainSeulement 1 domaine autorisé par requête
Balise XML de résultat
Explication
<DomainInfoResponse></DomainInfoResponse>Nœud racine du document XML de réponse
<DomainInfoResponseHeader></DomainInfoResponseHeader>Entête de réponse
<ResponseCode></ResponseCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<DomainInfoContent></DomainInfoContent>Contenu de la réponse
<Domain></Domain>Domaine
<Name></Name>Nom du domaine
<Expiration></Expiration>Date d'expiration de domaine en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<Registration></Registration>Date d'enregistrement de domaine en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<NameServerSettings></NameServerSettings>Paramètres du serveur de noms du domaine
<Type></Type>Type du serveur de noms du domaine
<WithAds></WithAds>Si vous voulez une page de parking pour votre domaine
<Whois></Whois>Informations de Whois
<Registrant></Registrant>Informations du Titulaire
<ContactId></ContactId>Identifiant de contact
<Admin></Admin>Informations d'administrateur
<Technical></Technical>Informations techniques
<Billing></Billing>Informations de Facturation
<Locked></Locked>Verrouillé ou non
<Disabled></Disabled>Statut d'activation
<UdrpLocked></UdrpLocked>Udrp verrouillé ou non
<UdrpLocked></UdrpLocked>Udrp verrouillé ou non
<RegistrantUnverified></RegistrantUnverified>Titulaire non vérifié
<Hold></Hold>En attente
<Privacy></Privacy>Statut de confidentialité
<isForSale></isForSale>Statut de vente
<RenewOption></RenewOption>Option de renouvellement
<Note></Note>Note
<Folder></Folder>Informations de dossier
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom de dossier

Exemple d'Information de Domaine

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=domain_info&domain=domain1.com

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>Yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=domain_info&domain=domain1.com

Response (JSON format)
{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      }
    }
  }
}
 

Commande Set Whois (Définir le Whois)

Si la commande set Whois est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Whois
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations d'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
Balise XML de résultat
Explication
<SetWhoisResponse></SetWhoisResponse>Nœud racine du document XML de réponse
<SetWhoisHeader></SetWhoisHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Whois

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Name Servers (Définir les Serveurs de Noms)

Si la commande set name servers est appelée, les paramètres suivants doivent être inclus :

Paramètres de Requête Get Name Servers
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
ns0 - ns12Les serveurs de noms pour votre domaine, vous pouvez spécifier jusqu'à 13 serveurs de noms, mais ils doivent déjà exister dans votre compte
Balise XML de résultat
Explication
<SetNsResponse></SetNsResponse>Balise de la réponse à set name servers, c'est le nœud racine du document de réponse XML
<SetNsHeader></SetNsHeader>Balise de l'entête de réponse à set name server
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Set Name Server

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response (XML format)
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response (JSON format)
{
   "SetNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Parking

Si la commande set parking est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Parking
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
with_ads (facultatif)Si vous ne voulez pas de publicités de tierce partie, vous pouvez utiliser ce paramètre avec "no"
Balise XML de résultat
Explication
<SetParkingResponse></SetParkingResponse>Balise de la réponse à set parking, c'est le nœud racine du document de réponse XML
<SetParkingHeader></SetParkingHeader>Entête de set parking
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Parking

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_parking&domain=domain1.com&with_ads=no

Response (XML format)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_parking&domain=domain1.com&with_ads=no

Response (JSON format)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Forwarding (Définir la Redirection)

Si la commande set forwarding est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Forwarding
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
forward_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
is_temp (facultatif)Statut de redirection de votre domaine, la valeur par défaut est "temporary", si vous voulez le rediriger de façon permanente, utilisez ce paramètre avec "no"
Balise XML de résultat
Explication
<SetForwardingResponse></SetForwardingResponse>Nœud racine du document XML de réponse
<SetForwardingHeader></SetForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Forwarding

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Response (XML format)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Response (JSON format)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Stealth (Définir l'Invisibilité - pour la redirection)

Si la commande set stealth est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Stealth
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
stealth_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
stealth_title (facultatif)Le titre de la page
Balise XML de résultat
Explication
<SetStealthResponse></SetStealthResponse>Nœud racine du document XML de réponse
<SetStealthHeader></SetStealthHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Stealth

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (XML format)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (JSON format)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Hosting (Définir l'Hébergement)

Si la commande set hosting est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Hosting
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
hosting_typeType d'hébergement que vous voulez, vous pouvez choisir entre "advanced" et "basic"
mobile_view_onVous pouvez utiliser ce paramètre à "yes" seulement quand hosting_type est "advanced",
Balise XML de résultat
Explication
<SetHostingResponse></SetHostingResponse>Nœud racine du document XML de réponse
<SetHostingHeader></SetHostingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Hosting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Response (XML format)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Response (JSON format)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set DNS (Définir le DNS)

Si la commande set DNS est appelée, les paramètres suivants doivent être inclus :

(Cette commande est obsolète et non recommandée, veuillez plutôt utiliser la commande Set DNS2)

Paramètre de Requête Set DNS
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
main_record_typeType de l'enregistrement principal
main_recordSpécifiez un enregistrement DNS pour votre domaine
main_txt1 - main_txt4 (facultatif)Spécifiez les enregistrements TXT pour votre domaine. Si votre main_record_type est aaaa et que vous avez spécifié un main_record2, vous pouvez paramétrer jusqu'à 3 main_txts, sinon vous pouvez paramétrer jusqu'à 4 main_txts.
main_record2Enregistrement principal 2, seulement utilisé quand "main_record_type" est "aaaa". Sa valeur doit être au format ipv4.
subdomain0 - subdomain99 (facultatif)Subdomain records (facultatif)
sub_record_type0 - sub_record_type99 (facultatif)Type d'enregistrement de sous-domaine
sub_record0 - sub_record99 (facultatif)Adresse IP ou hôte cible
mx_host0 - mx_host4 (facultatif)Spécifiez l'hôte de mail pour votre domaine, distance0 est la plus haute priorité
mx_distance0 - mx_distance4 (facultatif)Distance0 est la plus haute priorité
ttl (facultatif)Durée de vie
add_dns_to_current_setting (facultatif)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Balise XML de résultat
Explication
<SetDnsResponse></SetDnsResponse>Nœud racine du document XML de réponse
<SetDnsHeader></SetDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set DNS

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)
{
  "SetDnsResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Commande Set DNS2

Si la commande set DNS2 est appelée, les paramètres suivants sont requis :

Veuillez noter qu'appeler la commande set DNS2 écrasera les paramètres DNS actuels.

Paramètres de Requête Set DNS2
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
main_record_type0 - main_record_type19Le type des enregistrement principaux doit être "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance Mx, type de redirection (301 pour "1", 302 pour "2"), titre ou alias e-mail de redirection masquée, nécessaire quand main_record_type est égal à "forward","mx","stealth","email".
subdomain0 - subdomain99 (facultatif)Subdomain records (facultatif)
sub_record_type0 - sub_record_type99Le type d'enregistrement de sous-domaine doit être "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99Adresse IP de sous-domaine ou hôte cible
sub_recordx0 - sub_recordx99Distance Mx, type de redirection, titre de redirection masquée ou alias d'e-mail nécessaires quand main_record_type est "forward","mx","stealth","email"
ttl (facultatif)Durée de vie
add_dns_to_current_setting (facultatif)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Balise XML de résultat
Explication
<SetDnsResponse></SetDnsResponse>Nœud racine du document XML de réponse
<SetDnsHeader></SetDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Set DNS2

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (JSON format)
{
  "SetDnsResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Commande Set Email Forward (Définir le transfert d'e-mail)

Si la commande set email forward est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Email Forward
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
forward_typeType de transfert, cela peut être "donot": Ne pas transférer l'e-mail, "mx": Envoyer l'e-mail à un autre hôte mail ( enregistrement MX), "forward": Envoyer l'e-mail à un autre hôte mail
username0 - username9Nom d'utilisateur, utilisé seulement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse mail existante, utilisée seulement quand "forward_type" est "forward"
mx_host0 - mx_host2Hôte mail, utilisé seulement quand "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la plus haute priorité, utilisé seulement quand "forward_type" est "mx"
Balise XML de résultat
Explication
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nœud racine du document XML de réponse
<SetEmailForwardingHeader></SetEmailForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Email Forward

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Clear Domain Setting (Supprimer un service du domaine)

Si la commande set clear domain setting est appelée, les paramètres suivants doivent être inclus :

Paramètre de la Requête Set Clear Domain Setting
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
serviceLe service que vous voulez supprimer, cela peut être "forward" (redirection), "stealth" (masquée), "email_forwarding" (redirection d'e-mail), "dns", et "nameservers" (serveurs de noms)
Balise XML de résultat
Explication
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nœud racine du document XML de réponse
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Clear Domain Setting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Response (XML format)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Response (JSON format)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder (Définir le Dossier)

Si la commande set folder est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder
Explication
domainLe nom de domaine à mettre à jour, seul 1 domaine peut être modifié par requête
folderLe nom de dossier que vous voulez utiliser pour votre domaine. Utilisez "Default" comme nom de dossier si vous voulez déplacer le domaine vers le dossier par défaut. Le nom de dossier est sensible à la casse. Par exemple, "Folder1" et "folder1" sont deux noms de dossiers différents.
folder_id (facultatif)L'ID du dossier vers lequel vous voulez déplacer votre domaine
Balise XML de résultat
Explication
<SetFolderResponse></SetFolderResponse>Balise de la réposne à set folder, c'est le noeud racine du document de réponse XML
<SetFolderHeader></SetFolderHeader>Entête de dossier
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder&domain=domian1.com&folder=folder1

Response (XML format)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder&domain=domian1.com&folder=folder1

Response (JSON format)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Renew Option (Définir l'option de renouvellement)

Si la commande set renew option est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Renew Option
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
renew_optionPeut être "donot", "auto", "reset"
Balise XML de résultat
Explication
<SetRenewOptionResponse></SetRenewOptionResponse>Nœud racine du document XML de réponse
<SetRenewOptionHeader></SetRenewOptionHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Renew Option

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto

Response (XML format)
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto

Response (JSON format)
{
   "SetRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Note (Définir une note)

Si la commande set note est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Note
Explication
domainLe domaine que vous voulez paramétrer, seulement 1 domaine peut être paramétré par requête
noteLa note que vous voulez définir pour le domaine, peut être vide
Balise XML de résultat
Explication
<SetNoteResponse></SetNoteResponse>Nœud racine du document XML de réponse
<SetNoteHeader></SetNoteHeader>Entête de Réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Note

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_note&domain=domain1.com&note=Do not modify any information

Response (XML format)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_note&domain=domain1.com&note=Do not modify any information

Response (JSON format)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Set Customer Id Command (RESELLER ONLY)

If calling set customer id command, the following parameters should be included:

Set Customer Id Request Parameter
Explication
domainThe domain you want to set, multiple domains are separated by commas (Max:100)
customer_idCustomer id you want to set to the domain, can't be null
Balise XML de résultat
Explication
<SetCustomerIdResponse></SetCustomerIdResponse>Nœud racine du document XML de réponse
<SetCustomerIdHeader></SetCustomerIdHeader>Entête de réponse
<SetCustomerIdContent></SetCustomerIdContent>Contenu de la réponse
<SetCustomerIdSuccess></SetCustomerIdSuccess>Set customer id success response content
<SetCustomerIdFailed></SetCustomerIdFailed>Set customer id failed response content
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure, "1" for problem
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Set Customer Id Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (XML format)
<SetCustomerIdResponse>
    <SetCustomerIdHeader>
        <ResponseCode>0</ResponseCode>
        <Status>success</Status>
    </SetCustomerIdHeader>
    <SetCustomerIdContent>
        <SetCustomerIdSuccess>
            <content>
                <Domain>domain1.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
            <content>
                <Domain>domain2.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
        </SetCustomerIdSuccess>
    </SetCustomerIdContent>
</SetCustomerIdResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (JSON format)
{
    "SetCustomerIdResponse": {
        "ResponseCode": 0,
        "Status": "success",
        "SetCustomerIdSuccess": [
            {
                "Domain": "domain1.com",
                "CustomerId": 123456
            },
            {
                "Domain": "domain2.com",
                "CustomerId": 123456
            }
        ]
    }
}
 

Commande Set Privacy (Définir la confidentialité)

Si la commande set privacy est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Privacy
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
optionLe statut de confidentialité du domaine que vous voulez définir, cela peut être "full", "partial", ou "off"
Balise XML de résultat
Explication
<SetPrivacyResponse></SetPrivacyResponse>Nœud racine du document XML de réponse
<SetPrivacyHeader></SetPrivacyHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Privacy

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_privacy&domain=domain1.com&option=off

Response (XML format)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_privacy&domain=domain1.com&option=off

Response (JSON format)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Prix des TLD

This feature is only available in XML and JSON format:

Paramètre de Demande de Prix du TLD
Explication
currency (facultatif)La devise du résultat, devrait être "usd", "eur", ou "cny", devise par défaut est la devise par défaut de l'API paramétrée dans le compte
Balise XML de résultat
Explication
<TldPriceResponse></TldPriceResponse>Nœud racine du document XML de réponse
<TldPriceResponseHeader></TldPriceResponseHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<TldPriceContent></TldPriceContent>Contenu de la réponse
<TldContent></TldContent>Infos du TLD
<Tld></Tld>Domaines de premier niveau
<Usage></Usage>Utilisation du TLD
<Price></Price>Informations de prix sur ce TLD. Contient les sous-balises : Unit : Unité de prix. Register : Prix d'enregistrement. Renew : Prix de renouvellement. Transfer : Prix de transfert.
<Privacy></Privacy>Si ce TLD supporte la confidentialité Whois
<GracePeriod></GracePeriod>Informations de délai de grâce pour ce TLD. Contient les sous-balises : Unit : Unité d'info de délai de grâce. Renew : Délai de grâce de renouvellement. Delete : Délai de grâce de suppression.
<IDN></IDN>Si ce TLD supporte les Noms de Domaines Internationalisés (IDN)
<Restrictions></Restrictions>Nom de domaine

Exemple de Prix de TLD

Request (XML format)

https://api.dynadot.com/api3.xml?key=0&command=tld_price&currency=USD

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>.com</Tld>
      <Usage>Usage</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>99.00</Register>
        <Renew>60.00</Renew>
        <Transfer>92.00</Transfer>
      </Price>
      <Privacy>Yes</Privacy>
      <GracePeriod>
        <Unit>(Grace Period/days)</Unit>
        <Renew>40</Renew>
        <Delete>5</Delete>
      </GracePeriod>
      <IDN>Yes</IDN>
      <Restrictions>--</Restrictions>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=0&command=tld_price&currency=USD

Response (JSON format)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": ".com",
        "Usage": "Usage",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "99.00",
          "Renew": "60.00",
          "Transfer": "92.00"
        },
        "Privacy": "Yes",
        "GracePeriod": {
          "Unit": "(Grace Period/days)",
          "Renew": "40",
          "Delete": "5"
        },
        "IDN": "Yes",
        "Restrictions": "--"
      }
    ]
  }
}
 

Commande List Domain (Lister les domaines)

This feature is only available in XML and JSON format:

Paramètre de Requête List Domain
Explication
customer_id (facultatif)Filter data by customer id (only resellers can use this parameter)
Balise XML de résultat
Explication
<ListDomainInfoResponse></ListDomainInfoResponse>Nœud racine du document XML de réponse
<ListDomainInfoHeader></ListDomainInfoHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<ListDomainInfoContent></ListDomainInfoContent>Contenu de la réponse
<DomainInfoList></DomainInfoList>Liste des informations de domaine
<DomainInfo></DomainInfo>Informations de domaine
<Domain></Domain>Domaine
<Name></Name>Nom de domaine
<Expiration></Expiration>Date d'expiration de domaine en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<Registration></Registration>Date d'enregistrement de domaine en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<NameServerSettings></NameServerSettings>Paramètres de serveur de noms
<Type></Type>Type de configuration de serveur de noms
<WithAds></WithAds>Avec publicités ou non
<Whois></Whois>Informations de Whois
<Registrant></Registrant>Informations du Titulaire
<ContactId></ContactId>Identifiant de contact
<Admin></Admin>Informations d'administrateur
<Technical></Technical>Informations techniques
<Billing></Billing>Informations de Facturation
<Locked></Locked>Verrouillé ou non
<Disabled></Disabled>Statut d'activation
<Hold></Hold>En attente
<Privacy></Privacy>Statut de confidentialité
<isForSale></isForSale>Statut de vente
<RenewOption></RenewOption>Option de renouvellement
<Note></Note>Note
<Folder></Folder>Informations de dossier
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom de dossier

Exemple de List Domain

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=list_domain

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=list_domain

Response (JSON format)
{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      }
    ]
  }
}
 

Commande Create Contact (Créer un Contact)

Si la commande create contact est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Create Contact
Explication
organization (facultatif)Les informations d'organisation
nameNom
emailE-mail
phonenumNuméro de téléphone
phoneccCode pays téléphonique
faxnum (facultatif)Numéro de fax
faxcc (facultatif)Code pays pour le fax
address1Adresse 1
address2 (facultatif)Adresse 2
cityVille
state (facultatif)État
zipCode Zip
countryPays
Balise XML de résultat
Explication
<CreateContactResponse></CreateContactResponse>Nœud racine du document XML de réponse
<CreateContactHeader></CreateContactHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<CreateContactContent></CreateContactContent>New Contact ID, only used when status is "success"

Exemple Create Contact

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

Response (XML format)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

Response (JSON format)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

Commande Edit Contact (Modifier Contact)

Si la commande edit contact est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Edit Contact
Explication
contact_idL'ID du contact que vous voulez modifier
organization (facultatif)Les informations d'organisation
nameNom
emailE-mail
phonenumNuméro de téléphone
phoneccCode pays téléphonique
faxnum (facultatif)Numéro de fax
faxcc (facultatif)Code pays pour le fax
address1Adresse 1
address2 (facultatif)Adresse 2
cityVille
stateÉtat
zipCode Zip
countryPays
Balise XML de résultat
Explication
<EditContactResponse></EditContactResponse>Nœud racine du document XML de réponse
<EditContactHeader></EditContactHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<EditContactContent></EditContactContent>Contenu de la réponse
<ContactId></ContactId>ID du contact
Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Request (CSV format)

https://api.dynadot.com/api3.html?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response (CSV format)
ok,

success,
,
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response (JSON format)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
 

Set Contact EU Setting Command

If calling set contact eu setting command, the following parameters should be included:

Set Contact EU Setting Request Parameter
Explication
contact_idL'ID du contact que vous voulez modifier
country_of_citizenshipMust be an EU member state, The country codes of member states include :
AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, NL, NO, PL, PT, RO, SK, SI, ES, SE
Balise XML de résultat
Explication
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nœud racine du document XML de réponse
<SetContactEUSettingHeader></SetContactEUSettingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Set Contact EU Setting Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT

Response (JSON format)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Set Contact LV Setting Command

If calling set contact lv setting command, the following parameters should be included:

Set Contact LV Setting Request Parameter
Explication
contact_idL'ID du contact que vous voulez modifier
registration_number- For individual, Please enter Latvian identification number.
- For companies and other legal entities, please enter registration number issued by the Latvian Register of Enterprises.
vat_number (facultatif)VAT number for foreign legal entities registered within European Union countries (this includes also Latvian companies)
Balise XML de résultat
Explication
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nœud racine du document XML de réponse
<SetContactLvSettingHeader></SetContactLvSettingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Set Contact LV Setting Example

Request (CSV format)

https://api.dynadot.com/api3.csv?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (CSV format)
ok,success,0
Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (JSON format)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Commande Delete Contact (Supprimer Contact)

Si la commande delete contact est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Delete Contact
Explication
contact_idL'ID du contact que vous voulez supprimer, assurez-vous qu'ils soient séparés par des virgules
Balise XML de résultat
Explication
<DeleteContactResponse></DeleteContactResponse>Nœud racine du document XML de réponse
<DeleteContactHeader></DeleteContactHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Delete Contact

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_contact&contact_id=0

Response (XML format)
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>-1</SuccessCode>
    <Status>error</Status>
    <Error>cannot delete these contacts (Jack Slater). Because they are in use.</Error>
  </DeleteContactHeader>
</DeleteContactResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_contact&contact_id=0

Response (JSON format)
{
   "DeleteContactResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Contact List (Liste de Contacts)

This command is only available in XML and JSON format:

Paramètre de Requête Contact List
Explication
N/APas besoin de paramètre supplémentaire
Balise XML de résultat
Explication
<ContactListResponse></ContactListResponse>Nœud racine du document XML de réponse
<ContactListHeader></ContactListHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<ContactListContent></ContactListContent>Contenu de la réponse
<ContactList></ContactList>Liste de Contacts
<Contact></Contact>Information de Contact
<ContactId></ContactId>ID de contact
<Organization></Organization>Organisation du Contact
<Name></Name>Nom
<Email></Email>E-mail
<PhoneCc></PhoneCc>Code pays téléphonique
<PhoneNum></PhoneNum>Numéro de téléphone
<FaxCc></FaxCc>Code pays pour le fax
<FaxNum></FaxNum>Numéro de fax
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code Zip
<Country></Country>Pays
<GtldVerified></GtldVerified>Statut de vérification gTLD

Exemple Contact List

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=contact_list

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack Slater</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 Free Way</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=contact_list

Response (JSON format)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack Slater",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 Free Way",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

Commande Get Contact

This command is only available in XML and JSON format:

Paramètre de Requête Get Contact
Explication
contact_idid de contact
Balise XML de résultat
Explication
<GetContactResponse></GetContactResponse>Nœud racine du document XML de réponse
<GetContactHeader></GetContactHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetContactContent></GetContactContent>Contenu de la réponse
<Contact></Contact>Information de Contact
<ContactId></ContactId>ID de contact
<Organization></Organization>Organisation du Contact
<Name></Name>Nom
<Email></Email>E-mail
<PhoneCc></PhoneCc>Code pays téléphonique
<PhoneNum></PhoneNum>Numéro de téléphone
<FaxCc></FaxCc>Code pays pour le fax
<FaxNum></FaxNum>Numéro de fax
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code Zip
<Country></Country>Pays
<GtldVerified></GtldVerified>Statut de vérification gTLD

Exemple de Get Contact

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_contact&contact_id=10000

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_contact&contact_id=10000

Response (JSON format)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "[email protected]",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

Commande Get Name Server (Obtenir le Serveur de Noms)

Quand la commande get name server est appelée, les paramètres suivants doivent être inclus :

Paramètres de Requête Get Name Server
Explication
domainLe domaine avec les informations de serveur de noms que vous voulez obtenir, seules les informations de serveur de noms du domaine 1 peuvent être transférées (pull) par requête.
Balise XML de résultat
Explication
<GetNsResponse></GetNsResponse>Nœud racine du document XML de réponse
<GetNsHeader></GetNsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<NsContent></NsContent>Contenu de la réponse
<Host></Host>Nom d'hôte du serveur
<NsName></NsName>Nom du Serveur

Exemple de Get Name Server

Request (XML format)

https://api.dynadot.com/api3.html?key=mykey&command=get_ns&domain=mydomain.com

Response (XML format)
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_ns&domain=mydomain.com

Response (JSON format)
{
   "GetNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "NsContent":{
         "Host":"ns1.mydomain.com",
         "Host":"ns2.mydomain.com"
      }
   }
}
 

Commande Add Name Server (Ajouter serveur de noms)

Si la commande add name server est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Add Name Server
Explication
hostLe nom d'hôte du serveur de noms que vous voulez ajouter
Balise XML de résultat
Explication
<AddNsResponse></AddNsResponse>Nœud racine du document XML de réponse
<AddNsHeader></AddNsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<AddNsContent></AddNsContent>Contenu de la réponse
<Server></Server>Serveur que vous avez défini
<Host></Host>Nom d'hôte du nouveau serveur
<ServerId></ServerId>ID du nouveau serveur

Exemple Add Name Server

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=add_ns&host=ns1.mydomain.com

Response (XML format)
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=add_ns&host=ns1.mydomain.com

Response (JSON format)
{
   "AddNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "AddNsContent":{
         "Server":{
            "Host":"ns1.mydomain.com",
            "ServerId":"0"
         }
      }
   }
}
 

Commande Register Name Server (Enregistrer serveur de noms)

Si la commande register name server est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Register Name Server
Explication
hostLe nom d'hôte de votre propre serveur de noms
ipL'adresse IP de votre serveur de noms personnel
Balise XML de résultat
Explication
<RegisterNsResponse></RegisterNsResponse>Nœud racine du document XML de réponse
<RegisterNsHeader></RegisterNsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<RegisterNsContent></RegisterNsContent>Contenu de la réponse
<Server></Server>Balise serveur
<Host></Host>Nom d'hôte
<ServerId></ServerId>ID de serveur

Exemple de Register Name Server

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1

Response (XML format)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1

Response (JSON format)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

Commande Set Name Server IP (Définir IP du serveur de noms)

Si la commande set name server IP est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Name Server IP
Explication
server_idL'ID du serveur de noms que vous voulez définir
ip0 - ip9L'adresse IP que vous voulez définir pour le serveur de noms, 9 IPs peuvent être définies par requête et doivent être séparées par des virgules
Balise XML de résultat
Explication
<SetNsIpResponse></SetNsIpResponse>Nœud racine du document XML de réponse
<SetNsIpHeader></SetNsIpHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Name Server IP

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (XML format)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (JSON format)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Delete Name Server (Supprimer serveur de noms)

Si la commande delete name server est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Delete Name Server
Explication
server_idL'ID des serveurs de noms que vous voulez supprimer, assurez vous de les séparer par des virgules
Balise XML de résultat
Explication
<DeleteNsResponse></DeleteNsResponse>Nœud racine du document XML de réponse
<DeleteNsHeader></DeleteNsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Delete Name Server

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns&server_id=0

Response (XML format)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_ns&server_id=0

Response (JSON format)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Delete Name Server By Domain (Suppression de Serveur de Noms par Domaine)

If calling delete name server by domain command, the following parameters should be included:

Paramètre de la Requête Delete Name Server By Domain
Explication
server_domainNom du serveur de noms. ex : ns1.testnameserver.com
Balise XML de résultat
Explication
<DeleteNsResponse></DeleteNsResponse>Nœud racine du document XML de réponse
<DeleteNsHeader></DeleteNsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Delete Name Server By Domain

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (XML format)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (JSON format)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Server List (Liste de serveurs)

This command is only available in XML and JSON format:

Paramètre de Requête Server List
Explication
N/APas besoin de paramètre supplémentaire
Balise XML de résultat
Explication
<ServerListResponse></ServerListResponse>Nœud racine du document XML de réponse
<ServerListHeader></ServerListHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<ServerListContent></ServerListContent>Contenu de la réponse
<NameServerList></NameServerList>Liste de Serveur de noms
<List></List>
<Server></Server>
<ServerId></ServerId>ID de serveur
<ServerName></ServerName>Nom de serveur
<ServerIp></ServerIp>IP de serveur

Exemple Server List

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=server_list

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=server_list

Response (JSON format)
{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIp": "192.168.1.1"
      }
    ]
  }
}
 

Get Domain NameServer Settings Command

If calling get domain nameservers settings command, the following parameters should be included:

Get Domain Nameserver Settings Request Parameter
Explication
domainThe domain whose name server setting you want to get, only 1 domain's name server setting can be pulled per request.
Balise XML de résultat
Explication
<GetDnsResponse></GetDnsResponse>Nœud racine du document XML de réponse
<GetDnsHeader></GetDnsHeader>Entête de réponse
<ResponseCode></ResponseCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetDnsContent></GetDnsContent>Contenu de la réponse
<NameServerSettings></NameServerSettings>Paramètres du serveur de noms du domaine
<Type></Type>Type du serveur de noms du domaine

Get Domain Nameserver Settings Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_dns&domain=mydomain.com

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_dns&domain=mydomain.com

Response (JSON format)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Commande Get Transfer Auth Code (Obtention de Code d'Autorisation de Transfert)

Vous devez déverrouiller votre domaine et votre compte avant de demander le code d'autorisation.

Paramètre de la requête Get Transfer Auth Code
Explication
domainLe nom de domaine pour lequel vous voulez obtenir le code d'autorisation de transfert, seulement 1 domaine peut être entré par requête.
new_code (optional)Génère un nouveau code d'autorisation de transfert
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Si vous voulez déverrouiller le domaine pour le transférer, mettez-le à "1". Si la demande est traitée avec succès, le domaine sera déverrouillé.
Balise XML de résultat
Explication
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Nœud racine du document XMLXML de réponse
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<AuthCode></AuthCode>Code d'autorisation utilisé pour initier un transfert de domaine

Exemple de Get Transfer Auth Code (Obtenir de code d'autorisation de transfert)

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (XML format)
<GetTransferAuthCodeResponse>
   <GetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <AuthCode>testauthcode</AuthCode>
   </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (JSON format)
{
   "GetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "AuthCode":"testauthcode"
   }
}
 

Get Transfer Status Command

If calling get transfer status command, the following parameters should be included:

Get Transfer Status Request Parameter
Explication
domainThe domain name you want to get transfer status for, only 1 domain can be entered per request
transfer_typeThe transfer type you want to get transfer status for (transfer in or transfer away)
Balise XML de résultat
Explication
<GetTransferStatusResponse></GetTransferStatusResponse>Nœud racine du document XMLXML de réponse
<GetTransferStatusHeader></GetTransferStatusHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetTransferStatusContent></GetTransferStatusContent>Contenu de la réponse
<TransferList></TransferList>Transfer list
<Transfer></Transfer>Transfer info
<OrderId></OrderId>The order id
<TransferStatus></TransferStatus>The transfer status of domain.If you got 'none' or 'approved', you can cancel the transfer.If you got 'waiting', means transfer already start.If you got 'auth code needed', means bad auth code, you can use another api SET_TRANSFER_AUTH re-submit auth code.There are also some other statuses, we will send you an email or needs to be checked by our engineers.

Get Transfer Status Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (JSON format)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

Set Transfer Auth Code For Transfer Order Command

The command which allows you to update auth code for processing transfer orders. If calling set transfer auth code command, the following parameters should be included:

Set Transfer Auth Code Request Parameter
Explication
domainThe domain name you update the transfer auth for, only 1 domain can be entered per request
auth_codeThe auth_code you want to re-submit
order_idThe transfer order id, you can get it from another api get_transfer_status.
Balise XML de résultat
Explication
<GetTransferStatusResponse></GetTransferStatusResponse>Nœud racine du document XMLXML de réponse
<GetTransferStatusHeader></GetTransferStatusHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Set Transfer Auth Code Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (XML format)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (JSON format)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Cancel Transfer For Order Command

The Command allows you to cancel a transfer item in the order. If calling cancel transfer command, the following parameters should be included:

Cancel Transfer Request Parameter
Explication
domainThe domain name you want to cancel transfer for, only 1 domain can be entered per request
order_idThe transfer order id, you can get it from another api get_transfer_status.
Balise XML de résultat
Explication
<CancelTransferResponse></CancelTransferResponse>Nœud racine du document XMLXML de réponse
<CancelTransferHeader></CancelTransferHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Cancel Transfer Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=cancel_transfer&domain=domain4.com

Response (XML format)
<CancelTransferResponse>
   <CancelTransferHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </CancelTransferHeader>
</CancelTransferResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=cancel_transfer&domain=domain4.com

Response (JSON format)
{
   "CancelTransferResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Authorize Transfer Away Command (RESELLER ONLY)

Authorize Transfer Away Request Parameter
Explication
domainThe domain name you want to authorize transfer away for, only 1 domain can be entered per request
order_idThe Dynadot order_id of the domain you want to transfer away
authorizeTo authorize the transfer away, set it equal to "approve". To deny the transfer away, set it equal to "deny".
Balise XML de résultat
Explication
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Nœud racine du document XMLXML de réponse
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<Result></Result>The result of authorize transfer away

Authorize Transfer Away Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Response (XML format)
<AuthorizeTransferAwayResponse>
   <AuthorizeTransferAwayHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <Result>away_approved</Result>
   </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Response (JSON format)
{
   "AuthorizeTransferAwayResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Result":"away_approved"
   }
}
 

Create CN Audit Command

The Command allows you to create a CN audit for a contact. If calling create cn audit command, the following parameters should be included:

Create CN Audit Request Parameter
Explication
contact_idThe contact record id you want start audit for, only 1 contact id can be entered per request
contact_typeType of contact, can be either "Individual" or "Enterprise"
individual_id_typeNatural person's ID type, expected values (description of value) are:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)
individual_license_idThe License number of natural person's ID
individual_urlDocument of natural person license ID. The file url on the server. Only jpg, gif, png, jpeg are allowed
enterprise_id_type (Mandatory when contact type is "Enterprise")Enterprise ID type, expected values (description of value) are:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)
enterprise_license_id (Mandatory when contact type is "Enterprise")The License number of enterprise document
enterprise_url (Mandatory when contact type is "Enterprise")Document of enterprise license. The file url on the server. Only jpg, gif, png, jpeg are allowed
Balise XML de résultat
Explication
<CreateCnAuditResponse></CreateCnAuditResponse>Nœud racine du document XML de réponse
<CreateCnAuditHeader></CreateCnAuditHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Create CN Audit Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2

Response (XML format)
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
 </CreateCnAuditResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=create_cn_audit&contact_id=testcontactid&license_id=testlicenseid&url=url

Response (JSON format)
{
   "CreateCnAuditResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Get Cn Audit Status Command

If calling get cn audit status command, the following parameters should be included:

Get Cn Audit Status Request Parameter
Explication
contact_idThe contact record id you want to get audit status for, only 1 contactId can be entered per request
gtldIf you query the audit result of the cnnic-gtld, set this parameter to 1
Balise XML de résultat
Explication
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Nœud racine du document XMLXML de réponse
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<CnAuditStatus></CnAuditStatus>the audit status of cnnic audit record. You may got 'processing' or 'waiting for cnnic' or 'failed'. If failed, we will send you an email.
<FailedReason></FailedReason>If the audit unpass, the failed reason will be displayed

Get Cn Audit Status Example

Request (XML format)

https://api.dynadot.xml/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Request (JSON format)

https://api.dynadot.json/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid

Response (JSON format)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

Get Account Balance Command

This command is only available in XML and JSON format:

Get Account Balance Request Parameter
Explication
N/APas besoin de paramètre supplémentaire
Balise XML de résultat
Explication
<GetAccountBalanceResponse></GetAccountBalanceResponse>Nœud racine du document XMLXML de réponse
<GetAccountBalanceHeader></GetAccountBalanceHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Contenu de la réponse
<Balance></Balance>Solde du Compte

Get Account Balance Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_account_balance

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_account_balance

Response (JSON format)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Commande Get Listings (Obtenir Listings)

If calling get listings command, the following parameters should be included:

Paramètre de Requête Get Listings
Explication
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
exclude_pending_sale (facultatif)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
Balise XML de résultat
Explication
<GetListingsResponse></GetListingsResponse>Nœud racine du document XMLXML de réponse
<GetListingsHeader></GetListingsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetListingsContent></GetListingsContent>Contenu de listing
<Listing></Listing>Contenu d'article de listing
<ListingId></ListingId>Identifiant de Listing
<Domain></Domain>Nom de domaine
<Price></Price>Prix
<InBoundLinks></InBoundLinks>nombre de liens entrants
<Age></Age>Age
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Get Listings

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&currency=usd&command=get_listings

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&currency=usd&command=get_listings

Response (JSON format)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No"
      }
    ]
  }
}
 

Commande Get Listing Item (Obtenir Article de Listing)

If calling get listing item command, the following parameters should be included:

Paramètre de Requête Get Listing Item
Explication
domainThe domain name you want to get detail, only 1 domain can be entered per request
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetListingItemResponse></GetListingItemResponse>Nœud racine du document XMLXML de réponse
<GetListingItemHeader></GetListingItemHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetListingsItemContent></GetListingsItemContent>Contenu de listing
<Listing></Listing>Contenu d'article de listing
<ListingId></ListingId>Identifiant de Listing
<Domain></Domain>Nom de domaine
<Price></Price>Prix
<InBoundLinks></InBoundLinks>nombre de liens entrants
<Age></Age>Age

Exemple de Get Listing Item

Request (XML format)

http://api.dynadot.com/api3.xml?key=my_key&command=get_listing_item&currency=usd&domain=domain_name

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Request (JSON format)

http://api.dynadot.com/api3.json?key=my_key&command=get_listing_item&currency=usd&domain=domain_name

Response (JSON format)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No"
    }
  }
}
 

Commande Buy It Now (Acheter tout de suite)

If calling buy it now command, the following parameters should be included:

Paramètre de Requête Buy It Now
Explication
domainThe domain you want to buy, only 1 domain can be entered per request
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<BuyItNowResponse></BuyItNowResponse>Nœud racine du document XMLXML de réponse
<BuyItNowHeader></BuyItNowHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<Message></Message>It should be "domain order created", only used when status is "success".

Exemple de Buy It Now (Acheter tout de suite)

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=buy_it_now&domain=domain&currency=currency

Response (XML format)
<BuyItNowResponse>
   <BuyItNowHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </BuyItNowHeader>
   <Message>domain order created</Message>
</BuyItNowResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=buy_it_now&domain=domain&currency=currency

Response (JSON format)
{
   "BuyItNowResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Message":"domain order created"
   }
}
 

Commande Account Information (Informations de compte)

This command is only available in XML and JSON format:

Paramètre de Requête Account Info
Explication
N/APas besoin de paramètre supplémentaire
Balise XML de résultat
Explication
<AccountInfoResponse></AccountInfoResponse>Nœud racine du document XML de réponse
<AccountInfoHeader></AccountInfoHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<AccountInfoContent></AccountInfoContent>Contenu de la réponse
<AccountInfo></AccountInfo>Informations de compte
<Username></Username>Pseudo
<ForumName></ForumName>Nom de forum
<Contact></Contact>Information de Contact
<Organization></Organization>Organisation
<Organization></Organization>Entête de réponse
<Name></Name>Votre nom
<Email></Email>E-mail
<PhoneCc></PhoneCc>Code pays téléphonique
<PhoneNum></PhoneNum>Numéro de téléphone
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code Zip
<Country></Country>Pays
<CustomerSince></CustomerSince>Client depuis
<AccountLock></AccountLock>Verrouillage de compte
<TotalSpending></TotalSpending>Dépense totale
<PriceLevel></PriceLevel>Niveau de prix
<AccountBalance></AccountBalance>Solde de compte
<CustomTimeZone></CustomTimeZone>Fuseau horaire personnalisé
<DefaultSettings></DefaultSettings>Paramètres par défaut
<DefaultWhois></DefaultWhois>Whois par défaut
<DefaultRegistrant></DefaultRegistrant>Titulaire par défaut
<ContactId></ContactId>ID de contact
<DefaultAdmin></DefaultAdmin>Admin par défaut
<DefaultTechnical></DefaultTechnical>Technique par défaut
<DefaultBilling></DefaultBilling>Facturation par défaut
<Type></Type>Type de serveur de noms
<WithAds></WithAds>Avec publicités ou non

Exemple Account Information

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=account_info

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=account_info

Response (JSON format)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

Commande Set Default Whois (Définir le Whois par défaut)

Si la commande set default Whois est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Whois
Explication
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations d'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
Balise XML de résultat
Explication
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nœud racine du document XML de réponse
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Whois

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Name Servers (Définir les serveurs de noms par défaut)

Si la commande set default name servers est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Name Servers
Explication
ns0 - ns12Les serveurs de noms que vous voulez définir
Balise XML de résultat
Explication
<SetDefaultNsResponse></SetDefaultNsResponse>Balise de la réponse à set default name servers, c'est le nœud racine du document XML de réponse
<SetDefaultNsHeader></SetDefaultNsHeader>Balise de l'entête de set default name servers
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<SetDefaultNsContent></SetDefaultNsContent>Balise du contenu de set default name servers, seulement utilisée quand le statut est "success"
<Servers></Servers>Les informations des serveurs que vous avez paramétrés
<Server></Server>Chaque serveur
<ServerName></ServerName>Nom de serveur
<ServerId></ServerId>Identifiant de serveur

Exemple de Set Default Name Server

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (XML format)
<SetDefaultNsResponse>
   <SetDefaultNsHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultNsHeader>
   <SetDefaultNsContent>
      <Servers>
         <Server>
            <ServerName>ns1.hosts.com</ServerName>
            <ServerId>0</ServerId>
         </Server>
         <Server>
            <ServerName>ns2.host.com</ServerName>
            <ServerId>1</ServerId>
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
      </Servers>
   </SetDefaultNsContent>
</SetDefaultNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (JSON format)
{
   "SetDefaultNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "SetDefaultNsContent":{
         "Servers":[
            {
               "ServerName":"ns1.hosts.com",
               "ServerId":"0"
            },
            {
               "ServerName":"ns2.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

Commande Set Default Parking

Si la commande set default parking est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Parking
Explication
with_ads (facultatif)Si vous ne voulez pas de publicités de tierce partie, vous pouvez utiliser ce paramètre avec "no", la valeur par défaut est "yes"
Balise XML de résultat
Explication
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nœud racine du document XML de réponse
<SetDefaultParkingHeader></SetDefaultParkingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Parking

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_parking&folder_id=0&with_ads=no

Response (XML format)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_parking&folder_id=0&with_ads=no

Response (JSON format)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Forwarding (Définir le transfert par défaut)

Si la commande set default forwarding est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Forwarding
Explication
forward_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
is_temp (facultatif)Statut de redirection de votre domaine, la valeur par défaut est "temporary", si vous voulez le rediriger de façon permanente, utilisez ce paramètre avec "no"
Balise XML de résultat
Explication
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nœud racine du document XML de réponse
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Forwarding

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Response (XML format)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Response (JSON format)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Stealth (Définir invisibilité par défaut)

Si la commande set default stealth est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Stealth
Explication
stealth_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
stealth_title (facultatif)Le titre de la page
Balise XML de résultat
Explication
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nœud racine du document XML de réponse
<SetDefaultStealthHeader></SetDefaultStealthHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Set Default Stealth

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (XML format)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (JSON format)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Hosting (Définir Hébergement par défaut)

Si la commande set default hosting est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Hosting
Explication
hosting_typeType d'hébergement par défaut que vous voulez, vous pouvez choisir entre "advanced" et "basic"
Balise XML de résultat
Explication
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nœud racine du document XML de réponse
<SetDefaultHostingHeader></SetDefaultHostingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Hosting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_hosting&hosting_type=advanced

Response (XML format)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_hosting&hosting_type=advanced

Response (JSON format)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default DNS (Définir DNS par défaut)

Si la commande set default DNS est appelée, les paramètres suivants doivent être inclus :

(Cette commande est obsolète et non recommandée, veuillez plutôt utiliser la commande Set Default DNS2)

Paramètre de Requête Set Default DNS
Explication
main_record_typeType de l'enregistrement principal
main_recordSpécifiez un enregistrement DNS pour votre domaine
main_txt (facultatif)Spécifiez un enregistrement TXT pour votre domaine. Si votre main_record_type est aaaa et que vous avez spécifié main_record2, vous pouvez paramétrer jusqu'à 3 main_txts, sinon vous pouvez paramétrer jusqu'à 4 main_txts.
main_record2Enregistrement principal 2, seulement utilisé quand "main_record_type" est "aaaa". Sa valeur doit être au format ipv4.
subdomain0 - subdomain99 (facultatif)Enregistrements de sous-domaines
sub_record_type0 - sub_record_type99 (facultatif)Type d'enregistrement de sous-domaine
sub_record0 - sub_record99 (facultatif)Adresse IP ou hôte cible
mx_host0 - mx_host2 (facultatif)Spécifiez l'hôte de mail pour votre domaine, distance0 est la plus haute priorité
mx_distance0 - mx_distance2 (facultatif)Distance0 est la plus haute priorité
ttl (facultatif)Durée de vie
Balise XML de résultat
Explication
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nœud racine du document XML de réponse
<SetDefaultDnsHeader></SetDefaultDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default DNS

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default DNS2

Si la commande set default DNS est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default DNS2
Explication
main_record_type0 - main_record_type19Type de l'enregistrement principal
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance Mx, type de redirection, titre de redirection masquée ou alias d'e-mail nécessaires quand main_record est "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain99 (facultatif)Enregistrements de sous-domaines
sub_record_type0 - sub_record_type99 (facultatif)Type d'enregistrement de sous-domaine
sub_record0 - sub_record99 (facultatif)Adresse IP de sous-domaine ou hôte cible
sub_recordx0 - subdo_recordx99Distance Mx, type de redirection, titre de redirection masquée ou alias d'e-mail, nécessaires quand sub_record_type est "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
ttl (facultatif)Durée de vie
Balise XML de résultat
Explication
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nœud racine du document XML de réponse
<SetDefaultDnsHeader></SetDefaultDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Set Default DNS2

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Email Forward (Définir transfert d'e-mail par défaut)

Si la commande set default email forward est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Email Forward
Explication
forward_typeType de transfert, cela peut être "donot": Ne pas transférer l'e-mail, "mx": Envoyer l'e-mail à un autre hôte mail ( enregistrement MX), "forward": Envoyer l'e-mail à un autre hôte mail
username0 - username9Nom d'utilisateur, utilisé seulement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse mail existante, utilisée seulement quand "forward_type" est "forward"
mx_host0 - mx_host2Hôte mail, utilisé seulement quand "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la plus haute priorité, utilisé seulement quand "forward_type" est "mx"
Balise XML de résultat
Explication
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nœud racine du document XML de réponse
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Email Forward

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Clear Default Setting

Si la commande set clear default setting est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Clear Default Setting
Explication
serviceLe service que vous voulez supprimer, cela peut être "forward" (redirection), "stealth" (masquée), "email_forwarding" (redirection d'e-mail), "dns", et "nameservers" (serveurs de noms)
Balise XML de résultat
Explication
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nœud racine du document XML de réponse
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Clear Default Setting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_default_setting&service=nameservers

Response (XML format)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_default_setting&service=nameservers

Response (JSON format)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Renew Option (Définir l'option de renouvellement par défaut)

Si la commande set default renew option est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Default Renew Option
Explication
renew_optionPeut être "donot", "auto", "reset"
Balise XML de résultat
Explication
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nœud racine du document XML de réponse
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Default Renew Option

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_renew_option&renew_option=auto

Response (XML format)
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_renew_option&renew_option=auto

Response (JSON format)
{
   "SetDefaultRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Create Folder (Créer dossier)

Si la commande create folder est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Create Folder
Explication
folder_nameNom du dossier que vous voulez créer
Balise XML de résultat
Explication
<FolderCreateResponse></FolderCreateResponse>Nœud racine du document XML de réponse
<FolderCreateHeader></FolderCreateHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<FolderCreateContent></FolderCreateContent>Contenu de la réponse
<FolderName></FolderName>nom de dossier
<FolderId></FolderId>ID du nouveau dossier

Exemple Create Folder

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=create_folder&folder_name=new

Response (XML format)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=create_folder&folder_name=new

Response (JSON format)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

Commande Delete Folder (Supprimer Dossier)

Si la commande set Whois est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Delete Folder
Explication
folder_idLes ID de dossiers que vous voulez supprimer, assurez-vous qu'ils soient séparés par des virgules
Balise XML de résultat
Explication
<DeleteFolderResponse></DeleteFolderResponse>Nœud racine du document XML de réponse
<DeleteFolderHeader></DeleteFolderHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Delete Folder

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_folder&folder_id=0,1

Response (XML format)
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_folder&folder_id=0,1

Response (JSON format)
{
   "DeleteFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Whois

Si la commande set folder Whois est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Whois
Explication
folder_idL'ID du dossier que vous voulez définir
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations d'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
enable (facultatif)Si vous voulez appliquer cette configuration de Whois aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration de Whois à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nœud racine du document XML de réponse
<SetFolderWhoisHeader></SetFolderWhoisHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Whois

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Name Servers (Paramétrer les serveurs de noms d'un dossier)

Si la commande set folder name servers est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Name Servers
Explication
fold_idL'ID du dossier que vous voulez paramétrer, seulement 1 dossier peut être paramétrer par requête
ns0 - ns12Les serveurs de noms pour votre domaine, vous pouvez spécifier jusqu'à 13 serveurs de noms, mais ils doivent déjà exister dans votre compte
enable (facultatif)Si vous voulez appliquer cette configuration de serveurs de noms aux domaines futurs que vous déplacerez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser la configuration de serveurs de noms à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderNsResponse></SetFolderNsResponse>Balise de la réponse à set folder name server, c'est le nœud racine du document XML de réponse
<SetFolderNsHeader></SetFolderNsHeader>Balise d'entête de la réponse à set folder name server
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<SetFolderNsContent></SetFolderNsContent>Balise du contenu de la réponse à set folder name server, seulement utilisée quand le statut est "success"
<Servers></Servers>Les informations des serveurs que vous avez paramétrés
<Server></Server>Chaque serveur
<ServerName></ServerName>Nom de serveur
<ServerId></ServerId>ID de serveur

Exemple Set Folder Name Servers

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (XML format)

0 success ns1.hosts.com 0 ns2.host.com 1

Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (JSON format)
{
   "SetFolderNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "SetFolderNsContent":{
         "Servers":[
            {
               "ServerName":"ns1.hosts.com",
               "ServerId":"0"
            },
            {
               "ServerName":"ns2.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

Commande Set Folder Parking (Définir le parking d'un dossier)

Si la commande set folder parking est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Parking
Explication
folder_idL'ID du dossier que vous voulez paramétrer, seulement 1 dossier peut être paramétrer par requête
with_ads (facultatif)Si vous ne voulez pas de publicités de tierce partie, vous pouvez utiliser ce paramètre avec "no", la valeur par défaut est "yes"
enable (facultatif)Si vous voulez appliquer cette configuration de parking aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration de parking à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderParkingResponse></SetFolderParkingResponse>Nœud racine du document XML de réponse
<SetFolderParkingHeader></SetFolderParkingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Parking

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no

Response (XML format)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no

Response (JSON format)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Forwarding (Définir la redirection d'un dossier)

Si la commande set folder forwarding est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Forwarding
Explication
folder_idL'ID du dossier que vous voulez définir
forward_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
is_temp (facultatif)Statut de redirection de votre domaine, la valeur par défaut est "temporary", si vous voulez le rediriger de façon permanente, utilisez ce paramètre avec "no"
enable (facultatif)Si vous voulez appliquer cette configuration de redirection aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration de redirection à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nœud racine du document XML de réponse
<SetFolderForwardingHeader></SetFolderForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Forwarding

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Response (XML format)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Response (JSON format)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Stealth (Définir l'invisibilité d'un dossier)

Si la commande set folder stealth est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Stealth
Explication
folder_idL'ID du dossier que vous voulez définir
stealth_urlL'URL vers laquelle vous voulez rediriger votre domaine. Veuillez noter que le paramètre doit être encodé pour que l'appel API soit interprété correctement.
stealth_title (facultatif)Le titre de la page
enable (facultatif)Si vous voulez appliquer cette configuration d'invisibilité aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration d'invisibilité à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderStealthResponse></SetFolderStealthResponse>Nœud racine du document XML de réponse
<SetFolderStealthHeader></SetFolderStealthHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Stealth

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes

Response (XML format)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes

Response (JSON format)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Hosting (Définir l'hébergement d'un dossier)

Si la commande set folder hosting est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Hosting
Explication
folder_idL'ID du dossier que vous voulez définir
hosting_typeType d'hébergement que vous voulez, vous pouvez choisir entre "advanced" et "basic"
enable (facultatif)Si vous voulez appliquer cette configuration d'hébergement aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
even (facultatif)Si vous voulez synchroniser cette configuration d'hébergement à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderHostingResponse></SetFolderHostingResponse>Nœud racine du document XML de réponse
<SetFolderHostingHeader></SetFolderHostingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Hosting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (XML format)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (JSON format)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder DNS (Définir le DNS d'un dossier)

Si la commande set folder DNS est appelée, les paramètres suivants doivent être inclus :

(Cette commande est obsolète et non recommandée, veuillez plutôt utiliser la commande Set Folder DNS2)

Paramètre de Requête Set Folder DNS
Explication
folder_idL'ID du dossier que vous voulez définir
main_record_typeType de l'enregistrement principal
main_recordSpécifiez un enregistrement DNS pour votre domaine
main_recordSpécifiez un enregistrement DNS pour votre domaine
with_ads (facultatif)Spécifiez un enregistrement TXT pour votre domaine. Si votre main_record_type est aaaa et que vous avez spécifié main_record2, vous pouvez paramétrer jusqu'à 3 main_txts, sinon vous pouvez paramétrer jusqu'à 4 main_txts.
main_record2Enregistrement principal 2, seulement utilisé quand "main_record_type" est "aaaa". Sa valeur doit être au format ipv4.
subdomain0 - subdomain99 (facultatif)Subdomain records (facultatif)
sub_record_type0 - sub_record_type99 (facultatif)Type d'enregistrement de sous-domaine
sub_record0 - sub_record99 (facultatif)Adresse IP ou hôte cible
mx_host0 - mx_host2 (facultatif)Spécifiez l'hôte de mail pour votre domaine, distance0 est la plus haute priorité
mx_distance0 - mx_distance2 (facultatif)Distance0 est la plus haute priorité
ttl (facultatif)Durée de vie
enable (facultatif)Si vous voulez appliquer cette configuration DNS aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration DNS à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderDnsResponse></SetFolderDnsResponse>Nœud racine du document XML de réponse
<SetFolderDnsHeader></SetFolderDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder DNS

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder DNS2

Si la commande set folder DNS2 est appelée, les paramètres suivants sont requis :

Paramètre de Requête Set Folder DNS2
Explication
folder_idL'ID du dossier que vous voulez définir
main_record_type0 - main_record_type19Le type des enregistrement principaux doit être "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance Mx, type de redirection, titre de redirection masquée ou alias d'e-mail nécessaires quand main_record_type est "forward","mx","stealth","email"
subdomain0 - subdomain99 (facultatif)Subdomain records (facultatif)
sub_record_type0 - sub_record_type99 (facultatif)Le type des enregistrements de sous-domaines doit être "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (facultatif)Adresse IP ou hôte cible
sub_recordx0 - sub_recordx99 (facultatif)Distance Mx, type de redirection, titre de redirection masquée ou alias d'e-mail nécessaires quand sub_record_type est "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
ttl (facultatif)Durée de vie
enable (facultatif)Si vous voulez appliquer cette configuration DNS aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration DNS à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderDnsResponse></SetFolderDnsResponse>Nœud racine du document XML de réponse
<SetFolderDnsHeader></SetFolderDnsHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Set Folder DNS2

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Email Forward (Définir le transfert d'e-mail d'un dossier)

Si la commande set folder email forward est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Email Forward
Explication
domainLe nom de domaine que vous voulez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils soient séparés par des virgules
folder_idID du dossier que vous voulez définir
forward_typeType de transfert, cela peut être "donot": Ne pas transférer l'e-mail, "mx": Envoyer l'e-mail à un autre hôte mail ( enregistrement MX), "forward": Envoyer l'e-mail à un autre hôte mail
username0 - username9Nom d'utilisateur, utilisé seulement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse mail existante, utilisée seulement quand "forward_type" est "forward"
mx_host0 - mx_host2Hôte mail, utilisé seulement quand "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la plus haute priorité, utilisé seulement quand "forward_type" est "mx"
enable (facultatif)Si vous voulez appliquer cette configuration aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nœud racine du document XML de réponse
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Email Forward

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Clear Folder Setting

Si la commande set clear folder setting est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Clear Folder Setting
Explication
folder_idL'ID du dossier que vous voulez définir
serviceLe service que vous voulez supprimer, cela peut être "forward" (redirection), "stealth" (masquée), "email_forwarding" (redirection d'e-mail), "dns", et "nameservers" (serveurs de noms)
Balise XML de résultat
Explication
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nœud racine du document XML de réponse
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Clear Folder Setting

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers

Response (XML format)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers

Response (JSON format)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Name (Définir le nom de dossier)

Si la commande set folder name est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Name
Explication
folder_idID du dossier que vous voulez définir
folder_nameNouveau nom de dossier
Balise XML de résultat
Explication
<SetFolderNameResponse></SetFolderNameResponse>Nœud racine du document XML de réponse
<SetFolderNameHeader></SetFolderNameHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Set Folder Name

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_name&folder_id=0&folder_name=new

Response (XML format)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_name&folder_id=0&folder_name=new

Response (JSON format)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Renew Option (Définir l'option de renouvellement d'un dossier)

Si la commande set folder renew option est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Set Folder Renew Option
Explication
folder_idL'ID du dossier que vous voulez paramétrer, seulement 1 dossier peut être paramétrer par requête
renew_optionThe renew option you want to set to the folder; it can be "donot", "auto" or "reset"
enable (facultatif)Si vous voulez appliquer cette configuration de renouvellement aux futurs domaines déplacés dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (facultatif)Si vous voulez synchroniser cette configuration de renouvellement à tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<Response></Response>Nœud racine du document XML de réponse
<ResponseHeader></ResponseHeader>Entête de Réponse
<ResponseCode></ResponseCode>Code de réponse, "0" pour succès, "-1" pour échec
<Error></Error>Information d'erreur, c'est seulement utilisé quand le code de réponse est "-1"

Exemple Set Folder Renew Option

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto

Response (XML format)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto

Response (JSON format)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Folder List (Liste de dossiers)

This command is only available in XML and JSON format:

Paramètre de Requête Folder List
Explication
N/APas besoin de paramètre supplémentaire
<FolderListResponse></FolderListResponse>Nœud racine du document XML de réponse
<FolderListHeader></FolderListHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<FolderListContent></FolderListContent>Contenu de la réponse
<FolderList></FolderList>Liste de dossiers
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom de dossier
<DefaultWhois></DefaultWhois>Whois par défaut
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Statut d'activation du Whois par défaut
<DefaultRegistrant></DefaultRegistrant>Titulaire par défaut
<ContactId></ContactId>ID de contact
<DefaultAdmin></DefaultAdmin>Admin par défaut
<DefaultTechnical></DefaultTechnical>Informations techniques par défaut
<DefaultBilling></DefaultBilling>Information de facturation par défaut
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Statut d'activation de serveur de noms par défaut
<NameServerSettings></NameServerSettings>Paramètres de serveur de noms
<Type></Type>Type de serveur de noms
<WithAds></WithAds>Avec publicités ou non
<DefaultRenewOption></DefaultRenewOption>Option de renouvellement par défaut
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Statut d'activation de l'option de renouvellement par défaut
<RenewOption></RenewOption>Option de renouvellement
<DefaultTransferLock></DefaultTransferLock>Verrouillage de transfert par défaut
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Statut d'activation du verrouillage de transfert par défaut
<LockStatus></LockStatus>Statut de verrouillage

Exemple Folder List

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=folder_list

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=folder_list

Response (JSON format)
{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}
 

Commande Add Backorder Request (Ajouter requête de commande en attente)

Si la commande add backorder request est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Add Backorder Request
Explication
domainLe(s) domaine(s) que vous voulez ajouter et acceptez de payer si Dynadot les obtient, 100 domaines peuvent être ajoutés par requête, ils doivent être séparés par des virgules
Balise XML de résultat
Explication
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nœud racine du document XML de réponse
<AddBackorderRequestHeader></AddBackorderRequestHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Add Backorder Request

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (XML format)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (JSON format)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Delete Backorder Request (Supprimer requête de commande en attente)

Si la commande delete backorder request est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Delete Backorder Request
Explication
domainLe(s) domaine(s) que vous voulez retirer de votre liste de requête de commandes en attente, 100 domaines peuvent être retirés par requête, ils doivent être séparés par des virgules
Balise XML de résultat
Explication
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nœud racine du document XML de réponse
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple Delete Backorder Request

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_backorder_request&domain=domaindropp.com

Response (XML format)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_backorder_request&domain=domaindropp.com

Response (JSON format)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Backorder Request List (Liste des requêtes de commandes en attente)

Appeler la commande backorder request list renverra une liste de demandes de commandes en attente pour le compte spécifié. Si cette commande est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Backorder Request List
Explication
startDateDate limite de début de l'enchère que vous voulez interroger, aaaa-mm-jj, comme 2015-05-30
endDateDate limite de fin de l'enchère que vous voulez interroger, aaaa-mm-jj, comme 2015-05-30
Balise XML de résultat
Explication
<BackorderRequestListResponse></BackorderRequestListResponse>Nœud racine du document XML de réponse
<BackorderRequestListHeader></BackorderRequestListHeader>Entête de réponse
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<BackorderRequestListContent></BackorderRequestListContent>Contenu de la réponse
<BackorderRequestList></BackorderRequestList>Liste des requêtes de commandes en attente
<BackorderRequest></BackorderRequest>Requête de commande en attente
<Domain></Domain>Domaine sur votre liste
<CutoffTime></CutoffTime>Date limite pour supprimer un demande en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<BackorderRequestStatus></BackorderRequestStatus>Statut dans le processus de renouvellement de domaine expiré

Exemple Backorder Request List

Request (XML format)

http://api.dynadot.com/api3.xml?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>
Request (CSV format)

http://api.dynadot.com/api3.html?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (CSV format)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
Request (JSON format)

http://api.dynadot.com/api3.json?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (JSON format)
{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}
 

Commande Get Open Auctions (Obtenir les enchères ouvertes)

Appeler la commande get open auctions renverra une liste des enchères en cours. Si cette commande est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Get Open Auctions
Explication
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
type (facultatif)The auction type you want to see, it should be "expired", "user", or "backorder", if you want to get more than one auction types, you can use "," to split each auction type
Balise XML de résultat
Explication
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Balise de la réponse à get open auctions, c'est le nœud racine du document XML de réponse
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Entête de get open auctions
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Balise du contenu de get open auctions, c'est seulement utilisé quand le statut est "success"
<Auction></Auction>Balise d'un article d'enchère, c'est seulement utilisé quand le statut est "success"
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<Revenue></Revenue>Revenu d'enchère
<RevenueCurrency></RevenueCurrency>Devise du revenu
<Visitors></Visitors>Visiteurs du domaine
<Links></Links>Liens entrants du domaine
<Age></Age>Age du domaine

Exemple Get Open Auctions

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_open_auctions&currency=usd

Response (XML format)
<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
Requête (format CSV)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions&currency=usd

Réponse

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_open_auctions&currency=usd

Response (JSON format)
{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        }
        ...
    ]
}
 

Commande Get Auction Details (Obtenir les détails d'une enchère)

Calling the get auction details command will return the details of auction specified. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Paramètre de Requête Get Auction Details
Explication
domainThe domain name of auction, IDN(International Domain Name) should use punycode, such as "xn--wkccg.com". you can get more than one auctions , each domain must be split by ","
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Balise de la réponse à get auction details, c'est le nœud racine du document XML de réponse
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>En-tête de Get backorder auction details
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Balise du contenu de get auction details, c'est seulement utilisé quand le statut est "success"
<AuctionStatusId></AuctionStatusId>Status id of auction : '0' for In Progress, '1' for Cancelled by User, '2' for Cancelled by Admin, '3' for Cancelled by Renewal, '4' for Complete, '5' for Cancelled by Transfer Away
<AuctionStatus></AuctionStatus>Statut d'enchère
<UserIsHighBid></UserIsHighBid>Si l'utilisateur a la proposition d'enchère la plus haute
<YourCurrentBid></YourCurrentBid>Votre proposition d'enchère actuelle pour l'enchère spécifiée. Si vous n'avez pas participé, renverra '-1'
<YourProxyBid></YourProxyBid>Votre enchère par procuration pour l'enchère spécifiée. Si vous n'avez pas placé d'enchère, renverra '-1'
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<IsPremium></IsPremium>Whether it is a premium domain
<RenewalPrice></RenewalPrice>Renewal price

Exemple Get Auction Details

Request (XML format)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response (JSON format)
{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}
 

Commande Place Auction Bid (Enchérir)

Appeler la commande place auction bid vous permet d'enchérir sur l'enchère spécifiée. Si cette commande est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Place Auction Bid
Explication
domainLe nom de domaine de l'enchère, l'IDN (Nom de Domaine Internationalisé) doit utiliser punycode, "xn--wkccg.com" par exemple
bid_amountLe montant de votre proposition pour cette enchère, la devise par défaut est le dollar US, vous pouvez aussi la spécifier avec le paramètre devise ci-dessous
currency (facultatif)La devise de votre proposition d'enchère, devrait être être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Balise de la réponse à place auction bid, c'est le nœud racine du document XML de réponse
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Entête de place auction bid
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Domaine

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
Requête (format CSV)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Réponse

ok,success

Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)
{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}
 

Commande Get Closed Auctions

Appeler la commande get closed auctions retournera une liste d'enchères closes pour le compte spécifié. Si la commande est appelée, les paramètres suivants doivent être inclus :

Paramètre de Requête Get Closed Auctions
Explication
startDateDate de début d'enchère, aaaa-mm-jj, comme 2015-05-30
endDateDate de fin d'enchère, aaaa-mm-jj, comme 2015-05-30
currency (facultatif)La devise de votre proposition d'enchère, devrait être être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Balise de la réponse à get closed auctions, c'est le nœud racine du document XML de réponse
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Entête de get closed auctions
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Balise du contenu de get closed auctions, seulement utilisée quand le statut est "success"
<Auction></Auction>Balise d'un article d'enchère, c'est seulement utilisé quand le statut est "success"
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<AuctionStatusId></AuctionStatusId>Id du statut de l'enchère, '0' pour En Cours, '1' pour Clos par Utilisateur, '2' pour Clos par Admin, '3' pour Clos par Renouvellement, '4' pour Clos par Temps Expiré, '5' pour Clos par Transfert
<AuctionStatus></AuctionStatus>Statut d'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère
<AuctionWonStatus></AuctionWonStatus>Si l'utilisateur a remporté cette enchère
<YourHighBid></YourHighBid>Votre enchère haute pour cette enchère
<YourProxyBid></YourProxyBid>Votre enchère par procuration pour cette enchère

Exemple Get Closed Auctions

Request (XML format)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Request (CSV format)

https://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (CSV format)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
Request (JSON format)

https://api.dynadot.com/api3.json?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)
{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}
 

Commande Get Open Backorder Auctions(Deprecated,please use get_open_auctions command)

Appeler la commande get open backorder auctions retournera une liste d'enchères en cours sur domaines en attente. Si cette commande est appelée, les paramètres suivants devraient être inclus :

Paramètres de la Requête Get Open Backorder Auctions
Explication
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Balise de la réponse à get open backorder auctions, c'est le nœud racine du document de réponse XML
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>En-tête de Get open backorder auctions
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Balise du contenu de get open backorder auctions, seulement utilisé quand le statut est "success"
<Auction></Auction>Balise d'un article d'enchère, c'est seulement utilisé quand le statut est "success"
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)

Exemple de Get Open Backorder Auctions

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_open_backorder_auctions&currency=usd

Response (XML format)
<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
Requête (format CSV)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions&currency=usd

Réponse

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

 

Commande Get Backorder Auction Details (Obtenir les informations d'enchère sur domaine en attente)

Calling the get backorder auction details command will return the details of auction specified. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Paramètre de Requête Get Auction Details
Explication
domainLe nom de domaine de l'enchère sur domaine en attente, IDN (Nom de Domaine Internationalisé) devrait utiliser punycode, tel que "xn--wkccg.com".
currency (facultatif)La devise des résultats renvoyés, devrait être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Balise de la réponse à get auction details, c'est le nœud racine du document XML de réponse
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Entête de get auction details
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Balise du contenu de get auction details, c'est seulement utilisé quand le statut est "success"
<AuctionStatusId></AuctionStatusId>Id du statut de l'enchère, '0' pour En Cours, '1' pour Clos par Utilisateur, '2' pour Clos par Admin, '3' pour Clos par Renouvellement, '4' pour Clos par Temps Expiré, '5' pour Clos par Transfert
<AuctionStatus></AuctionStatus>Statut d'enchère
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis le 1 janvier 1970 à minuit UTC)
<Revenue></Revenue>Revenu d'enchère
<RevenueCurrency></RevenueCurrency>Devise du revenu
<Visitors></Visitors>Visiteurs du domaine
<Links></Links>Liens entrants du domaine
<Age></Age>Age du domaine
<UserIsHighBid></UserIsHighBid>Si l'utilisateur a la proposition d'enchère la plus haute
<YourCurrentBid></YourCurrentBid>Votre proposition d'enchère actuelle pour l'enchère spécifiée. Si vous n'avez pas participé, renverra '-1'
<YourProxyBid></YourProxyBid>Votre enchère par procuration pour l'enchère spécifiée. Si vous n'avez pas placé d'enchère, renverra '-1'

Exemple de Get Backorder Auction Details

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_backorder_auction_details&domain=example.com&currency=usd

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_backorder_auction_details&domain=example.com&currency=usd

Response (JSON format)
{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}
 

Commande Place Backorder Auction Bid

Appeler la commande place backorder auction bid placera une enchère sur un domaine en attente spécifié. Si cette commande est appelée, les paramètres suivant devraient être inclus :

Paramètres de la Requête Place Backorder Auction Bid
Explication
domainLe nom de domaine de l'enchère, l'IDN (Nom de Domaine Internationalisé) doit utiliser punycode, "xn--wkccg.com" par exemple
bid_amountLe montant de votre proposition pour cette enchère, la devise par défaut est le dollar US, vous pouvez aussi la spécifier avec le paramètre devise ci-dessous
currency (facultatif)La devise de votre proposition d'enchère, devrait être être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Balise de la réponse à place auction bid, c'est le nœud racine du document XML de réponse
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Entête de place auction bid
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"

Exemple de Place Backorder Auction Bid

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Request (CSV format)

https://api.dynadot.com/api3.html?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (CSV format)
ok,success
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Get Closed Backorder Auctions

Appeler la commande get closed backorder auctions retournera une liste des enchères sur domaines en attente fermées, correspondant à un montant spécifié. Si cette commande est appelée, les paramètres suivant devraient être inclus :

Paramètres de la requête Get Closed Backorder Auctions
Explication
startDateDate de début d'enchère, aaaa-mm-jj, comme 2015-05-30
endDateDate de fin d'enchère, aaaa-mm-jj, comme 2015-05-30
currency (facultatif)La devise de votre proposition d'enchère, devrait être être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Balise de la réponse à get closed auctions, c'est le nœud racine du document XML de réponse
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Entête de get closed auctions
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Balise du contenu de get closed auctions, seulement utilisée quand le statut est "success"
<Auction></Auction>Balise d'un article d'enchère, c'est seulement utilisé quand le statut est "success"
<YourHighBid></YourHighBid>Votre enchère haute pour cette enchère
<YourProxyBid></YourProxyBid>Votre enchère par procuration pour cette enchère
<AuctionId></AuctionId>ID d'enchère
<Domain></Domain>Nom de domaine de l'enchère
<AuctionStatusId></AuctionStatusId>Id du statut de l'enchère, '0' pour En Cours, '1' pour Clos par Utilisateur, '2' pour Clos par Admin, '3' pour Clos par Renouvellement, '4' pour Clos par Temps Expiré, '5' pour Clos par Transfert
<AuctionStatus></AuctionStatus>Statut d'enchère
<BidPrice></BidPrice>Montant actuel proposé pour l'enchère
<BidPriceCurrency></BidPriceCurrency>Devise de l'enchère
<Bids></Bids>Nombre de propositions pour l'enchère

Get Closed Backorder Auctions Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
Request (CSV format)

https://api.dynadot.com/api3.html?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (CSV format)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
Request (JSON format)

https://api.dynadot.com/api3.json?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)
{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}
 

Commande Get Auction Bids

Calling the get auction bids command will get your bids list which you took part in. If calling this command, the following parameters should be included:

Get Auction Bids Request Parameter
Explication
currency (facultatif)La devise de votre proposition d'enchère, devrait être être "usd", "eur", ou "cny", la devise par défaut est le dollar US
Balise XML de résultat
Explication
<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag of get auction bids response, it's the root node of the response XML document
<GetAuctionBidsHeader></GetAuctionBidsHeader>Get auction bids header
<SuccessCode></SuccessCode>Si l'opération est réussie, "0" pour succès, "-1" pour échec
<Status></Status>Le statut de la requête
<Error></Error>Information d'erreur sur la requête, utilisée seulement quand le statut est "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Bid List
<Bid></Bid> Bid Item
<BidId></BidId> ID of bid
<AuctionId></AuctionId> ID of auction
<AccountId></AccountId>ID of account
<Domain></Domain>Nom de domaine de l'enchère
<DomainUtf></DomainUtf>Domain utf name of auction
<AuctionType></AuctionType>Type of auction
<IsIdn></IsIdn>If this domain is Internationalized Domain Name
<CurrentBid></CurrentBid>Current bid price for the auction
<YourStatus></YourStatus>Your bid status for the auction
<ProxyBid></ProxyBid>Your proxy bid price for the auction
<ActiveBidders></ActiveBidders>The amount of bidders who take part in this auction
<TimeLeft></TimeLeft>the left time for the auction
<EndTime></EndTime>The end time for the auction
<EndTimestamp></EndTimestamp>The end time stamp for the auction

Exemple de Get Auction Bids

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_auction_bids&currency=usd

Response (XML format)
<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_auction_bids&currency=usd

Response (JSON format)
{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}
 

Commande Is Processing

Appeler la commande is_processing vous dira si vous pouvez envoyer une nouvelle requête.

Paramètre de Requête Is-Processing
Explication
aucun paramètre supplémentaire n'est requis
Balise XML de résultat
Explication
<Response></Response>Balise de la réponse à is_processing
<RespnseHeader></RespnseHeader>Balise d'entête de is_processing
<ResponseMsg></ResponseMsg>Balise du message de réponse à is_processing. Devrait être "yes" (Il y a un processus dans le système. Vous ne devriez pas envoyer une autre requête.) ou "no" (Il n'y a pas de processus pour votre compte. Vous pouvez envoyer une nouvelle requête.)

Exemple Is-Processing

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=is_processing

Response (XML format)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Request (CSV format)

http://api.dynadot.com/api3.html?key=mykey&command=is_processing

Response (CSV format)
ok,yes
Request (JSON format)

http://api.dynadot.com/api3.html?key=mykey&command=is_processing

Response (JSON format)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
 

Get Expired Closeout Domains Command

Calling the Get Expired Closeout Domains Command will Get Expired Closeout Domains. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Get Expired Closeout Domains Request Parameter
Explication
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
domain(optional)Add this parameter if you want to query for a closeout domain
Balise XML de résultat
Explication
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag of Get Expired Closeout Domains response, it's the root node of the response XML document
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Get Expired Closeout Domains Header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>Le statut de la requête
<Error></Error>Error information about the request, only used when status is "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>CloseoutItem
<DomainName></DomainName>The domain name
<DomainNameUtf></DomainNameUtf>The domain name is in utf format
<CurrentPrice></CurrentPrice>current price
<isIdn></isIdn>Whether it is the idn domain name
<EndTimeStamp></EndTimeStamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)
<RenewalPrice></RenewalPrice>Renewal price
<ExpiredRevenue></ExpiredRevenue>Revenue of closeout
<EstibotAppraisal></EstibotAppraisal>EstibotAppraisal
<InboundLinks></InboundLinks>Liens entrants du domaine
<MonthlyVisitors></MonthlyVisitors>Visiteurs du domaine
<Currency></Currency>currency

Get Expired Closeout Domains Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd

Response (JSON format)
{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}
 

Buy Expired Closeout Domain Command

Calling the Buy Expired Closeout Domain Command will buy the specified domain name. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Buy Expired Closeout Domain Request Parameter
Explication
domainThe domain you want to buy, only 1 domain can be entered per request
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Balise XML de résultat
Explication
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag of Buy Expired Closeout Domain response, it's the root node of the response XML document
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Buy Expired Closeout Domain header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>Le statut de la requête
<Error></Error>Error information about the request, only used when status is "error"

Buy Expired Closeout Domain Example

Request (XML format)

http://127.0.0.1:8889/api3.xml?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Request (JSON format)

http://127.0.0.1:8889/api3.json?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph

Response (JSON format)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Get Order Status Command

Calling the Get Order Status Command will get order status. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Get Order Status Request Parameter
Explication
order_idThe id of the order to be queried
Balise XML de résultat
Explication
<GetOrderStatusResponse></GetOrderStatusResponse>the root node of the response
<GetOrderStatusHeader></GetOrderStatusHeader>Get Order Status header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>Le statut de la requête
<Error></Error>Error information about the request, only used when status is "error"
<GetOrderStatusContent></GetOrderStatusContent>response content
<OrderId></OrderId>order id
<OrderStatus></OrderStatus>order status( Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>item Type
<ItemName></ItemName>item Name
<ItemStatus></ItemStatus>Item Status(Completed, Cancelled, Problem)

Get Order Status Example

Request (XML format)

http://127.0.0.1:8889/api3.xml?key=0&command=get_ordedr_status&order_id=0

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>
Request (JSON format)

http://127.0.0.1:8889/api3.json?key=0&command=get_ordedr_status&order_id=0

Response (JSON format)
{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}
Are you sure you want to close the chat?Chat will be closed and the chat history will be cleared.
Sorry, can't receive informationPlease move your mouse to the dialog
Chat Online
Chat en ligne0
Dynadot
Domaines
Ressources
Sites Web
Suivre
Domaines de Premier Niveau
Domaines de Pays

Copyright © 2002-2023 Dynadot Inc. Tous droits réservés.