Would you like Dynadot in English ?YES

API Avançada de Domínios

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

Procurando mais recursos de nossa API de domínio? Se informe mais API de domínio avançado . Esta versão de nossa API permite que você use seu próprio software e servidores para fazer mais de 50 comandos, incluindo criar pastas, definir Whois, definir privacidade, definir encaminhamento de e-mail e muito mais! Nossa API de domínio avançado está disponível para todas as contas, então comece a usá-la hoje mesmo seguindo as instruções abaixo.

Procurando uma maneira mais simples de usar nossa API? Confira nossa página da API do domínio!

Começando com a nossa API Avançada de Domínios

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

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

Observe que as solicitações devem ser enviadas via https (soquete seguro) por segurança. Apenas 1 solicitação pode ser processada por vez, então aguarde a conclusão da solicitação atual antes de enviar outra. A solicitação deve ter os seguintes parâmetros:

Request Parameter
Explicação
KeySua chave para acessar a API, disponível no seu painel de controle.
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:

Tag do resultado em XML
Explicação
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
 

Comando de Pesquisa

Se chamar o comando de pesquisa, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Pesquisa
Explicação
domain0 - domain99O nome de domínio que você está procurando, conta comum pode especificar 1 domínio por comando, contas de Massa e super massa podem especificar até 100 domínios
language0 - language99 (opcional)O marcador de idioma do domínio respectivo, apenas para IDNs
show_price (opcional)Se quiser mostrar o preço na moeda da sua conta, defina como "1".
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
Tag do resultado em XML
Explicação
<Results></Results>O nó raiz da resposta XML do comando de pesquisa
<SearchResponse></SearchResponse>Tag da resposta de pesquisa
<SearchHeader></SearchHeader>Cabeçalho da tag de pesquisa
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<DomainName></DomainName>O nome de domínio que você acabou de pesquisar
<Available></Available>Se o nome de domínio estiver disponível
<Price></Price>Se você definir "show_price" como "1", isso mostrará as informações de preço se este domínio estiver disponível.
<Language></Language>Informações de idioma sobre o domínio

Exemplo de Pesquisa

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

Comando de Registro

Chamar o comando de registro irá criar e processar um pedido de registo. Você deve ter saldo suficiente na conta para pagar pela compra. Ao chamar o comando de registo, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Registro
Explicação
domainO nome de domínio que você deseja registrar, apenas 1 domínio pode ser registrado por solicitação
language (opcional)O marcador de idioma do domínio solicitado. Necessário apenas quando o domínio é um IDN
durationPor quanto tempo registrar o domínio.
registrant_contact (opcional)The registrant contact you want to use on the domain
admin_contact (opcional)The admin contact you want to use on the domain
technical_contact (opcional)The technical contact you want to use on the domain
billing_contact (opcional)The billing contact you want to use on the domain
option0 (se necessário)
O nome do registrante de .AT, .BE,
option1 (se necessário)The .AT, .BE, registrant organization (optional)
Para .AT, você pode especificar option0, option1, ou ambos
premium (opcional)Se você quiser registrar um domínio premium, defina como igual a "1" (opcional)
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
coupon (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<RegisterResponse></RegisterResponse>Tag da resposta de registro
<RegisterHeader></RegisterHeader>Cabeçalho da tag de registro
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<RegisterContent></RegisterContent>A tag do conteúdo de registro
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"
<Registration></Registration>Data de registro em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

Exemplo de Registro

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

Comando de Exclusão

Usar o comando delete excluirá um domínio que ainda está no período de tolerância. O saldo da sua conta será creditado de volta com a taxa de registro menos quaisquer taxas de exclusão. Os domínios que foram renovados ou que foram movidos para outra conta não podem ser excluídos por meio da API. Ao usar o comando delete, os seguintes parâmetros devem ser incluídos:

Parâmetro da Solicitação de Exclusão
Explicação
domainO nome de domínio que você deseja excluir, apenas 1 domínio pode ser excluído por solicitação
Tag do resultado em XML
Explicação
<DeleteResponse></DeleteResponse>Tag da resposta de exclusão
<DeleteHeader></DeleteHeader>Cabeçalho da tag de exclusão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão

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

Comando de Renovação

Fazer o comando de renovação irá criar e processar um pedido de renovação. Você deve ter saldo o suficiente em conta para pagar por um pedido. Se estiver pedindo o comando de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Renovação
Explicação
domainO nome de domínio que você deseja renovar, somente 1 domínio pode ser renovado por solicitação
durationPor quantos anos renovar o domínio
year (opcional)O ano atual no qual o domínio expira
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
price_check (opcional)Você pode adicionar este parâmetro para o comando para verificar os detalhes de preço para renovar este domínio. ATENÇÃO: Adicionar este parâmetro ao comando, nosso api não irá renovar o domínio, mas irá apenas apresentar as informações de preço.
coupon (opcional)O código de cupom que você quer aplicar a este comando
no_renew_if_late_renew_fee_needed (opcional)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.
Tag do resultado em XML
Explicação
<RenewResponse></RenewResponse>Marcador da resposta de renovação. É o nó raiz do documento de resposta XML
<RenewHeader></RenewHeader>Cabeçalho de renovação
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<PriceInfo></PriceInfo>Informação da etiqueta de preço, só é usada para quando o status do domínio é "price_check_success";
<RenewContent></RenewContent>Marcador de renovação de conteúdo, usado apenas quando o status é "success"
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

Exemplo de Renovação

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

Fazer o comando de push irá criar um processo de pedido de push. Você precisa desbloquear seu domínio e conta para pedir. A conta remetente precisa rejeitar/aceitar o domínio para completar o pedido. Ao fazer o comando de push, os seguintes parâmetros devem ser inclusos:

Parâmetros de Requerimento de Push
Explicação
domainO nome de domínio que você quer enviar. Nós também suportamos envios em massa, você pode usar ";" para separar domínios. Exemplo: domínio1.com;domínio2.com
receiver_push_usernamePush Username of receiver account
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
unlock_domain_for_push(optional)Defina este parâmetro igual a "1" se o domínio estiver bloqueado, nós o desbloquearemos automaticamente, para que você não tenha que debloquear o domínio manualmente
Tag do resultado em XML
Explicação
<PushResponse></PushResponse>Tag de resposta de push, é o nó raiz necessário para responder o documento XML
<PushHeader></PushHeader>Cabeçálio de Push
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exem´plo 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"
   }
}
 

Comando de Transferência

Pedir um comando de transferência irá criar e processar um pedido de transferência. Alguns tlds podem requerer que o registrante perdedor confirme para completar o pedido. Os seguintes parâmetros devem ser inclusos se estiver pedindo um comando de transferência.

