Расширенный API управления доменами

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

Вам нужно больше возможностей от API для доменов? Попробуйте наш расширенный API для доменов. Эта версия API позволяет вам использовать ваше собственное программное обеспечение и серверы для выполнения более 50 команд, включая создание папок, изменение Whois, установка уровня конфиденциальности, перенаправления эл. почты и многое другое! Наш расширенный API для доменов доступен для всех учетных записей, так что воспользуйтесь им сегодня с помощью инструкций ниже.

Ищите более простой способ использования API? Посмотрите нашу страницу API для доменов!

Начало работы с расширенным API для доменов

Запросы к нашему расширенному API для доменов выполняются к следующему URL-адресу:

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

Обратите внимание, что в целях безопасности запросы должны отправляться через https (защищенное соединение). В каждый момент времени может быть обработан только 1 запрос, поэтому прежде чем посылать новый запрос, подождите пока завершится текущий. Запрос должен включать в себя следующие параметры:

Параметр запроса
Пояснение
KeyВаш ключ доступа к API, его можно найти в контрольной панели учетной записи.

Расширенный API возвращает результаты в формате XML. Запрос должен включать 2 или 3 из следующих полей:

Имя тега XML
Пояснение
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
 

Команда поиска search

При вызове команды search, должны быть включены следующие параметры:

Параметр поискового запроса
Пояснение
domain0 - domain99Имя домена, которое вы ищете. Обычная учетная запись может указывать 1 домен для каждой команды, оптовая и супероптовая учетная запись может указывать до 100 доменов
language0 - language99 (необязательно)Метка языка для соответствующего домена, используется только для IDN
show_price (необязательно)Если вы хотите показать цену в валюте вашего аккаунта, установите значение «1».
currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию
XML-тег результата
Пояснение
<Results></Results>Корневой узел XML-запроса команды поиска
<SearchResponse></SearchResponse>Тег ответа поиска
<SearchHeader></SearchHeader>Тег заголовка поиска
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<DomainName></DomainName>Доменное имя, которое вы искали
<Available></Available>Доступно ли доменное имя
<Price></Price>Если вы установите для «show_price» значение «1», вам будет предоставлена информация о цене (если домен доступен).
<Language></Language>Информация о языке для доменного имени

Пример поиска

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>
 

Команда регистрации register

Вызов команды register создаст и обработает заявку на регистрацию. У вас должно быть достаточно средств на счету учетной записи, чтобы оплатить заказ. При вызове команды register должны быть включены следующие параметры:

Параметр запроса на регистрацию
Пояснение
domainДоменное имя, которое вы хотите зарегистрировать, максимум 1 за запрос.
language (необязательно)Метка языка для запрашиваемого домена, нужна только для доменов IDN
durationНа какой срок зарегистрировать домен
option0 (при необходимости)Название или организация регистратора зоны .UK
Имя регистранта .AT, .BE, .LT, или .PH
option1 (при необходимости)Организация регистратора зон .AT, .BE, .LT, или .PH (при необходимости)
Для .AT можно указать option0, option1, или и то, и другое
option2 (при необходимости)Код организации .LT
premium (необязательно)Если вы хотите зарегистрировать премиум-домен, установите для этого параметра значение «1» (необязательно)
currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию
coupon (необязательно)Код купона, который вы хотите применить к этой команде.
XML-тег результата
Пояснение
<RegisterResponse></RegisterResponse>Тег ответа регистрации
<RegisterHeader></RegisterHeader>Тег заголовка регистрации
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<RegisterContent></RegisterContent>Тег содержимого регистрации
<Expiration></Expiration>Дата истечения в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года), используется только при результате "success"
<Registration></Registration>Дата регистрации в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года), используется только при результате "success"

Пример регистрации

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>
 

Команда удаления delete

Вызов команды delete удаляет домен, для которого не истек льготный период. На ваш счет будет зачислена полная стоимость регистрации. Домены, которые были продлены или перенесены в другую учетную запись, нельзя удалить с помощью API. При вызове команды delete необходимо указать следующие параметры:

Параметр запроса на удаление
Пояснение
domainДоменное имя, которое вы хотите удалить, количество доменов, которое можно удалить за один запрос: 1
XML-тег результата
Пояснение
<DeleteResponse></DeleteResponse>Тег ответа удаления
<DeleteHeader></DeleteHeader>Тег заголовка удаления
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления

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>
 

Команда продления renew

Вызов команды renew создает и выполняет заказ на продление. На счету учетной записи должно быть достаточно средств для оплаты заказа. При вызове команды renew необходимо указать следующие параметры:

Параметр запроса на продление
Пояснение
domainДомен, который вы хотите продлить, только 1 домен может быть продлен за один запрос
durationНа сколько лет вы хотите продлить домен
year (необязательно)Текущий год окончания регистрации домена
currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию
price_check (необязательно)Вы можете добавить данный параметр в команду, чтобы проверить информацию о цене на продление этого домена. ПРИМЕЧАНИЕ. Если вы добавите этот параметр в команду, наш API не будет обновлять домен, а только отобразит информацию о цене.
coupon (необязательно)Код купона, который вы хотите применить к этой команде.
XML-тег результата
Пояснение
<RenewResponse></RenewResponse>Тег ответа продления, это корневой узел XML-документа ответа
<RenewHeader></RenewHeader>Заголовок продления
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<PriceInfo></PriceInfo>Тег информации о цене, используется только при статусе "price_check_success"
<RenewContent></RenewContent>Тег содержимого продления, используется только при статусе "success"
<Expiration></Expiration>Дата истечения в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года), используется только при результате "success"

Пример продления

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>
 

Push Command

Вызов команды push создаст и обработает заказ на передачу домена. Вы должны разблокировать свой домен и учетную запись для заказа. Аккаунт получателя должен отклонить/принять домен для выполнения заказа. При вызове команды push должны быть включены следующие параметры:

Параметр запроса на передачу
Пояснение
domainДоменное имя, которое вы хотите передать. Мы также поддерживаем массовую передачу (push), вы можете использовать ";" для разделения доменов. Пример: domain1.com;domain2.com
receiver_forum_nameИмя на форуме учетной записи получателя (отличается от имени пользователя)
currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию
unlock_domain_for_push(optional)Установите для этого параметра значение «1». Если домен заблокирован, мы автоматически разблокируем его, поэтому вам не нужно вручную разблокировать его
XML-тег результата
Пояснение
<PushResponse></PushResponse>Тег ответа операции push, это корневой узел XML-документа ответа
<PushHeader></PushHeader>Заголовок передачи
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример передачи (push)

Request (XML format)

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

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

Transfer Command

Вызов команды переноса создает и выполняет заказ на перенос. Некоторые TLD могут потребовать от отдающего регистратора подтверждения для выполнения заказа. При вызове команды переноса, необходимо указать следующие параметры:

Параметр запроса на перенос
Пояснение
domainДоменное имя, которое вы хотите перенести в Dynadot, за запрос может быть перенесен только 1 домен
authКод авторизации для запроса на перенос.
currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию
registrant_contact (необязательно)The registrant contact that you want to use when transfer completed. (Not all tld supports this feature)
admin_contact (необязательно)The admin contact that you want to use when transfer completed. (Not all tld supports this feature)
technical_contact (необязательно)The technical contact that you want to use when transfer completed. (Not all tld supports this feature)
billing_contact (необязательно)The billing contact that you want to use when transfer completed. (Not all tld supports this feature)
coupon (необязательно)Код купона, который вы хотите применить к этой команде.
XML-тег результата
Пояснение
<TransferResponse></TransferResponse>Тег ответа операции переноса, это корневой узел XML-документа ответа
<TransferHeader></TransferHeader>Заголовок переноса
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример переноса

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>
 

Команда получения информации о домене

Эта команда доступна только в формате XML:

Параметр запроса информации о домене
Пояснение
domainМаксимальное количество доменов в одном запросе: 1
XML-тег результата
Пояснение
<DomainInfoResponse></DomainInfoResponse>Корневой узел XML-документа ответа
<DomainInfoResponseHeader></DomainInfoResponseHeader>Заголовок ответа
<ResponseCode></ResponseCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<DomainInfoContent></DomainInfoContent>Содержимое ответа
<Domain></Domain>Домен
<Name></Name>Доменное имя
<Expiration></Expiration>Дата истечения регистрации домена в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)
<Registration></Registration>Дата регистрации домена по времени Unix (миллисекунды с полуночи по UTC января 1, 1970)
<NameServerSettings></NameServerSettings>Настройки сервера доменного имени
<Type></Type>Тип сервера доменного имени
<WithAds></WithAds>Если вам нужна парковочная страница для домена
<Whois></Whois>Информация Whois
<Registrant></Registrant>Информация о регистраторе
<ContactId></ContactId>Идентификатор контакта
<Admin></Admin>Информация об администраторе
<Technical></Technical>Техническая информация
<Billing></Billing>Информация о счетах (биллинг)
<Locked></Locked>Заблокирован или нет
<Disabled></Disabled>Статус "включено/выключено"
<UdrpLocked></UdrpLocked>Установлена ли блокировка UDRP
<UdrpLocked></UdrpLocked>Установлена ли блокировка UDRP
<RegistrantUnverified></RegistrantUnverified>Непроверенное регистрирующее лицо
<Hold></Hold>Удержание
<Privacy></Privacy>Статус скрытия личных данных
<isForSale></isForSale>Статус "для продажи"
<RenewOption></RenewOption>Настройка продления
<Note></Note>Заметки
<Folder></Folder>Информация о папке
<FolderId></FolderId>Идентификатор папки
<FolderName></FolderName>Название папки

Пример получения информации о домене

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>
 

Команда установки данных Whois

При вызове команды установки данных Whois должны быть указаны следующие параметры:

Параметр запроса установки данных Whois
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
registrant_contactИнформация регистрирующего лица
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactБиллинговая информация домена
XML-тег результата
Пояснение
<SetWhoisResponse></SetWhoisResponse>Корневой узел XML-документа ответа
<SetWhoisHeader></SetWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки данных 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>
 

Команда установки серверов имен

При вызове команды установки серверов имен должны быть указаны следующие параметры:

Параметр запроса установки серверов имен
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
ns0 - ns12Сервера имен, которые вы хотите установить для домена. Максимальное количество серверов имен, которое можно указать: 13, но они должны быть предварительно внесены в вашу учетную запись.
XML-тег результата
Пояснение
<SetNsResponse></SetNsResponse>Тег ответа установленного сервера имен, это корневой узел XML-документа ответа
<SetNsHeader></SetNsHeader>Тег заголовка ответа установленного сервера имен
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки сервера имен

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>
 

Команда установки парковки

При вызове команды установки парковки должны быть указаны следующие параметры:

Параметр запроса установки парковки
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
with_ads (необязательно)Если вы не хотите рекламы от сторонних поставщиков, укажите в этом параметре "no"
XML-тег результата
Пояснение
<SetParkingResponse></SetParkingResponse>Тег ответа установки парковки, это корневой узел XML-документа ответа
<SetParkingHeader></SetParkingHeader>Тег заголовка ответа установки парковки
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки парковки

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>
 

Команда установки перенаправления

При вызове команды установки перенаправления должны быть указаны следующие параметры:

Параметр запроса установки перенаправления
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
forward_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
is_temp (необязательно)Статус перенаправления для домена, по умолчанию (временный) "temporary", если вы хотите установить постоянное перенаправление, укажите в этом параметре "no"
XML-тег результата
Пояснение
<SetForwardingResponse></SetForwardingResponse>Корневой узел XML-документа ответа
<SetForwardingHeader></SetForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления

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>
 

Установка скрытого перенаправления (stealth)

При вызове команды установки скрытого перенаправления должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправления
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
stealth_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
stealth_title (необязательно)Заголовок страницы
XML-тег результата
Пояснение
<SetStealthResponse></SetStealthResponse>Корневой узел XML-документа ответа
<SetStealthHeader></SetStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки скрытого перенаправления

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>
 

Команда установки хостинга

При вызове команды установки хостинга должны быть указаны следующие параметры:

Параметр запроса установки хостинга
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
hosting_typeТип желаемого хостинга, можно выбрать "advanced" или "basic"
mobile_view_onЕсли в hosting_type выбрано "advanced",, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetHostingResponse></SetHostingResponse>Корневой узел XML-документа ответа
<SetHostingHeader></SetHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки хостинга

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>
 

Команда установки DNS

При вызове команды установки DNS должны быть указаны следующие параметры:

(Эта команда устарела, вместо нее рекомендуется использовать команду Set DNS2)

Параметр запроса установки DNS
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
main_record_typeТип главной записи
main_recordУкажите запись DNS для вашего домена
main_txt1 - main_txt4 (необязательно)Укажите записи TXT для вашего домена. Если основной тип записи (main_record_type) AAAA, и указана основная запись 2 (main_record2), вы можете настроить до 3 основных текстовых (main_txt) записей, в других случаях — до 4.
main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Ее значение должно быть в формате IPv4.
subdomain0 - subdomain20 (необязательно)Subdomain records (необязательно)
sub_record_type0 - sub_record_type20 (необязательно)Тип записей поддомена
sub_record0 - sub_record20 (необязательно)Целевой IP-адрес или URL
mx_host0 - mx_host2 (необязательно)Укажите адрес почтового узла для домена, distance0 — высший приоритет
mx_distance0 - mx_distance2 (необязательно)Distance0 — высший приоритет
ttl (необязательно)Время жизни (time to live)
XML-тег результата
Пояснение
<SetDnsResponse></SetDnsResponse>Корневой узел XML-документа ответа
<SetDnsHeader></SetDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки 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)
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
 

Команда Set DNS2

При вызове команды set DNS2 необходимо указать следующие параметры:

Обратите внимание, что вызов команды set DNS2 переопределит текущий параметр DNS.

Параметры запроса Set DNS2
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
main_record_type0 - main_record_type19Тип основной записи должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»
main_record0 - main_record19Укажите запись DNS для вашего домена
main_recordx0 - main_recordx19Приоритет MX, тип переадресации («1» для 301, «2» для 302), заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email».
subdomain0 - subdomain49 (необязательно)Subdomain records (необязательно)
sub_record_type0 - sub_record_type49Тип записи поддомена должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»
sub_record0 - sub_record49IP-адрес или узел назначения поддомена
sub_recordx0 - sub_recordx49Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email»
ttl (необязательно)Время жизни (time to live)
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример использования команды Set DNS2

Request (XML format)

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

Response (XML format)
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
 

Команда установки перенаправления Email

При вызове команды установки перенаправления Email должны быть указаны следующие параметры:

Параметр запроса установки перенаправления Email
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
forward_typeТип перенаправления, варианты: "donot": не перенаправлять, "mx": направлять электронную почту на другой почтовый узел (запись MX), "forward": направлять электронную почту на другой почтовый узел
username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"
exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"
mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"
mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"
XML-тег результата
Пояснение
<SetEmailForwardingResponse></SetEmailForwardingResponse>Корневой узел XML-документа ответа
<SetEmailForwardingHeader></SetEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления Email

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>
 

Команда сброса параметра для домена

При вызове команды сброса значения для домена должны быть указаны следующие параметры:

Параметр запроса сброса значения для домена
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
serviceСлужба, которую вы хотите стереть, может быть «forward», «stealth», «email_forwarding», «dns» и «nameservers»
XML-тег результата
Пояснение
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Корневой узел XML-документа ответа
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример сброса значения для домена

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>
 