Parâmetro do Pedido de Transferência
Explicação
domainO nome de domínio que você quer transferir para sua conta Dynadot, apenas 1 domínios podem ser transferidos por pedido.
authO código de autorização para o pedido de transferência.
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
registrant_contact (opcional)O contato de registrante que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
admin_contact (opcional)O contato admin que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
technical_contact (opcional)O contato técnico que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
billing_contact (opcional)O contato de cobrança que você quer usar quando a transferência estiver completa. N(Nem todos os tlds suportam esta característica)
coupon (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<TransferResponse></TransferResponse>Resposta de tag de transferência, é o root node do documento de resposta XML
<TransferHeader></TransferHeader>Cabeçalho da transferência
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Transferência

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
Explicação
domain0-domain99The domain name(s) you want to register, maximum 100 domains can be registered per request
premium (opcional)Se você quiser registrar um domínio premium, defina como igual a "1" (opcional)
currency (opcional)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 (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<BulkRegisterResponse></BulkRegisterResponse>Tag of bulk register response
<BulkRegisterHeader></BulkRegisterHeader>Tag of bulk register header
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<BulkRegisterContent></BulkRegisterContent>The tag of bulk register content
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "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"
      }
    ]
  }
}
 

Comando de Informações de Domínios

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Informações de Domínios
Explicação
domainApenas 1 domínio permitido por solicitação
Tag do resultado em XML
Explicação
<DomainInfoResponse></DomainInfoResponse>Nó raiz do documento de resposta XML
<DomainInfoResponseHeader></DomainInfoResponseHeader>Cabeçalho de resposta
<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<DomainInfoContent></DomainInfoContent>Conteúdo de resposta
<Domain></Domain>Domínio
<Name></Name>Nome do domínio
<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio
<Type></Type>Tipo de servidor de nomes do domínio
<WithAds></WithAds>Se você quiser uma página de estacionamento para o seu domínio
<Whois></Whois>Informações do Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações administrativas
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status habilitado
<UdrpLocked></UdrpLocked>UDRP bloqueado ou não
<UdrpLocked></UdrpLocked>UDRP bloqueado ou não
<RegistrantUnverified></RegistrantUnverified>Registrante não verificado
<Hold></Hold>Retido
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status da venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Notas
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da Pasta
<FolderName></FolderName>Nome da pasta

Exemplo de Informações de Domínio

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

Comando de Definição de Whois

Ao chamar o comando de configuração de Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Whois
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
Tag do resultado em XML
Explicação
<SetWhoisResponse></SetWhoisResponse>Nó raiz do documento de resposta XML
<SetWhoisHeader></SetWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de 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"
   }
}
 

Comando de Definição de Servidores de Nomes

Ao chamar o comando de definição de servidores de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Servidores de Nomes
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
ns0 - ns12Os servidores de nome definidos para uso do seu domínio. Você pode especificar até 13 servidores de nome, mas eles já devem estar na sua conta
Tag do resultado em XML
Explicação
<SetNsResponse></SetNsResponse>Marcador da resposta de definição de servidor de nomes. É o nó raiz do documento de resposta XML
<SetNsHeader></SetNsHeader>Cabeçalho de resposta de definição de servidor de nomes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Servidor de Nomes

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

Comando de Definição de Estacionamento

Ao chamar o comando de definição de estacionamento, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Estacionamento
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetParkingResponse></SetParkingResponse>Marcador da resposta de definição de estacionamento. É o nó raiz do documento de resposta XML
<SetParkingHeader></SetParkingHeader>Cabeçalho de definição de pasta de estacionamento
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Estacionamento

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

Comando de Definição de Redirecionamento

Ao chamar o comando de definição de redirecionamento, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetForwardingResponse></SetForwardingResponse>Nó raiz do documento de resposta XML
<SetForwardingHeader></SetForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento

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

Comando de Definição de Secretividade

Ao chamar o comando de definição de secretividade, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Secretividade
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
Tag do resultado em XML
Explicação
<SetStealthResponse></SetStealthResponse>Nó raiz do documento de resposta XML
<SetStealthHeader></SetStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Secretividade

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

Comando de Definição de Hospedagem

Ao chamar o comando de definição de hospedagem, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Hospedagem
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
hosting_typeTipo de hospedagem que você deseja. Você pode selecionar "advanced" e "basic"
mobile_view_onSomente quando hosting_type é "advanced", você pode usar esse parâmetro como "yes"
Tag do resultado em XML
Explicação
<SetHostingResponse></SetHostingResponse>Nó raiz do documento de resposta XML
<SetHostingHeader></SetHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Hospedagem

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

Comando de Definição de DNS

Ao chamar o comando de definição de DNS, os seguintes parâmetros devem ser incluídos:

( Este comando está desatualizado e não pode ser recomendado, use o comando de Configurar DNS2 em vez disso )

Parâmetro de Solicitação de Definição de DNS
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
main_record_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_txt1 - main_txt4 (opcional)Especifica registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.
main_record2Registro principal 2, usado somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
mx_host0 - mx_host4 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.
mx_distance0 - mx_distance4 (opcional)Distance0 é de prioridade mais alta
ttl (opcional)Tempo de existência
add_dns_to_current_setting (opcional)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Tag do resultado em XML
Explicação
<SetDnsResponse></SetDnsResponse>Nó raiz do documento de resposta XML
<SetDnsHeader></SetDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de 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"
  }
}
 

Definir comando DNS2

Ao fazer um comando DNS2, os seguintes parâmetros devem ser inclusos:

Atenção: Usar o comando DNS2 irá sobrescrever a configuração DNS atual.

Parâmetro de definição de solicitação de DNS2
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
main_record_type0 - main_record_type19Tipo de registro principal, deve ser "a", "aaaa", "cname", ""forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância Mx, tipo de envio(301 como "1", 302 como "2"), título de envio oculto ou alias de e-mail quando o tipo_de_registro_p´rincial é "forward", "mx", "oculto", "e-mail".
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99O tipo de subdomínio deve ser "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"
sub_record0 - sub_record99Endereço IP do subdomínio ou host de destino
sub_recordx0 - sub_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"
ttl (opcional)Tempo de existência
add_dns_to_current_setting (opcional)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Tag do resultado em XML
Explicação
<SetDnsResponse></SetDnsResponse>Nó raiz do documento de resposta XML
<SetDnsHeader></SetDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo de 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"
  }
}
 

Comando de Definição de Redirecionamento de E-mails

Ao chamar o comando de definição de redirecionamento de e-mails, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento de E-mails
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
Tag do resultado em XML
Explicação
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetEmailForwardingHeader></SetEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de E-mails

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

Comando de Definição de Limpeza de Configurações de Domínio

Ao chamar o comando de configuração da limpeza de domínios, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Limpeza de Configurações de Domínio
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nó raiz do documento de resposta XML
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Configuração de Limpeza de Domínios

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

Comando de Definição de Pasta