Команда установки папки

При вызове команды установки папки должны быть указаны следующие параметры:

Параметр запроса установки папки
Пояснение
domainДомен, параметры которого вы хотите обновить, за один запрос может быть обновлена информация только для 1 сервера.
folderНазвание папки, в которую вы хотите переместить ваш домен. Укажите "Default" в качестве названия папки, если хотите переместить домен в папку по умолчанию. Название папки чувствительно к регистру. Например "Folder1" и "folder1" — две разных папки.
folder_id (необязательно)Идентификатор папки, в которую вы хотите переместить ваш домен
XML-тег результата
Пояснение
<SetFolderResponse></SetFolderResponse>Тег ответа операции установки папки, это корневой узел XML-документа ответа
<SetFolderHeader></SetFolderHeader>Заголовок установки бесплатного хостинга
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки папки

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>
 

Установка параметра продления

При вызове команды установки продления должны быть указаны следующие параметры:

Параметр запроса установки продления
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
renew_optionМожет быть указано "donot", "auto", "reset"
XML-тег результата
Пояснение
<SetRenewOptionResponse></SetRenewOptionResponse>Корневой узел XML-документа ответа
<SetRenewOptionHeader></SetRenewOptionHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки продления

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>
 

Команда установки заметки

При вызове команды установки заметки должны быть указаны следующие параметры:

Параметр запроса установки заметки
Пояснение
domainДомен, для которого вы хотите установить заметку, только 1 домен может быть установлен за один запрос
noteЗаметка, которую вы хотите установить для домена, может иметь значение null
XML-тег результата
Пояснение
<SetNoteResponse></SetNoteResponse>Корневой узел XML-документа ответа
<SetNoteHeader></SetNoteHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки заметки

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>
 

Команда установки скрытия данных

При вызове команды установки скрытия данных должны быть указаны следующие параметры:

Параметр запроса установки скрытия данных
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
optionСтатус скрытия данных, который вы хотите установить для домена, может быть "full", "partial", или "off"
XML-тег результата
Пояснение
<SetPrivacyResponse></SetPrivacyResponse>Корневой узел XML-документа ответа
<SetPrivacyHeader></SetPrivacyHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки скрытия данных

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>
 

Цены на TLD

Эта команда доступна только в формате XML:

Параметр запроса цен Tld
Пояснение
currency (необязательно)Валюта возвращаемого результата, должна быть "usd", "eur", или "cny", валюта по умолчанию - это валюта по умолчанию для Api в настройках учетной записи.
XML-тег результата
Пояснение
<TldPriceResponse></TldPriceResponse>Корневой узел XML-документа ответа
<TldPriceResponseHeader></TldPriceResponseHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<TldPriceContent></TldPriceContent>Содержимое ответа
<TldContent></TldContent>Информация о Tld
<Tld></Tld>Домены верхнего уровня
<Usage></Usage>Использование 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>Если этот TLD поддерживает конфиденциальность whois
<GracePeriod></GracePeriod>Grace period info of this tld. Contain sub-tags: : Unit of grace period info : Renew grace period : Delete grace period
<IDN></IDN>Если этот tld поддерживает интернационализированные доменные имена
<Restrictions></Restrictions>Доменное имя

Пример запроса цен на 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>
 

Команда списка доменов

Эта команда доступна только в формате XML:

Параметр запроса списка доменов
Пояснение
N/AДополнительных параметров не требуется
XML-тег результата
Пояснение
<ListDomainInfoResponse></ListDomainInfoResponse>Корневой узел XML-документа ответа
<ListDomainInfoHeader></ListDomainInfoHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<ListDomainInfoContent></ListDomainInfoContent>Содержимое ответа
<DomainInfoList></DomainInfoList>Список информации о доменах
<DomainInfo></DomainInfo>Информация о домене
<Domain></Domain>Домен
<Name></Name>Доменное имя
<Expiration></Expiration>Дата истечения регистрации домена в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)
<Registration></Registration>Дата регистрации домена по времени Unix (миллисекунды с полуночи по UTC января 1, 1970)
<NameServerSettings></NameServerSettings>Значение сервера имен
<Type></Type>Тип значения сервера имен
<WithAds></WithAds>С рекламой или без нее
<Whois></Whois>Информация Whois
<Registrant></Registrant>Информация о регистраторе
<ContactId></ContactId>Идентификатор контакта
<Admin></Admin>Информация об администраторе
<Technical></Technical>Техническая информация
<Billing></Billing>Информация о счетах (биллинг)
<Locked></Locked>Заблокирован или нет
<Disabled></Disabled>Статус "включено/выключено"
<Hold></Hold>Удержание
<Privacy></Privacy>Статус скрытия личных данных
<isForSale></isForSale>Статус "для продажи"
<RenewOption></RenewOption>Настройка продления
<Note></Note>Заметки
<Folder></Folder>Информация о папке
<FolderId></FolderId>Идентификатор папки
<FolderName></FolderName>Название папки

Пример получения списка доменов

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>
 

Команда создания контакта

При вызове команды создания контакта должны быть указаны следующие параметры:

Параметр запроса создания контакта
Пояснение
organization (необязательно)Информация об организации
nameИмя
emailПочта
phonenumНомер телефона
phoneccТелефонный код страны
faxnum (необязательно)Номер факса
faxcc (необязательно)Код страны для факса
address1Адрес1
address2 (необязательно)Адрес 2
cityГород
state (необязательно)Регион
zipПочтовый индекс
countryСтрана
XML-тег результата
Пояснение
<CreateContactResponse></CreateContactResponse>Корневой узел XML-документа ответа
<CreateContactHeader></CreateContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<CreateContactContent></CreateContactContent>New Contact ID, only used when status is "success"

Пример создания контакта

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>
 

Команда редактирования контакта

При вызове команды редактирования контакта должны быть указаны следующие параметры:

Параметр запроса редактирования контакта
Пояснение
contact_idИдентификатор контакта, который вы хотите редактировать
organization (необязательно)Информация об организации
nameИмя
emailПочта
phonenumНомер телефона
phoneccТелефонный код страны
faxnum (необязательно)Номер факса
faxcc (необязательно)Код страны для факса
address1Адрес 1
address2 (необязательно)Адрес 2
cityГород
stateРегион
zipПочтовый индекс
countryСтрана
XML-тег результата
Пояснение
<EditContactResponse></EditContactResponse>Корневой узел XML-документа ответа
<EditContactHeader></EditContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<EditContactContent></EditContactContent>Содержимое ответа
<ContactId></ContactId>Идентификатор контакта
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)
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
 

Команда удаления контакта

При вызове команды удаления контакта должны быть указаны следующие параметры:

Параметр запроса удаления контакта
Пояснение
contact_idИдентификатор контакта, который вы хотите удалить, они должны разделяться запятыми
XML-тег результата
Пояснение
<DeleteContactResponse></DeleteContactResponse>Корневой узел XML-документа ответа
<DeleteContactHeader></DeleteContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления контакта

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>
 

Команда получения списка контактов

Эта команда доступна только в формате XML:

Параметр запроса списка контактов
Пояснение
N/AДополнительных параметров не требуется
XML-тег результата
Пояснение
<ContactListResponse></ContactListResponse>Корневой узел XML-документа ответа
<ContactListHeader></ContactListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<ContactListContent></ContactListContent>Содержимое ответа
<ContactList></ContactList>Список контактов
<Contact></Contact>Информация контакта
<ContactId></ContactId>Идентификатор контакта
<Organization></Organization>Организация контакта
<Name></Name>Имя
<Email></Email>Почта
<PhoneCc></PhoneCc>Телефонный код страны
<PhoneNum></PhoneNum>Номер телефона
<FaxCc></FaxCc>Код страны для факса
<FaxNum></FaxNum>Номер факса
<Address1></Address1>Адрес 1
<Address2></Address2>Адрес 2
<City></City>Город
<State></State>Регион
<ZipCode></ZipCode>Почтовый индекс
<Country></Country>Страна
<GtldVerified></GtldVerified>статус проверки gTLD