Ao chamar o comando de definição de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta
Explicação
domainO nome de domínio a ser atualizado, apenas 1 domínio pode ser definido por solicitação
folderO nome da pasta para a qual deseja mover o seu domínio. Use "Default" como o nome da pasta, se você quiser mover o domínio para a pasta padrão. O nome da pasta diferencia maiúsculas de minúsculas. Por exemplo, "Folder1" e "folder1" são dois nomes de pastas diferentes.
folder_id (opcional)A ID da pasta para a qual deseja mover o seu domínio
Tag do resultado em XML
Explicação
<SetFolderResponse></SetFolderResponse>Marcador da resposta de definição de pasta. É o nó raiz do documento de resposta XML
<SetFolderHeader></SetFolderHeader>Cabeçalho de definição de pasta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta

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

Opções de Renovação

Ao chamar o comando de definição das opções de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição das Opções de Renovação
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
renew_optionPode ser "donot", "auto", "reset"
Tag do resultado em XML
Explicação
<SetRenewOptionResponse></SetRenewOptionResponse>Nó raiz do documento de resposta XML
<SetRenewOptionHeader></SetRenewOptionHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição das Opções de Renovação

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

Comando de Definição de Nota

Ao chamar o comando de definição de notas, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Nota
Explicação
domainO domínio que você deseja definir, apenas 1 domínio pode ser definido por solicitação
noteNota que você deseja definir para o domínio. Pode ser nula.
Tag do resultado em XML
Explicação
<SetNoteResponse></SetNoteResponse>Nó raiz do documento de resposta XML
<SetNoteHeader></SetNoteHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Notas

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
Explicação
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
Tag do resultado em XML
Explicação
<SetCustomerIdResponse></SetCustomerIdResponse>Nó raiz do documento de resposta XML
<SetCustomerIdHeader></SetCustomerIdHeader>Cabeçalho de resposta
<SetCustomerIdContent></SetCustomerIdContent>Conteúdo de resposta
<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>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
            }
        ]
    }
}
 

Comando de Definição de Privacidade

Ao chamar o comando de definição de privacidade, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Privacidade
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
optionO status de privacidade do domínio que deseja definir. Pode ser "full", "partial", ou "off"
Tag do resultado em XML
Explicação
<SetPrivacyResponse></SetPrivacyResponse>Nó raiz do documento de resposta XML
<SetPrivacyHeader></SetPrivacyHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Privacidade

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

Preços de TLD

This feature is only available in XML and JSON format:

Pedido de Parâmetros de Preços Tld
Explicação
currency (opcional)A moeda de resultado de retorno, deve ser "usd", "eur", ou "cny", a moeda padrão é a MOeda Padrão Api das definições da conta.
Tag do resultado em XML
Explicação
<TldPriceResponse></TldPriceResponse>Nó raiz do documento de resposta XML
<TldPriceResponseHeader></TldPriceResponseHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<TldPriceContent></TldPriceContent>Conteúdo de resposta
<TldContent></TldContent>Informações de Tld
<Tld></Tld>Domínios de Topo
<Usage></Usage>Uso de tld
<Price></Price>Price info of this tld. Contain sub-tags: : Unit of price : Price of Registration : Price of Renew : Price of Transfer
<Privacy></Privacy>Se este tld suporta privacidade
<GracePeriod></GracePeriod>Grace period info of this tld. Contain sub-tags: : Unit of grace period info : Renew grace period : Delete grace period
<IDN></IDN>Se este tld suporta Nomes de Domínios Internacionalizados
<Restrictions></Restrictions>Nome do domínio

Exmplo de Preços 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": "--"
      }
    ]
  }
}
 

Comando de Listagem dos Domínios

This feature is only available in XML and JSON format:

Parâmetro de Solicitação de Listagem de Domínios
Explicação
customer_id (opcional)Filter data by customer id (only resellers can use this parameter)
Tag do resultado em XML
Explicação
<ListDomainInfoResponse></ListDomainInfoResponse>Nó raiz do documento de resposta XML
<ListDomainInfoHeader></ListDomainInfoHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<ListDomainInfoContent></ListDomainInfoContent>Conteúdo de resposta
<DomainInfoList></DomainInfoList>Lista de informações dos domínios
<DomainInfo></DomainInfo>Informações do domínio
<Domain></Domain>Domínio
<Name></Name>Nome do domínio
<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)
<NameServerSettings></NameServerSettings>Configurações de servidores de nomes
<Type></Type>Tipo de configuração de servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<Whois></Whois>Informações do Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações administrativas
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status habilitado
<Hold></Hold>Retido
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status da venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Notas
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da Pasta
<FolderName></FolderName>Nome da pasta

Exemplo de Listagem de Domínios

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)"
        }
      }
    ]
  }
}
 

Comando de Criação de Contatos

Ao chamar o comando de criação de contatos, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Criação de Contato
Explicação
organization (opcional)Informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de telefone do país
faxnum (opcional)Número de fax
faxcc (opcional)Código de fax do país
address1Endereço 1
address2 (opcional)Endereço 2
cityCidade
state (opcional)Estado
zipCEP
countryPaís
Tag do resultado em XML
Explicação
<CreateContactResponse></CreateContactResponse>Nó raiz do documento de resposta XML
<CreateContactHeader></CreateContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<CreateContactContent></CreateContactContent>New Contact ID, only used when status is "success"

Exemplo de Criação de Contatos

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

Comando de Edição de Contato

Ao chamar o comando de edição de contatos, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Edição de Contato
Explicação
contact_idID do contato que deseja editar
organization (opcional)Informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de telefone do país
faxnum (opcional)Número de fax
faxcc (opcional)Código de fax do país
address1Endereço 1
address2 (opcional)Endereço 2
cityCidade
stateEstado
zipCEP
countryPaís
Tag do resultado em XML
Explicação
<EditContactResponse></EditContactResponse>Nó raiz do documento de resposta XML
<EditContactHeader></EditContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<EditContactContent></EditContactContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato
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]om&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
Explicação
contact_idID do contato que deseja editar
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
Tag do resultado em XML
Explicação
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nó raiz do documento de resposta XML
<SetContactEUSettingHeader></SetContactEUSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato

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
Explicação
contact_idID do contato que deseja editar
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 (opcional)VAT number for foreign legal entities registered within European Union countries (this includes also Latvian companies)
Tag do resultado em XML
Explicação
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nó raiz do documento de resposta XML
<SetContactLvSettingHeader></SetContactLvSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato

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

Comando de Exclusão de Contatos

Ao chamar o comando de exclusão de contatos, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Contatos
Explicação
contact_idAs IDs dos contatos que você deseja excluir, certifique-se de que estejam separadas por vírgulas
Tag do resultado em XML
Explicação
<DeleteContactResponse></DeleteContactResponse>Nó raiz do documento de resposta XML
<DeleteContactHeader></DeleteContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Contatos

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

Comando de Listagem dos Contatos

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Listagem de Contatos
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<ContactListResponse></ContactListResponse>Nó raiz do documento de resposta XML
<ContactListHeader></ContactListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<ContactListContent></ContactListContent>Conteúdo de resposta
<ContactList></ContactList>Lista de contatos
<Contact></Contact>Informações de contato
<ContactId></ContactId>ID de Contato
<Organization></Organization>Organização do contato
<Name></Name>Nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de telefone do país
<PhoneNum></PhoneNum>Número de telefone
<FaxCc></FaxCc>Código de fax do país
<FaxNum></FaxNum>Número de fax
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>CEP
<Country></Country>País
<GtldVerified></GtldVerified>status de verificação do gTLD

Exemplo de Lista de Contatos

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

Parâmetro de Obtenção de Contato

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Obtenção de Contato
Explicação
contact_idid do contato
Tag do resultado em XML
Explicação
<GetContactResponse></GetContactResponse>Nó raiz do documento de resposta XML
<GetContactHeader></GetContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetContactContent></GetContactContent>Conteúdo de resposta
<Contact></Contact>Informações de contato
<ContactId></ContactId>ID de Contato
<Organization></Organization>Organização do contato
<Name></Name>Nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de telefone do país
<PhoneNum></PhoneNum>Número de telefone
<FaxCc></FaxCc>Código de fax do país
<FaxNum></FaxNum>Número de fax
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>CEP
<Country></Country>País
<GtldVerified></GtldVerified>status de verificação do gTLD

Exemplo de Obtenção de Contatos

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

Receber Comando de Nome de Servidor

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

Receber Parâmetro de Pedido de Nome de Servidor
Explicação
domainO domínio cujas informações de servidor de nome se deseja obter, apenas as informações de servidor de nomes de 1 domínio podem ser recebidas por solicitação.
Tag do resultado em XML
Explicação
<GetNsResponse></GetNsResponse>Nó raiz do documento de resposta XML
<GetNsHeader></GetNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<NsContent></NsContent>Conteúdo de resposta
<Host></Host>Nome de Hospedagem do servidor
<NsName></NsName>Nome do servidor

Receber Exemplos de Nomes de Servidores

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

Comando de Adição de Servidor de Nomes

Ao chamar o comando de adicionar servidor de nomes, os seguintes parâmetros devem ser incluídos:

Adicionar Parâmetro de Solicitação de Servidor de Nomes
Explicação
hostO nome da hospedagem do servidor de nomes que você deseja adicionar
Tag do resultado em XML
Explicação
<AddNsResponse></AddNsResponse>Nó raiz do documento de resposta XML
<AddNsHeader></AddNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AddNsContent></AddNsContent>Conteúdo de resposta
<Server></Server>O servidor que você definiu
<Host></Host>Nome de hospedagem do novo servidor
<ServerId></ServerId>ID do novo servidor

Exemplo de Adição de Servidor de Nomes

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

Comando de Registro de Servidor de Nomes

Ao chamar o comando de registro de servidor de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Registro de Servidor de Nomes
Explicação
hostO nome do host do seu próprio servidor de nomes
ipO endereço IP do seu próprio servidor de nomes
Tag do resultado em XML
Explicação
<RegisterNsResponse></RegisterNsResponse>Nó raiz do documento de resposta XML
<RegisterNsHeader></RegisterNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<RegisterNsContent></RegisterNsContent>Conteúdo de resposta
<Server></Server>Tag do servidor
<Host></Host>Nome da hospedagem
<ServerId></ServerId>ID do servidor

Exemplo de Registro de Servidor de Nomes

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

Comando de Definição de IP de Servidor de Nomes

Ao chamar o comando de configuração de IP de um servidor de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de IP de Servidor de Nomes
Explicação
server_idA ID do servidor de nomes que você deseja definir
ip0 - ip9O endereço IP que você deseja definir para o servidor de nomes. 9 IPs podem ser definidos por solicitação e devem ser separados por vírgulas
Tag do resultado em XML
Explicação
<SetNsIpResponse></SetNsIpResponse>Nó raiz do documento de resposta XML
<SetNsIpHeader></SetNsIpHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de IP de Servidores de Nomes

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

Comando de Exclusão de Servidor de Nomes

Se chamar o comando de exclusão de servidores de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Servidor de Nomes
Explicação
server_idA ID dos servidores de nomes que você deseja excluir, certifique-se de separá-las com vírgulas
Tag do resultado em XML
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento de resposta XML
<DeleteNsHeader></DeleteNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Servidor de Nomes

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

Comando de Apagamento de Nome de Servidor pelo Domínio

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

Parâmetro de Apagamento de Nome de Domínio Por Pedido de Domínio
Explicação
server_domainNome do nome servidor name. ex.: ns1.testnameserver.com
Tag do resultado em XML
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento de resposta XML
<DeleteNsHeader></DeleteNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Apagamento de Nome de Domínio

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

Comando de Listagem de Servidores

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Listagem de Servidores
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<ServerListResponse></ServerListResponse>Nó raiz do documento de resposta XML
<ServerListHeader></ServerListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<ServerListContent></ServerListContent>Conteúdo de resposta
<NameServerList></NameServerList>Lista de servidores de nome
<List></List>
<Server></Server>
<ServerId></ServerId>ID do servidor
<ServerName></ServerName>Name do servidor
<ServerIp></ServerIp>IP do servidor

Exemplo de Listagem de Servidores

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
Explicação
domainThe domain whose name server setting you want to get, only 1 domain's name server setting can be pulled per request.
Tag do resultado em XML
Explicação
<GetDnsResponse></GetDnsResponse>Nó raiz do documento de resposta XML
<GetDnsHeader></GetDnsHeader>Cabeçalho de resposta
<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetDnsContent></GetDnsContent>Conteúdo de resposta
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio
<Type></Type>Tipo de servidor de nomes do domínio

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

Comando Para o Código de Transferência Auth

Você precisa desbloquear seu domino e conta antes de pedir o código de autenticação.

Receba um Parâmetro para o Pedido de Auth Code
Explicação
domainO nome de domínio para o qual você quer um código de autenticação de transferência, apenas domínios 1 podem ser inseridos por pedido.
new_code (optional)Gerar novo auth code de transferência.
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Se você quer desbloquear domínios para transferência, defina igual a "1". Se o pedido for processado com sucesso, o domínio será desbloqueado.
Tag do resultado em XML
Explicação
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>O root node do documento XML de respostaXML.
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AuthCode></AuthCode>O Auth Code é usado para começar uma transferência de domínio.

Exemplo de Recebimento de Auth Code de Transferência

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
Explicação
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)
Tag do resultado em XML
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetTransferStatusContent></GetTransferStatusContent>Conteúdo de resposta
<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
Explicação
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.
Tag do resultado em XML
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
Explicação
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.
Tag do resultado em XML
Explicação
<CancelTransferResponse></CancelTransferResponse>O root node do documento XML de respostaXML.
<CancelTransferHeader></CancelTransferHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
Explicação
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".
Tag do resultado em XML
Explicação
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>O root node do documento XML de respostaXML.
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
Explicação
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
Tag do resultado em XML
Explicação
<CreateCnAuditResponse></CreateCnAuditResponse>Nó raiz do documento de resposta XML
<CreateCnAuditHeader></CreateCnAuditHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
Explicação
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
Tag do resultado em XML
Explicação
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>O root node do documento XML de respostaXML.
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<GetAccountBalanceResponse></GetAccountBalanceResponse>O root node do documento XML de respostaXML.
<GetAccountBalanceHeader></GetAccountBalanceHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Conteúdo de resposta
<Balance></Balance>Saldo da Conta

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