Пример получения списка контактов

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>
 

Команда получения контакта

Эта команда доступна только в формате XML:

Параметр запроса получения контакта
Пояснение
contact_idидентификатор контакта
XML-тег результата
Пояснение
<GetContactResponse></GetContactResponse>Корневой узел XML-документа ответа
<GetContactHeader></GetContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetContactContent></GetContactContent>Содержимое ответа
<Contact></Contact>Информация контакта
<ContactId></ContactId>Идентификатор контакта
<Organization></Organization>Организация контакта
<Name></Name>Имя
<Email></Email>Почта
<PhoneCc></PhoneCc>Телефонный код страны
<PhoneNum></PhoneNum>Номер телефона
<FaxCc></FaxCc>Код страны для факса
<FaxNum></FaxNum>Номер факса
<Address1></Address1>Адрес 1
<Address2></Address2>Адрес 2
<City></City>Город
<State></State>Регион
<ZipCode></ZipCode>Почтовый индекс
<Country></Country>Страна
<GtldVerified></GtldVerified>статус проверки gTLD

Пример получения контакта

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>
 

Get Name Server Command

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

Get Name Server Request Parameter
Пояснение
domainДомен, для которого вы хотите получить информацию о серверах имен, за один запрос может быть получена информация только для 1 сервера.
XML-тег результата
Пояснение
<GetNsResponse></GetNsResponse>Корневой узел XML-документа ответа
<GetNsHeader></GetNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<NsContent></NsContent>Содержимое ответа
<Host></Host>Host name of the server
<NsName></NsName>Name of the server

Get Name Server Example

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>
 

Команда добавления сервера имен

При вызове команды добавления сервера имен должны быть указаны следующие параметры:

Параметр запроса добавления сервера имен
Пояснение
hostИмя узла сервера имен, который вы хотите добавить
XML-тег результата
Пояснение
<AddNsResponse></AddNsResponse>Корневой узел XML-документа ответа
<AddNsHeader></AddNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<AddNsContent></AddNsContent>Содержимое ответа
<Server></Server>Сервер, который вы установили
<Host></Host>Имя узла нового сервера
<ServerId></ServerId>Идентификатор нового сервера

Пример добавления сервера имен

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>
 

Команда регистрации сервера имен

При вызове команды регистрации сервера имен должны быть указаны следующие параметры:

Параметр запроса регистрации сервера имен
Пояснение
hostИмя узла вашего собственного сервера имен
ipIP-адрес вашего собственного сервера имен
XML-тег результата
Пояснение
<RegisterNsResponse></RegisterNsResponse>Корневой узел XML-документа ответа
<RegisterNsHeader></RegisterNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<RegisterNsContent></RegisterNsContent>Содержимое ответа
<Server></Server>Тег сервера
<Host></Host>Имя узла
<ServerId></ServerId>Идентификатор сервера

Пример регистрации сервера имен

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>
 

Команда установки IP-адреса сервера имен

При вызове команды установки IP-адреса сервера имен должны быть указаны следующие параметры:

Параметр запроса установки IP-адреса сервера имен
Пояснение
server_idИдентификатор имени сервера, который вы хотите изменить
ip0 - ip9IP-адрес, который вы хотите назначить серверу имен, за один запрос можно добавить 9 IP-адресов, они должны быть разделены запятыми
XML-тег результата
Пояснение
<SetNsIpResponse></SetNsIpResponse>Корневой узел XML-документа ответа
<SetNsIpHeader></SetNsIpHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки IP-адреса сервера имен

Request (XML format)

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

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

Команда удаления сервера имен

При вызове команды удаления сервера имен должны быть указаны следующие параметры:

Параметр запроса удаления сервера имен
Пояснение
server_idИдентификатор серверов имен, которые вы хотите удалить, они должны разделяться запятыми
XML-тег результата
Пояснение
<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа
<DeleteNsHeader></DeleteNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления сервера имен

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>
 

Delete Name Server By Domain Command

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

Delete Name Server By Domain Request Parameter
Пояснение
server_domainName of the name server. ex: ns1.testnameserver.com
XML-тег результата
Пояснение
<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа
<DeleteNsHeader></DeleteNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Delete Name Server By Domain Example

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>
 

Команда получения списка серверов

Эта команда доступна только в формате XML:

Параметр запроса получения списка серверов
Пояснение
N/AДополнительных параметров не требуется
XML-тег результата
Пояснение
<ServerListResponse></ServerListResponse>Корневой узел XML-документа ответа
<ServerListHeader></ServerListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<ServerListContent></ServerListContent>Содержимое ответа
<NameServerList></NameServerList>Список серверов имен
<List></List>
<Server></Server>
<ServerId></ServerId>Идентификатор сервера
<ServerName></ServerName>Имя сервера
<ServerIp></ServerIp>IP-адрес сервера

Пример получения списка серверов имен

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>
 

Get Domain NameServer Settings Command

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

Get Domain Nameserver Settings Request Parameter
Пояснение
domainThe domain whose name server setting you want to get, only 1 domain's name server setting can be pulled per request.
XML-тег результата
Пояснение
<GetDnsResponse></GetDnsResponse>Корневой узел XML-документа ответа
<GetDnsHeader></GetDnsHeader>Заголовок ответа
<ResponseCode></ResponseCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetDnsContent></GetDnsContent>Содержимое ответа
<NameServerSettings></NameServerSettings>Настройки сервера доменного имени
<Type></Type>Тип сервера доменного имени

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>
 

Get Transfer Auth Code Command

Вы должны разблокировать свой домен и учетную запись перед запросом кода авторизации.

Параметр запроса кода авторизации переноса
Пояснение
domainДоменное имя, для которого вы хотите получить код авторизации переноса, в запросе можно указать только 1 домен
new_code (optional)Сгенерировать новый код авторизации переноса
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Если вы хотите разблокировать домен для переноса, установите для этого параметра «1». В случае успешной обработки запроса домен будет разблокирован.
XML-тег результата
Пояснение
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Корневой узел XML-документа ответа
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<AuthCode></AuthCode>Код авторизации используется для запуска переноса домена.

Пример получения кода авторизации переноса

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>
 

Get Listings Command

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

Get Listings Request Parameter
Пояснение
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
exclude_pending_sale (необязательно)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
XML-тег результата
Пояснение
<GetListingsResponse></GetListingsResponse>Корневой узел XML-документа ответа
<GetListingsHeader></GetListingsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetListingsContent></GetListingsContent>Listing content
<Listing></Listing>Listing item content
<ListingId></ListingId>Listing Id
<Domain></Domain>Доменное имя
<Price></Price>Цена
<InBoundLinks></InBoundLinks>In bound links count
<Age></Age>Возраст
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Get Listings Example

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>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
 

Get Listing Item Command

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

Get Listing Item Request Parameter
Пояснение
domainThe domain name you want to get detail, only 1 domain can be entered per request
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetListingItemResponse></GetListingItemResponse>Корневой узел XML-документа ответа
<GetListingItemHeader></GetListingItemHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetListingsItemContent></GetListingsItemContent>Listing content
<Listing></Listing>Listing item content
<ListingId></ListingId>Listing Id
<Domain></Domain>Доменное имя
<Price></Price>Цена
<InBoundLinks></InBoundLinks>In bound links count
<Age></Age>Возраст

Get Listing Item Example

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>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
 

Buy It Now Command

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