Receber Comandos de Listagens

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

Receber Parâmetros de Pedidos de LIstagem
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
exclude_pending_sale (opcional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
Tag do resultado em XML
Explicação
<GetListingsResponse></GetListingsResponse>O root node do documento XML de respostaXML.
<GetListingsHeader></GetListingsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetListingsContent></GetListingsContent>Conteúdo da listagem
<Listing></Listing>Conteúdo da listagem de itens
<ListingId></ListingId>Id da Listagem
<Domain></Domain>Nome do domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links vinculados
<Age></Age>Idade
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Receber Exemplos de LIstagens

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

Pedir os Comandos de Listagem de Itens

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

Get Listing Item Request Parameter
Explicação
domainThe domain name you want to get detail, only 1 domain can be entered per request
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetListingItemResponse></GetListingItemResponse>O root node do documento XML de respostaXML.
<GetListingItemHeader></GetListingItemHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetListingsItemContent></GetListingsItemContent>Conteúdo da listagem
<Listing></Listing>Conteúdo da listagem de itens
<ListingId></ListingId>Id da Listagem
<Domain></Domain>Nome do domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links vinculados
<Age></Age>Idade

Receba um Exemplo de Listagem de 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"
    }
  }
}
 

Comando de Compra Instantânea

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

Parâmetros de Pedido de Compra INstantânea
Explicação
domainThe domain you want to buy, only 1 domain can be entered per request
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<BuyItNowResponse></BuyItNowResponse>O root node do documento XML de respostaXML.
<BuyItNowHeader></BuyItNowHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<Message></Message>It should be "domain order created", only used when status is "success".

Exemplo de Compra Instantânea

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

Comando de Informações da Conta

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Informações da Conta
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<AccountInfoResponse></AccountInfoResponse>Nó raiz do documento de resposta XML
<AccountInfoHeader></AccountInfoHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AccountInfoContent></AccountInfoContent>Conteúdo de resposta
<AccountInfo></AccountInfo>Informações da conta
<Username></Username>Usuário
<ForumName></ForumName>Nome do fórum
<Contact></Contact>Informações de contato
<Organization></Organization>Empresa
<Organization></Organization>Cabeçalho de resposta
<Name></Name>Seu nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de telefone do país
<PhoneNum></PhoneNum>Número de telefone
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>CEP
<Country></Country>País
<CustomerSince></CustomerSince>Cliente desde
<AccountLock></AccountLock>Bloqueio de conta
<TotalSpending></TotalSpending>Total de gasto
<PriceLevel></PriceLevel>Nível de preço
<AccountBalance></AccountBalance>Saldo da conta
<CustomTimeZone></CustomTimeZone>Fuso horário personalizado
<DefaultSettings></DefaultSettings>Configurações padrão
<DefaultWhois></DefaultWhois>Whois Padrão
<DefaultRegistrant></DefaultRegistrant>Registrante padrão
<ContactId></ContactId>ID de Contato
<DefaultAdmin></DefaultAdmin>Administrador padrão
<DefaultTechnical></DefaultTechnical>Técnico padrão
<DefaultBilling></DefaultBilling>Cobrança padrão
<Type></Type>Tipo de servidor de nomes
<WithAds></WithAds>Com anúncios ou não

Exemplo de Informações da Conta

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

Definição Padrão de Whois

Ao chamar o comando de configuração de Whois padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Whois Padrão
Explicação
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
Tag do resultado em XML
Explicação
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nó raiz do documento de resposta XML
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Whois Padrão

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

Comando de Definição de Servidores de Nomes Padrão

Ao chamar o comando de configuração dos servidores de nomes padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Servidores de Nomes Padrão
Explicação
ns0 - ns12Os servidores de nomes que você deseja definir
Tag do resultado em XML
Explicação
<SetDefaultNsResponse></SetDefaultNsResponse>Marcador da resposta de definição de servidores de nomes padrão. É o nó raiz do documento de resposta XML
<SetDefaultNsHeader></SetDefaultNsHeader>Cabeçalho de definição de servidor de nomes padrão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetDefaultNsContent></SetDefaultNsContent>Marcador de definição de conteúdo padrão dos servidores de nomes, usado apenas quando o status é "success"
<Servers></Servers>As informações dos servidores que você configurou
<Server></Server>Cada servidor
<ServerName></ServerName>Name do servidor
<ServerId></ServerId>ID do servidor

Exemplo de Definição de Servidores de Nomes Padrão

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":""
            }
         ]
      }
   }
}
 

Comando de Definição de Estacionamento Padrão

Ao chamar o comando de definição de estacionamento padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Estacionamento Padrão
Explicação
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no",, cujo valor padrão é "yes"
Tag do resultado em XML
Explicação
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nó raiz do documento de resposta XML
<SetDefaultParkingHeader></SetDefaultParkingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Estacionamento Padrão

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

Comando de Definição de Redirecionamento Padrão

Ao chamar o comando de definição de redirecionamento padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento Padrão
Explicação
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nó raiz do documento de resposta XML
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento Padrão

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

Comando de Definição de Secretividade Padrão

Ao chamar o comando de definição de secretividade padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Secretividade Padrão
Explicação
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
Tag do resultado em XML
Explicação
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nó raiz do documento de resposta XML
<SetDefaultStealthHeader></SetDefaultStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo padrão de ocultação

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

Comando de Definição de Hospedagem Padrão

Ao chamar o comando de definição de hospedagem padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Hospedagem Padrão
Explicação
hosting_typeTipo da hospedagem padrão que você deseja. Você pode selecionar "advanced" e "basic"
Tag do resultado em XML
Explicação
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nó raiz do documento de resposta XML
<SetDefaultHostingHeader></SetDefaultHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Hospedagem Padrão

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

Comando de Definição de DNS Padrão

Ao chamar o comando de definição de DNS, os seguintes parâmetros devem ser incluídos:

( Este comando está desatualizado e não é recomendado, use o comando Definir DNS2 Padrão em vez disso )