Buy It Now Request Parameter
Пояснение
domainThe domain you want to buy, only 1 domain can be entered per request
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<BuyItNowResponse></BuyItNowResponse>Корневой узел XML-документа ответа
<BuyItNowHeader></BuyItNowHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<Message></Message>It should be "domain order created", only used when status is "success".

Buy It Now Example

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>
 

Команда получения информации об учетной записи

Эта команда доступна только в формате XML:

Параметр запроса информации об учетной записи
Пояснение
N/AДополнительных параметров не требуется
XML-тег результата
Пояснение
<AccountInfoResponse></AccountInfoResponse>Корневой узел XML-документа ответа
<AccountInfoHeader></AccountInfoHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<AccountInfoContent></AccountInfoContent>Содержимое ответа
<AccountInfo></AccountInfo>Информация учетной записи
<Username></Username>Имя пользователя
<ForumName></ForumName>Имя на форуме
<Contact></Contact>Информация контакта
<Organization></Organization>Организация
<Organization></Organization>Заголовок ответа
<Name></Name>Ваше имя
<Email></Email>Почта
<PhoneCc></PhoneCc>Телефонный код страны
<PhoneNum></PhoneNum>Номер телефона
<Address1></Address1>Адрес 1
<Address2></Address2>Адрес 2
<City></City>Город
<State></State>Регион
<ZipCode></ZipCode>Почтовый индекс
<Country></Country>Страна
<CustomerSince></CustomerSince>Является клиентом с
<AccountLock></AccountLock>Блокировка для учетной записи
<TotalSpending></TotalSpending>Суммарные расходы
<PriceLevel></PriceLevel>Ценовой уровень
<AccountBalance></AccountBalance>Баланс учетной записи
<CustomTimeZone></CustomTimeZone>Часовой пояс клиента
<DefaultSettings></DefaultSettings>Настройки по умолчанию
<DefaultWhois></DefaultWhois>Whois по умолчанию
<DefaultRegistrant></DefaultRegistrant>Регистрирующее лицо по умолчанию
<ContactId></ContactId>Идентификатор контакта
<DefaultAdmin></DefaultAdmin>Администратор по умолчанию
<DefaultTechnical></DefaultTechnical>Технический по умолчанию
<DefaultBilling></DefaultBilling>Биллинг по умолчанию
<Type></Type>Тип сервера имен
<WithAds></WithAds>С рекламой или без нее

Пример получения информации об учетной записи

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>
 

Установка Whois по умолчанию

При вызове команды установки Whois по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки Whois по умолчанию
Пояснение
registrant_contactИнформация регистрирующего лица
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactБиллинговая информация домена
XML-тег результата
Пояснение
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Корневой узел XML-документа ответа
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки Whois по умолчанию

Request (XML format)

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

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

Команда установки серверов имен по умолчанию

При вызове команды установки серверов имен по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки серверов имен по умолчанию
Пояснение
ns0 - ns12Серверы имен, которые вы хотите установить
XML-тег результата
Пояснение
<SetDefaultNsResponse></SetDefaultNsResponse>Тег ответа установки серверов имен по умолчанию, это корневой узел XML-документа ответа
<SetDefaultNsHeader></SetDefaultNsHeader>Тег заголовка установки серверов имен по умолчанию
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<SetDefaultNsContent></SetDefaultNsContent>Тег содержимого установки серверов имен по умолчанию, используется только при статусе "success"
<Servers></Servers>Информация о серверах, которые вы изменили
<Server></Server>Каждый отдельный сервер
<ServerName></ServerName>Имя сервера
<ServerId></ServerId>Идентификатор сервера

Пример установки серверов имен по умолчанию

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>
 

Команда установки парковки по умолчанию

При вызове команды установки парковки по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки парковки по умолчанию
Пояснение
with_ads (необязательно)Если вы не хотите рекламных объявлений от стороннего поставщика, укажите в этом параметре значение "no", по умолчанию значение "yes"
XML-тег результата
Пояснение
<SetDefaultParkingResponse></SetDefaultParkingResponse>Корневой узел XML-документа ответа
<SetDefaultParkingHeader></SetDefaultParkingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки парковки по умолчанию

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>
 

Команда установки перенаправления по умолчанию

При вызове команды установки перенаправления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки перенаправления по умолчанию
Пояснение
forward_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
is_temp (необязательно)Статус перенаправления для домена, по умолчанию (временный) "temporary", если вы хотите установить постоянное перенаправление, укажите в этом параметре "no"
XML-тег результата
Пояснение
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Корневой узел XML-документа ответа
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления по умолчанию

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>
 

Команда установки скрытого перенаправления по умолчанию

При вызове команды установки скрытого перенаправления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправления по умолчанию
Пояснение
stealth_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
stealth_title (необязательно)Заголовок страницы
XML-тег результата
Пояснение
<SetDefaultStealthResponse></SetDefaultStealthResponse>Корневой узел XML-документа ответа
<SetDefaultStealthHeader></SetDefaultStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки скрытия по умолчанию

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>
 

Команда установки хостинга по умолчанию

При вызове команды установки хостинга по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки хостинга по умолчанию
Пояснение
hosting_typeТип желаемого хостинга по умолчанию, можно выбрать "advanced" или "basic"
XML-тег результата
Пояснение
<SetDefaultHostingResponse></SetDefaultHostingResponse>Корневой узел XML-документа ответа
<SetDefaultHostingHeader></SetDefaultHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки хостинга по умолчанию

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>
 

Команда установки DNS по умолчанию

При вызове команды установки DNS по умолчанию должны быть указаны следующие параметры:

(Эта команда устарела, вместо нее рекомендуется использовать команду Set Default DNS2)

Параметр запроса установки DNS по умолчанию
Пояснение
main_record_typeТип главной записи
main_recordУкажите запись DNS для вашего домена
main_txt (необязательно)Укажите запись TXT для вашего домена. Если основной тип записи (main_record_type) AAAA, и указана основная запись 2 (main_record2), вы можете настроить до 3 основных текстовых (main_txt) записей, в других случаях — до 4.
main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Ее значение должно быть в формате IPv4.
subdomain0 - subdomain99 (необязательно)Записи поддоменов
sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена
sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL
mx_host0 - mx_host2 (необязательно)Укажите адрес почтового узла для домена, distance0 — высший приоритет
mx_distance0 - mx_distance2 (необязательно)Distance0 — высший приоритет
ttl (необязательно)Время жизни (time to live)
XML-тег результата
Пояснение
<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа
<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки DNS по умолчанию

Request (XML format)

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

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

Set Default DNS2 Command

При вызове команды установки DNS по умолчанию должны быть указаны следующие параметры:

Параметры запроса Set Default DNS2
Пояснение
main_record_type0 - main_record_type19Тип главной записи
main_record0 - main_record19Укажите запись DNS для вашего домена
main_recordx0 - main_recordx19Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record типа «a», «aaaa», «cname», «forward», «txt», «mx», «stealth», «email»
subdomain0 - subdomain99 (необязательно)Записи поддоменов
sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена
sub_record0 - sub_record99 (необязательно)IP-адрес или узел назначения поддомена
sub_recordx0 - subdo_recordx99Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для sub_record_type типа «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»
ttl (необязательно)Время жизни (time to live)
XML-тег результата
Пояснение
<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа
<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример использования команды Set Default DNS2

Request (XML format)

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

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

Команда установки перенаправления Email по умолчанию

При вызове команды установки перенаправления Email по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки перенаправления Email по умолчанию
Пояснение
forward_typeТип перенаправления, варианты: "donot": не перенаправлять, "mx": направлять электронную почту на другой почтовый узел (запись MX), "forward": направлять электронную почту на другой почтовый узел
username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"
exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"
mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"
mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"
XML-тег результата
Пояснение
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Корневой узел XML-документа ответа
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления Email по умолчанию

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>
 

Команда сброса значения по умолчанию

При вызове команды сброса значения по умолчанию должны быть указаны следующие параметры:

Параметр запроса сброса значения по умолчанию
Пояснение
serviceСлужба, которую вы хотите стереть, может быть «forward», «stealth», «email_forwarding», «dns» и «nameservers»
XML-тег результата
Пояснение
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Корневой узел XML-документа ответа
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример сброса значения по умолчанию

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>
 

Команда установки опции продления по умолчанию

При вызове команды установки опции продления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки опции продления по умолчанию
Пояснение
renew_optionМожет быть указано "donot", "auto", "reset"
XML-тег результата
Пояснение
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Корневой узел XML-документа ответа
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки опции продления по умолчанию

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>
 

Команда создания папки

При вызове команды создания папки должны быть указаны следующие параметры:

Параметр запроса создания папки
Пояснение
folder_nameНазвание папки, которую вы хотите создать
XML-тег результата
Пояснение
<FolderCreateResponse></FolderCreateResponse>Корневой узел XML-документа ответа
<FolderCreateHeader></FolderCreateHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<FolderCreateContent></FolderCreateContent>Содержимое ответа
<FolderName></FolderName>название папки
<FolderId></FolderId>Идентификатор новой папки

Пример создания папки

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>
 

Команда удаления папки

При вызове команды установки данных Whois должны быть указаны следующие параметры:

Параметр запроса удаления папки
Пояснение
folder_idИдентификатор папок, которые вы хотите удалить, они должны разделяться запятыми
XML-тег результата
Пояснение
<DeleteFolderResponse></DeleteFolderResponse>Корневой узел XML-документа ответа
<DeleteFolderHeader></DeleteFolderHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления папки

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>
 

Команда установки Whois для папки

При вызове команды установки Whois для папки должны быть указаны следующие параметры:

Параметр запроса установки Whois для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
registrant_contactИнформация регистрирующего лица
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactБиллинговая информация домена
enable (необязательно)Если вы хотите применить эти настройки Whois для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать эти настройки Whois для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderWhoisResponse></SetFolderWhoisResponse>Корневой узел XML-документа ответа
<SetFolderWhoisHeader></SetFolderWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки 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>
 

Команда установки серверов имен для папки

При вызове команды установки серверов имен для папки должны быть указаны следующие параметры:

Параметр запроса установки серверов имен для папки
Пояснение
fold_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку
ns0 - ns12Сервера имен, которые вы хотите установить для домена. Максимальное количество серверов имен, которое можно указать: 13, но они должны быть предварительно внесены в вашу учетную запись.
enable (необязательно)Если вы хотите применить эти настройки серверов имен для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать эти настройки серверов имен для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderNsResponse></SetFolderNsResponse>Тег ответа установки серверов имен для папки, это корневой узел XML-документа ответа
<SetFolderNsHeader></SetFolderNsHeader>Тег заголовка ответа установки серверов имен для папки
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<SetFolderNsContent></SetFolderNsContent>Тег содержимого установки серверов имен для папки, используется, только когда status имеет значение "success"
<Servers></Servers>Информация о серверах, которые вы изменили
<Server></Server>Каждый отдельный сервер
<ServerName></ServerName>Имя сервера
<ServerId></ServerId>Идентификатор сервера

Пример установки серверов имен для папки

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

 

Команда установки парковки для папки

При вызове команды установки парковки для папки должны быть указаны следующие параметры:

Параметр запроса установки парковки для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку
with_ads (необязательно)Если вы не хотите рекламных объявлений от стороннего поставщика, укажите в этом параметре значение "no", по умолчанию значение "yes"
enable (необязательно)Если вы хотите применить эти настройки парковки для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать настройки парковки для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderParkingResponse></SetFolderParkingResponse>Корневой узел XML-документа ответа
<SetFolderParkingHeader></SetFolderParkingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки парковки для папки

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>
 

Команда установки перенаправления для папки

При вызове команды установки перенаправления для папки должны быть указаны следующие параметры:

Параметр запроса установки перенаправления для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
forward_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
is_temp (необязательно)Статус перенаправления для домена, по умолчанию (временный) "temporary", если вы хотите установить постоянное перенаправление, укажите в этом параметре "no"
enable (необязательно)Если вы хотите применить эти настройки перенаправления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать настройки перенаправления для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderForwardingResponse></SetFolderForwardingResponse>Корневой узел XML-документа ответа
<SetFolderForwardingHeader></SetFolderForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления для папки

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>
 

Команда установки скрытого перенаправления для папки

При вызове команды установки скрытого перенаправления для папки должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправления для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
stealth_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.
stealth_title (необязательно)Заголовок страницы
enable (необязательно)Если вы хотите применить эти настройки скрытого перенаправления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать настройки скрытого перенаправления для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderStealthResponse></SetFolderStealthResponse>Корневой узел XML-документа ответа
<SetFolderStealthHeader></SetFolderStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки скрытого перенаправления для папки

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>
 

Команда установки хостинга для папки

При вызове команды установки хостинга для папки должны быть указаны следующие параметры:

Параметр запроса установки хостинга для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
hosting_typeТип желаемого хостинга, можно выбрать "advanced" или "basic"
enable (необязательно)Если вы хотите применить эти настройки хостинга для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
even (необязательно)Если вы хотите синхронизировать настройки хостинга для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderHostingResponse></SetFolderHostingResponse>Корневой узел XML-документа ответа
<SetFolderHostingHeader></SetFolderHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки хостинга для папки

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>
 

Команда установки DNS для папки

При вызове команды установки DNS для папки должны быть указаны следующие параметры:

(Эта команда устарела, вместо нее рекомендуется использовать команду Set Folder DNS2)

Параметр запроса установки DNS для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
main_record_typeТип главной записи
main_recordУкажите запись DNS для вашего домена
main_recordУкажите запись DNS для вашего домена
with_ads (необязательно)Укажите запись TXT для вашего домена. Если основной тип записи (main_record_type) AAAA, и указана основная запись 2 (main_record2), вы можете настроить до 3 основных текстовых (main_txt) записей, в других случаях — до 4.
main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Ее значение должно быть в формате IPv4.
subdomain0 - subdomain99 (необязательно)Subdomain records (необязательно)
sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена
sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL
mx_host0 - mx_host2 (необязательно)Укажите адрес почтового узла для домена, distance0 — высший приоритет
mx_distance0 - mx_distance2 (необязательно)Distance0 — высший приоритет
ttl (необязательно)Время жизни (time to live)
enable (необязательно)Если вы хотите применить эти настройки DNS для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать настройки DNS для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа
<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки 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>
 

Команда Set Folder DNS2

При вызове команды set folder DNS2 необходимо указать следующие параметры:

Параметры запроса Set Folder DNS2
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
main_record_type0 - main_record_type19Тип основной записи должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»
main_record0 - main_record19Укажите запись DNS для вашего домена
main_recordx0 - main_recordx19Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email»
subdomain0 - subdomain99 (необязательно)Subdomain records (необязательно)
sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»
sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL
sub_recordx0 - sub_recordx99 (необязательно)Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для sub_record_type типа «forward», «mx», «stealth», «email»
ttl (необязательно)Время жизни (time to live)
enable (необязательно)Если вы хотите применить эти настройки DNS для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать настройки DNS для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа
<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример использования команды Set Folder DNS2

Request (XML format)

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

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

Команда установки перенаправления Email для папки

При вызове команды установки перенаправления Email для папки должны быть указаны следующие параметры:

Параметр запроса установки перенаправления Email для папки
Пояснение
domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
folder_idИдентификатор папки, которую вы хотите изменить
forward_typeТип перенаправления, варианты: "donot": не перенаправлять, "mx": направлять электронную почту на другой почтовый узел (запись MX), "forward": направлять электронную почту на другой почтовый узел
username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"
exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"
mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"
mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"
enable (необязательно)Если вы хотите применить эти настройки для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать эти настройки для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Корневой узел XML-документа ответа
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки перенаправления Email для папки

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>
 