Parâmetro de Solicitação de Definição de DNS Padrão
Explicação
main_record_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_txt (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.
main_record2Registro principal 2, usado somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta
ttl (opcional)Tempo de existência
Tag do resultado em XML
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento de resposta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de DNS Padrão

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

Comando de definição do DNS2 padrão

Ao chamar o comando de definição de DNS, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de DNS2 padrão
Explicação
main_record_type0 - main_record_type19Tipo principal de registro
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias do e-mail, necessário quando o registro_principal é "a", "aaaa", "cname", "encaminhamento", "txt", "mx", "privado", "e-mail"
subdomain0 - subdomain99 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP do subdomínio ou host de destino
sub_recordx0 - subdo_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado título ou alias de e-mail, necessário quando o sub_registro for "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"
ttl (opcional)Tempo de existência
Tag do resultado em XML
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento de resposta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de definição do DNS2 padrão

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

Comando de Definição de Redirecionamento Padrão de E-mails

Ao chamar o comando de definição de redirecionamento de e-mails padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento de E-mails Padrão
Explicação
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
Tag do resultado em XML
Explicação
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de E-mails Padrão

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

Comando de Definição de Configuração de Limpeza Padrão

Ao chamar o comando de definir configurações de limpeza padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Limpeza de Configurações Padrão
Explicação
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nó raiz do documento de resposta XML
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Configuração de Limpeza Padrão

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

Comando de Definição das Opções de Renovação Padrão

Ao chamar o comando de definição das opções de renovação padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição das Opções de Renovação Padrão
Explicação
renew_optionPode ser "donot", "auto", "reset"
Tag do resultado em XML
Explicação
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nó raiz do documento de resposta XML
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição das Opções de Renovação Padrão

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

Comando de Criação de Pastas

Ao chamar o comando de criação de pastas, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Criação de Pastas
Explicação
folder_nameNome da pasta que você deseja criar
Tag do resultado em XML
Explicação
<FolderCreateResponse></FolderCreateResponse>Nó raiz do documento de resposta XML
<FolderCreateHeader></FolderCreateHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<FolderCreateContent></FolderCreateContent>Conteúdo de resposta
<FolderName></FolderName>nome da pasta
<FolderId></FolderId>ID da nova pasta

Exemplo de Criação de Pastas

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

Comando de exclusão de pasta

Ao chamar o comando de configuração de Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de exclusão de pasta
Explicação
folder_idO ID das pastas que você quiser deletar, assegure-se de que eles estão separados por vírgulas
Tag do resultado em XML
Explicação
<DeleteFolderResponse></DeleteFolderResponse>Nó raiz do documento de resposta XML
<DeleteFolderHeader></DeleteFolderHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de exclusão de pasta

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

Comando de definição de pasta Whois

Se chamar o comando de definição de pasta de Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta de Whois
Explicação
folder_idA ID da pasta que deseja configurar
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
enable (opcional)Se quiser aplicar estas configurações de Whois aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar estas configurações de Whois com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nó raiz do documento de resposta XML
<SetFolderWhoisHeader></SetFolderWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pastas de 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"
   }
}
 

Comando de Definição de Pasta de Servidores de Nomes

Se chamar o comando de definição de pasta de servidores de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta de Servidores de Nomes
Explicação
fold_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
ns0 - ns12Os servidores de nome definidos para uso do seu domínio. Você pode especificar até 13 servidores de nome, mas eles já devem estar na sua conta
enable (opcional)Se quiser aplicar estas configurações de servidores de nomes aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de definição de servidor de nomes com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderNsResponse></SetFolderNsResponse>Marcador da resposta de definição de pasta de servidor de nomes. É o nó raiz do documento de resposta XML
<SetFolderNsHeader></SetFolderNsHeader>Cabeçalho de resposta de definição de pasta de servidor de nomes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetFolderNsContent></SetFolderNsContent>Marcador de definição de conteúdo de resposta da pasta de servidores de nomes, usado apenas quando o status é "success"
<Servers></Servers>As informações dos servidores que você configurou
<Server></Server>Cada servidor
<ServerName></ServerName>Name do servidor
<ServerId></ServerId>ID do servidor

Exemplo de Definição de Servidores de Nomes

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":""
            }
         ]
      }
   }
}
 

Comando de Definição de Pasta de Estacionamento

Ao chamar o comando de definição de estacionamento de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pastas de Estacionamento
Explicação
folder_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no",, cujo valor padrão é "yes"
enable (opcional)Se quiser aplicar estas configurações de estacionamento aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de estacionamento de todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderParkingResponse></SetFolderParkingResponse>Nó raiz do documento de resposta XML
<SetFolderParkingHeader></SetFolderParkingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Estacionamento

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

Comando de Definição de Redirecionamento de Pastas

Ao chamar o comando de definição de redirecionamento de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento de Pastas
Explicação
folder_idA ID da pasta que deseja configurar
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
enable (opcional)Se quiser aplicar estas configurações de redirecionamento aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de redirecionamento com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nó raiz do documento de resposta XML
<SetFolderForwardingHeader></SetFolderForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de Pastas

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

Comando de Definição de Secretividade de Pastas

Ao chamar o comando de definição de secretividade de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta com Secretividade
Explicação
folder_idA ID da pasta que você deseja configurar
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
enable (opcional)Se quiser aplicar estas configurações aos futuros domínios que mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de redirecionamento secreto com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderStealthResponse></SetFolderStealthResponse>Nó raiz do documento de resposta XML
<SetFolderStealthHeader></SetFolderStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Secretividade de Pastas

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

Comando de Definição de Pasta de Hospedagem

Ao chamar o comando de definição de da pasta de hospedagem, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta de Hospedagem
Explicação
folder_idA ID da pasta que deseja configurar
hosting_typeTipo de hospedagem que você deseja. Você pode selecionar "advanced" e "basic"
enable (opcional)Se quiser aplicar estas configurações de hospedagem aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
even (opcional)Se quiser sincronizar as configurações de hospedagem com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderHostingResponse></SetFolderHostingResponse>Nó raiz do documento de resposta XML
<SetFolderHostingHeader></SetFolderHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Hospedagem

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

Comando de Definição de Pasta de DNS

Ao chamar o comando de definição de pasta de DNS, os seguintes parâmetros devem ser incluídos:

( Este comando está desatualizado e não é recomendado, use o Comando Configurar DNS2 da Pasta em vez disso )

Definir Parâmetro de Solicitação de Pasta de DNS
Explicação
folder_idA ID da pasta que você deseja definir
main_record_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_recordEspecifica um registro DNS para o seu domínio
with_ads (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.
main_record2Registro principal 2, usado somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta
ttl (opcional)Tempo de existência
enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento de resposta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de 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"
   }
}
 

Definir comando da pasta DNS2

Ao fazer o comando de determinada pasta DNS2, os seguintes parâmetros devem ser inclusos:

Parâmetro de definição de solicitação de pasta DNS2
Explicação
folder_idA ID da pasta que você deseja definir
main_record_type0 - main_record_type19Tipo de registro principal, deve ser "a", "aaaa", "cname", ""forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Os registros de subdomínio devem ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
sub_recordx0 - sub_recordx99 (opcional)Distância Mx, tipo de encaminhamento, encaminhamento privado ou alias do e-mail, necessário quando o tipo_desub_registro for "encaminhamento","mx","privado","e-mail"
ttl (opcional)Tempo de existência
enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento de resposta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo de pasta 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"
   }
}
 

Comando de Definição de Pasta para Redirecionamento de E-mails

Ao chamar o comando de definição de pasta de redirecionamento de e-mails, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta para Redirecionamento de E-mails
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
folder_idID da pasta que você deseja definir
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
enable (opcional)Se quiser aplicar estas configurações aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar estas configurações com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Redirecionamento de E-mails

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

Comando de Solicitação de Definição de Configuração de Limpeza de Pasta

Ao chamar o comando de configuração de limpeza de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Configuração de Limpeza de Pasta
Explicação
folder_idA ID da pasta que deseja configurar
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nó raiz do documento de resposta XML
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Configuração de Limpeza de Pastas

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

Comando de Definição do Nome de Pastas

Ao chamar o comando de definição do nome das pastas, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Nomes de Pastas
Explicação
folder_idID da pasta que você deseja configurar
folder_nameNome da nova pasta
Tag do resultado em XML
Explicação
<SetFolderNameResponse></SetFolderNameResponse>Nó raiz do documento de resposta XML
<SetFolderNameHeader></SetFolderNameHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Nomes de Pastas

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

Comando de Definição da Pasta de Opções de Renovação

Ao chamar o comando de definição de pasta das opções de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição da Pasta de Opões de Renovação
Explicação
folder_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
renew_optionThe renew option you want to set to the folder; it can be "donot", "auto" or "reset"
enable (opcional)Se quiser aplicar estas configurações de renovação aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de renovação com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<Response></Response>Nó raiz do documento de resposta XML
<ResponseHeader></ResponseHeader>Cabeçalho de Resposta
<ResponseCode></ResponseCode>Código de resposta: "0" em caso de sucesso, "-1" se houver falhado
<Error></Error>Informação de erro, usado somente quando o código de resposta for "-1"

Exemplo de Definição das Pastas de Opções de Renovação

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

Comando de Listagem de Pastas

This command is only available in XML and JSON format:

Parâmetro de Solicitação de Listagem de Pastas
Explicação
N/ANenhum parâmetro extra é necessário
<FolderListResponse></FolderListResponse>Nó raiz do documento de resposta XML
<FolderListHeader></FolderListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<FolderListContent></FolderListContent>Conteúdo de resposta
<FolderList></FolderList>Lista de pastas
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID da Pasta
<FolderName></FolderName>Nome da pasta
<DefaultWhois></DefaultWhois>Whois Padrão
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Status de habilitação do Whois padrão
<DefaultRegistrant></DefaultRegistrant>Registrante padrão
<ContactId></ContactId>ID do Contato
<DefaultAdmin></DefaultAdmin>Administrador padrão
<DefaultTechnical></DefaultTechnical>Informações técnicas padrão
<DefaultBilling></DefaultBilling>Informações de cobrança padrão
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Status habilitado de servidor de nomes padrão
<NameServerSettings></NameServerSettings>Configurações de servidores de nomes
<Type></Type>Tipo de servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<DefaultRenewOption></DefaultRenewOption>Opção padrão de renovação
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Status de habilitação padrão das opções de renovação
<RenewOption></RenewOption>Opção de renovação
<DefaultTransferLock></DefaultTransferLock>Bloqueio de transferências padrão
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Status de habilitação padrão do bloqueio de transferências
<LockStatus></LockStatus>Status de bloqueio

Exemplo de Listagem de Pastas

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

Comando de Adição de Solicitação de Domínios Pendentes

Ao chamar o comando de adição de solicitação de domínios pendentes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Adição de Solicitação de Domínios Pendentes
Explicação
domainO(s) domínio(s) que você deseja adicionar e comprar caso o Dynadot o(s) obtenha. 100 podem ser adicionados por solicitação e devem ser separados por vírgulas.
Tag do resultado em XML
Explicação
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nó raiz do documento de resposta XML
<AddBackorderRequestHeader></AddBackorderRequestHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Adição de Solicitação de Domínios Pendentes

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

Comando de Exclusão da Solicitação de Domínios Pendentes

Ao chamar o comando de exclusão de solicitação de domínios pendentes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Solicitação de Domínios Pendentes
Explicação
domainO(s) domínio(s) que você deseja remover da sua lista de solicitação de domínios pendentes. 100 domínios podem ser removidos por solicitação e devem ser separados por vírgulas
Tag do resultado em XML
Explicação
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nó raiz do documento de resposta XML
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Solicitação de Domínios Pendentes

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

Comando de Listagem de Solicitação de Domínios Pendentes

Chamar o comando de solicitação de lista de domínios pendentes retornará uma lista de domínios pendentes da conta especificada. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Lista de Solicitação de Domínios Pendentes
Explicação
startDateData de início do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25
Tag do resultado em XML
Explicação
<BackorderRequestListResponse></BackorderRequestListResponse>Nó raiz do documento de resposta XML
<BackorderRequestListHeader></BackorderRequestListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<BackorderRequestListContent></BackorderRequestListContent>Conteúdo de resposta
<BackorderRequestList></BackorderRequestList>Lista de Solicitação de Domínios Pendentes
<BackorderRequest></BackorderRequest>Solicitação de domínios pendentes
<Domain></Domain>Domínios na sua lista
<CutoffTime></CutoffTime>Data limite para excluir uma solicitação em tempo Unix (milissegundos desde a meia-noite UTC de 1 janeiro de 1970)
<BackorderRequestStatus></BackorderRequestStatus>Status do processo de obtenção de domínios pendentes

Exemplo de Listagem de Solicitações de Domínios Pendentes

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

Comando de Obtenção de Leilões Abertos

Chamar o comando de obtenção de leilões abertos retornará uma lista de leilões que estão em andamento. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Obtenção de Leilões Abertos
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
type (opcional)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
Tag do resultado em XML
Explicação
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Marcador da resposta de obtenção de leilões abertos. É o nó raiz do documento de resposta XML
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Cabeçalho de leilões abertos
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Marcador de obtenção de conteúdo de leilões abertos, usado apenas quando o status é "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita de leilão
<RevenueCurrency></RevenueCurrency>Moeda da receita
<Visitors></Visitors>Visitantes do domínio
<Links></Links>Links de entrada do domínio
<Age></Age>Idade do domínio

Exemplo de Obtenção de Leilões Abertos

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>
Solicitação (formato csv)

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

Resposta

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": "-"
        }
        ...
    ]
}
 

Comando de Obtenção de Detalhes do Leilão

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:

Parâmetro de Solicitação de Obtenção de Detalhes de Leilão
Explicação
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 (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Marcador da resposta de obtenção de detalhes de leilão. É o nó raiz do documento de resposta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho das informações do leilão de domínios pendentes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Marcador de obtenção de detalhes do conteúdo de leilão, usado somente quando o status for "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>Status do leilão
<UserIsHighBid></UserIsHighBid>Se o usuário deu o maior lance
<YourCurrentBid></YourCurrentBid>Seu preço atual de lance para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<YourProxyBid></YourProxyBid>Seu lance automático para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<IsPremium></IsPremium>Whether it is a premium domain
<RenewalPrice></RenewalPrice>Renewal price

Exemplo de Obtenção de Detalhes de Leilão

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": []
    }
  ]
}
 