Команда сброса значения для папки

При вызове команды сброса значения для папки должны быть указаны следующие параметры:

Параметр запроса сброса значения для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
serviceСлужба, которую вы хотите стереть, может быть «forward», «stealth», «email_forwarding», «dns» и «nameservers»
XML-тег результата
Пояснение
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Корневой узел XML-документа ответа
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример сброса значения для папки

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>
 

Команда установки названия папки

При вызове команды установки названия папки должны быть указаны следующие параметры:

Параметр запроса установки названия папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить
folder_nameНовое название папки
XML-тег результата
Пояснение
<SetFolderNameResponse></SetFolderNameResponse>Корневой узел XML-документа ответа
<SetFolderNameHeader></SetFolderNameHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки названия папки

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>
 

Команда установки опции продления для папки

При вызове команды установки опции продления для папки должны быть указаны следующие параметры:

Параметр запроса установки опции продления для папки
Пояснение
folder_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку
renew_optionThe renew option you want to set to the folder; it can be "donot", "auto" or "reset"
enable (необязательно)Если вы хотите применить эти настройки продления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"
sync (необязательно)Если вы хотите синхронизировать эти настройки продления для всех доменов в этой папке, вы можете указать в этом параметре "yes"
XML-тег результата
Пояснение
<Response></Response>Корневой узел XML-документа ответа
<ResponseHeader></ResponseHeader>Заголовок ответа
<ResponseCode></ResponseCode>Код ответа, "0" при успешном завершении, "-1" при сбое
<Error></Error>Информация об ошибке, используется только при коде ответа "-1"

Пример установки опции продления для папки

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>
 

Команда списка папок

Эта команда доступна только в формате XML:

Параметр запроса списка папок
Пояснение
N/AДополнительных параметров не требуется
<FolderListResponse></FolderListResponse>Корневой узел XML-документа ответа
<FolderListHeader></FolderListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<FolderListContent></FolderListContent>Содержимое ответа
<FolderList></FolderList>Список папок
<List></List>
<Folder></Folder>
<FolderId></FolderId>Идентификатор папки
<FolderName></FolderName>Название папки
<DefaultWhois></DefaultWhois>Whois по умолчанию
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Статус включения Whois по умолчанию (Whois enable)
<DefaultRegistrant></DefaultRegistrant>Регистрирующее лицо по умолчанию
<ContactId></ContactId>Идентификатор контакта
<DefaultAdmin></DefaultAdmin>Администратор по умолчанию
<DefaultTechnical></DefaultTechnical>Техническая информация по умолчанию
<DefaultBilling></DefaultBilling>Биллинговая информация по умолчанию
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Статус включения сервера имен по умолчанию (name server enable)
<NameServerSettings></NameServerSettings>Значение сервера имен
<Type></Type>Тип сервера имен
<WithAds></WithAds>С рекламой или без нее
<DefaultRenewOption></DefaultRenewOption>Настройка продления по умолчанию
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Статус включения настройки продления по умолчанию
<RenewOption></RenewOption>Настройка продления
<DefaultTransferLock></DefaultTransferLock>Значение блокировки переноса по умолчанию
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Статус включения блокировки переноса по умолчанию
<LockStatus></LockStatus>Статус блокировки

Пример получения списка папок

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>
 

Команда добавления запроса на отложенный заказ

При вызове команды добавления запроса на отложенный заказ должны быть указаны следующие параметры:

Параметр запроса на добавления запроса на отложенный заказ
Пояснение
domainДомены, которые вы хотите добавить и согласны оплатить, если Dynadot перехватит их, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми
XML-тег результата
Пояснение
<AddBackorderRequestResponse></AddBackorderRequestResponse>Корневой узел XML-документа ответа
<AddBackorderRequestHeader></AddBackorderRequestHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример добавления запроса на отложенный заказ

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>
 

Команда удаления запроса на отложенный заказ

При вызове команды удаления запроса на отложенный заказ должны быть указаны следующие параметры:

Параметр запроса на удаление запроса на отложенный заказ
Пояснение
domainДомены, которые вы хотите удалить из запроса на отложенный заказ, за один запрос можно удалить 100 доменов, они должны быть разделены запятыми
XML-тег результата
Пояснение
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Корневой узел XML-документа ответа
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления запроса на отложенный заказ

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>
 

Команда запроса списка отложенных заказов

Вызов команды получения списка отложенных заказов возвращает список отложенных заказов для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса списка отложенных заказов
Пояснение
startDateНачальная дата освобождения доменов, гггг-мм-дд, например 2015-05-05
endDateДата окончания освобождения доменов, гггг-мм-дд, например 2015-05-05
XML-тег результата
Пояснение
<BackorderRequestListResponse></BackorderRequestListResponse>Корневой узел XML-документа ответа
<BackorderRequestListHeader></BackorderRequestListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<BackorderRequestListContent></BackorderRequestListContent>Содержимое ответа
<BackorderRequestList></BackorderRequestList>Список запроса отложенных заказов
<BackorderRequest></BackorderRequest>Запрос на отложенные заказы
<Domain></Domain>Домен из вашего списка
<CutoffTime></CutoffTime>Конечный срок для удаления запроса в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)
<BackorderRequestStatus></BackorderRequestStatus>Статус процесса перехвата домена

Пример запроса списка отложенных заказов

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
 

Команда получения списка открытых аукционов

Вызов команды получения открытых аукционов вернет список активных на данный момент аукционов. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса на получение списка открытых аукционов
Пояснение
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
type (необязательно)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
XML-тег результата
Пояснение
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Тег ответа получения открытых аукционов. Это корневой узел XML-документа ответа
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Заголовок получения открытых аукционов
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Тег содержимого получения открытых аукционов, используется только при статусе "success"
<Auction></Auction>Тег аукционного лота, используется только при статусе "success"
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)
<Revenue></Revenue>Доход с домена
<RevenueCurrency></RevenueCurrency>Валюта дохода
<Visitors></Visitors>Посетители домена
<Links></Links>Внешние ссылки
<Age></Age>Возраст домена

Пример получения списка открытых аукционов

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>
Запрос (формат csv)

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

Ответ

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

Команда получения подробностей аукциона

Вызов команды получения подробностей аукциона вернет подробную информацию об указанной сделке аукциона. Эта команда доступна только в формате XML. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения подробностей об аукционе
Пояснение
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 (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Тег ответа получения подробностей об аукционе, это корневой узел XML-документа ответа
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок получения сведений об аукционе отложенных заказов
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Тег содержимого получения подробностей об аукционе, используется только при статусе "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>Статус аукциона
<UserIsHighBid></UserIsHighBid>Является ли ставка пользователя самой высокой
<YourCurrentBid></YourCurrentBid>Ваша текущая ставка в указанном аукционе. Если вы не делали ставок, будет передано '-1'
<YourProxyBid></YourProxyBid>Ваша максимальная ставка (proxy bid) в указанном аукционе. Если вы не делали ставок, будет передано '-1'
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

Пример получения подробностей аукциона

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)
<GetAuctionDetailsResponse>
 <GetAuctionDetailsHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </GetAuctionDetailsHeader>
 <GetAuctionDetailsContent>
   <AuctionStatusId>0</AuctionStatusId>
   <AuctionStatus>In Progress</AuctionStatus>
   <UserIsHighBid>No</UserIsHighBid>
   <YourCurrentBid>-1</YourCurrentBid>
   <YourProxyBid>-1</YourProxyBid>
   <Auction>
     <AuctionId>0</AuctionId>
     <Domain>domain0.com</Domain>
     <BidPrice>6.35</BidPrice>
     <BidPriceCurrency>CNY</BidPriceCurrency>
     <Bids>0</Bids>
     <EndTime>2017/09/03 17:12 UTC</EndTime>
     <EndTimestamp>1504458737058</EndTimestamp>
   </Auction>
 </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Request (JSON format)

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

Response (JSON format)
{
    "status": "success",
    "size": "1",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.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,
            "auction_status_id": 0,
            "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
            }
            ...
        ]
    }
}
 

Команда регистрации ставки на аукционный лот

Вызов команды регистрацию ставки на аукционный лот оформит ставку на указанный лот аукциона. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса на регистрацию ставки на аукционный лот
Пояснение
domainДоменное имя аукциона, для IDN (интернационализированные доменные имена) следует использовать пьюникод, например «xn--wkccg.com»
bid_amountСумма вашей ставки для аукциона, валюта по умолчанию — доллар США, вы также можете указать ее с помощью параметра валюты ниже
currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Тег ответа регистрации ставки, это корневой узел XML-документа ответа
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Заголовок регистрации ставки
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример домена

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>
Запрос (формат csv)

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

Ответ

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

Команда получения закрытых аукционов

Вызов команды получения закрытых аукционов возвращает список закрытых аукционов для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения закрытых аукционов
Пояснение
startDateДата начала аукциона, гггг-мм-дд, например 2015-05-05
endDateДата окончания аукциона, гггг-мм-дд, например 2015-05-05
currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Тег ответа получения закрытых аукционов, это корневой узел XML-документа ответа
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Заголовок получения закрытых аукционов
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Тег содержимого получения закрытых аукционов, используется только при статусе "success"
<Auction></Auction>Тег аукционного лота, используется только при статусе "success"
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<AuctionStatusId></AuctionStatusId>Идентификатор статуса аукциона, «0» — в процессе, «1» — закрыт пользователем, «2» — закрыт администратором, «3» — закрыт из-за продления, «4» — закрыт по истечению времени, «5» — закрыт из-за переноса к другому регистратору
<AuctionStatus></AuctionStatus>Статус аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона
<AuctionWonStatus></AuctionWonStatus>Выиграл ли пользователь этот аукцион
<YourHighBid></YourHighBid>Ваша высшая ставка на этом аукционе
<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этих торгов

Пример получения закрытых аукционов

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
 

Команда получения открытых аукционов по отложенным заказам(Deprecated,please use get_open_auctions command)

Вызов команды получения открытых аукционов по отложенным заказам возвращает список активных аукционов по отложенным заказам. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения открытых аукционов по отложенным заказам
Пояснение
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Тег ответа получения открытых торгов по отложенным заказам, это корневой узел XML-документа ответа
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Заголовок получения открытых аукционов по отложенным заказам
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Тег содержимого получения открытых торгов по отложенным заказам, используется только при статусе "success"
<Auction></Auction>Тег аукционного лота, используется только при статусе "success"
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

Пример получения открытых аукционов по отложенным заказам

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>
Запрос (формат csv)

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

Ответ

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

 

Команда получения сведений об аукционе по отложенному заказу

Вызов команды получения сведений об аукционе по отложенному заказу возвращает сведения об указанном аукционе. Эта команда доступна только в формате XML. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения подробностей об аукционе
Пояснение
domainДоменное имя аукциона по отложенному заказу, для IDN (интернационализированные доменные имена) следует использовать пьюникод, например «xn--wkccg.com»
currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Тег ответа получения подробностей об аукционе, это корневой узел XML-документа ответа
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок ответа получения подробностей об аукционе
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Тег содержимого получения подробностей об аукционе, используется только при статусе "success"
<AuctionStatusId></AuctionStatusId>Идентификатор статуса аукциона, «0» — в процессе, «1» — закрыт пользователем, «2» — закрыт администратором, «3» — закрыт из-за продления, «4» — закрыт по истечению времени, «5» — закрыт из-за переноса к другому регистратору
<AuctionStatus></AuctionStatus>Статус аукциона
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)
<Revenue></Revenue>Доход с домена
<RevenueCurrency></RevenueCurrency>Валюта дохода
<Visitors></Visitors>Посетители домена
<Links></Links>Внешние ссылки
<Age></Age>Возраст домена
<UserIsHighBid></UserIsHighBid>Является ли ставка пользователя самой высокой
<YourCurrentBid></YourCurrentBid>Ваша текущая ставка в указанном аукционе. Если вы не делали ставок, будет передано '-1'
<YourProxyBid></YourProxyBid>Ваша максимальная ставка (proxy bid) в указанном аукционе. Если вы не делали ставок, будет передано '-1'

Пример получения сведений об аукционе по отложенному заказу

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>
 

Команда размещения ставки на аукционе отложенных заказов

Вызов команды размещения ставки на аукционе по отложенным заказам приведет к размещению ставки на указанных торгах по отложенному заказу. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса размещения ставки на аукционе по отложенному заказу
Пояснение
domainДоменное имя аукциона, для IDN (интернационализированные доменные имена) следует использовать пьюникод, например «xn--wkccg.com»
bid_amountСумма вашей ставки для аукциона, валюта по умолчанию — доллар США, вы также можете указать ее с помощью параметра валюты ниже
currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Тег ответа регистрации ставки, это корневой узел XML-документа ответа
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Заголовок регистрации ставки
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"

Пример размещения ставки на аукционе отложенных заказов

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
 

Команда получения закрытых аукционов по отложенным заказам

Вызов команды получения закрытых аукционов по отложенным заказам возвращает список закрытых аукционов по отложенным заказам для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения закрытых аукционов по отложенным заказам
Пояснение
startDateДата начала аукциона, гггг-мм-дд, например 2015-05-05
endDateДата окончания аукциона, гггг-мм-дд, например 2015-05-05
currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Тег ответа получения закрытых аукционов, это корневой узел XML-документа ответа
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Заголовок получения закрытых аукционов
<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Тег содержимого получения закрытых аукционов, используется только при статусе "success"
<Auction></Auction>Тег аукционного лота, используется только при статусе "success"
<YourHighBid></YourHighBid>Ваша высшая ставка на этом аукционе
<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этих торгов
<AuctionId></AuctionId>Идентификатор аукциона
<Domain></Domain>Доменное имя аукциона
<AuctionStatusId></AuctionStatusId>Идентификатор статуса аукциона, «0» — в процессе, «1» — закрыт пользователем, «2» — закрыт администратором, «3» — закрыт из-за продления, «4» — закрыт по истечению времени, «5» — закрыт из-за переноса к другому регистратору
<AuctionStatus></AuctionStatus>Статус аукциона
<BidPrice></BidPrice>Размер текущей ставки аукциона
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок аукциона

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
 

Команда получения ставок по лоту

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
Пояснение
currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США
XML-тег результата
Пояснение
<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>Успешность выполнения операции: "0" при успехе, "-1" при неудаче
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке, используется при статусе "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>Доменное имя аукциона
<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

Пример получения ставок аукционного лота

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

Команда Is Processing

Вызов команды is_processing сообщит вам, можно ли отправить новый запрос

Параметр запроса is-processing
Пояснение
дополнительных параметров не требуется
XML-тег результата
Пояснение
<Response></Response>Тег ответа is_processing
<RespnseHeader></RespnseHeader>Тег заголовка is_processing
<ResponseMsg></ResponseMsg>Тег сообщения ответа is_processing. Должен быть «yes» (В системе запущен процесс. Не следует отправлять еще один запрос.) или «no» (Нет процессов для вашей учетной записи. Можно отправить новый запрос.)

Пример is-processing

Request (XML format)

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

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

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

Response (CSV format)
ok,yes
Are you sure you want to close the chat?Chat will be closed and the chat history will be cleared.
Chat Online
Чат в Интернете0