Comando de Colocação de Lance no Leilão

Chamar o comando de lance em leilão colocará um lance no leilão especificado. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Colocação de Lance em Leilão
Explicação
domainO nome de domínio de leilão e o IDN (Nome de Domínio Internacionalizado) devem usar um punycode como "xn--wkccg.com"
bid_amountO valor do seu lance para leilão. A moeda padrão é o Dólar Americano. Você pode especificar isso no parâmetro de moeda abaixo
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Marcador de resposta de colocação de lance no leilão, é o nó raiz do documento XML de resposta
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Coloca cabeçalho de lance no leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de domínio

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>
Solicitação (formato csv)

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

Resposta

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
            }
            ...        ]
    }
}
 

Comando de Obtenção de Leilões Encerrados

Chamar o comando de obtenção de leilões encerrados retornará uma lista de leilões encerrados da conta especificada. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Obtenção de Leilões Encerrados
Explicação
startDateData de início do leilão, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão, aaaa-mm-dd, como 2015-05-25
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Marcador da resposta de obtenção de leilões encerrados. É o nó raiz do documento de resposta XML
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Cabeçalho de obtenção de leilões encerrados
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Marcador de obtenção de detalhes do conteúdo de leilão encerrado, usado somente quando o status for "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<AuctionStatusId></AuctionStatusId>Id de status do leilão: '0' para em andamento, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<AuctionWonStatus></AuctionWonStatus>Se o usuário venceu este leilão
<YourHighBid></YourHighBid>Seu lance mais alto neste leilão
<YourProxyBid></YourProxyBid>Seu lance automático para este leilão

Exemplo de Obtenção de Leilões Encerrados

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

Comando para obtenção de leilões abertos de domínios pendentes(Deprecated,please use get_open_auctions command)

Chamar o comando de obtenção de leilões abertos de domínios pendentes retorna uma lista de leilões de domínios pendentes que estão em progresso. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obtenção de leilões abertos de domínios pendentes
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Tag para obtenção de resposta dos leilões abertos de domínios pendentes, é o nó raiz do documento XML de resposta
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Cabeçalho de obtenção de leilão aberto de domínios pendentes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag para obtenção de conteúdo dos leilões abertos de domínios pendentes, só é usado quando o status é "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

Exemplo de obtenção de leilões abertos de domínios pendentes

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>
Solicitação (formato csv)

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

Resposta

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
.
.
.

 

Comando para obter as informações do leilão de domínios pendentes

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:

Parâmetro de Solicitação de Obtenção de Detalhes de Leilão
Explicação
domainO nome de domínio do leilão de domínios pendentes, IDN (Nome de domínio internacionalizado) deve usar punycode, como "xn--wkccg.com"
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Marcador da resposta de obtenção de detalhes de leilão. É o nó raiz do documento de resposta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho de obtenção de detalhes do leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Marcador de obtenção de detalhes do conteúdo de leilão, usado somente quando o status for "success"
<AuctionStatusId></AuctionStatusId>Id de status do leilão: '0' para em andamento, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<AuctionStatus></AuctionStatus>Status do leilão
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita de leilão
<RevenueCurrency></RevenueCurrency>Moeda da receita
<Visitors></Visitors>Visitantes do domínio
<Links></Links>Links de entrada do domínio
<Age></Age>Idade do domínio
<UserIsHighBid></UserIsHighBid>Se o usuário deu o maior lance
<YourCurrentBid></YourCurrentBid>Seu preço atual de lance para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<YourProxyBid></YourProxyBid>Seu lance automático para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'

Exemplo de informações do leilão de domínios pendentes

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

Comando para colocação de lance no leilão de domínios pendentes

Chamar o comando de lance no leilão de domínios pendentes coloca um lance em leilão específico. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de lance no leilão de domínios pendentes
Explicação
domainO nome de domínio de leilão e o IDN (Nome de Domínio Internacionalizado) devem usar um punycode como "xn--wkccg.com"
bid_amountO valor do seu lance para leilão. A moeda padrão é o Dólar Americano. Você pode especificar isso no parâmetro de moeda abaixo
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Marcador de resposta de colocação de lance no leilão, é o nó raiz do documento XML de resposta
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Coloca cabeçalho de lance no leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de lance no leilão de domínios pendentes

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

Comando de obtenção de leilão fechado de domínios pendentes

Chamar o comando de obtenção de leilões fechados de domínios pendentes retorna uma lista de leilões fechados específicos para uma conta. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro para obter as solicitações do leilão encerrado de domínios pendentes
Explicação
startDateData de início do leilão, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão, aaaa-mm-dd, como 2015-05-25
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Marcador da resposta de obtenção de leilões encerrados. É o nó raiz do documento de resposta XML
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Cabeçalho de obtenção de leilões encerrados
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Marcador de obtenção de detalhes do conteúdo de leilão encerrado, usado somente quando o status for "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<YourHighBid></YourHighBid>Seu lance mais alto neste leilão
<YourProxyBid></YourProxyBid>Seu lance automático para este leilão
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<AuctionStatusId></AuctionStatusId>Id de status do leilão: '0' para em andamento, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão

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

Comando para obter lances do leilão

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
Explicação
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<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>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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>Nome de Domínio do leilão
<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

Exemplo de obtenção de lances do leilão

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
        }
        ...
    ]
}
 

Comando de em processamento (is processing)

Chamar o comando is_processing lhe dirá se é seguro enviar uma nova solicitação

Parâmetro de Solicitação de em Processamento
Explicação
nenhum parâmetro adicional é necessário
Tag do resultado em XML
Explicação
<Response></Response>Marcador de resposta de is_processing
<RespnseHeader></RespnseHeader>Cabeçalho de is_processing
<ResponseMsg></ResponseMsg>Marcador da mensagem de resposta de is_processing. Deve ser "sim" (há um processo no sistema, você não deve enviar outra solicitação) ou "não" (não há nenhum processo na sua conta, é seguro enviar uma nova solicitação).

Exemplo de em Processamento

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
Explicação
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
Tag do resultado em XML
Explicação
<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>Status da solicitação
<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>Links de entrada do domínio
<MonthlyVisitors></MonthlyVisitors>Visitantes do domínio
<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
Explicação
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
Tag do resultado em XML
Explicação
<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>Status da solicitação
<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
Explicação
order_idThe id of the order to be queried
Tag do resultado em XML
Explicação
<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>Status da solicitação
<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 Online0
Dynadot
Domínios
Recursos
Sites
Seguir
Domínios de Topo
Domínios Internacionalizados

Copyright © 2002-2023 Dynadot Inc. Todos os direitos reservados.