Документация
API Яндекс.Почты для домена

Редактировать DNS-запись

Запрос позволяет редактировать DNS-запись для домена.

DNS-запись можно задать с помощью идентификатора.

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода POST.

POST /api2/admin/dns/edit
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &record_id
[no-highlight[

Тип

Число

Значение

Идентификатор DNS-записи.

]no-highlight]
=<идентификатор записи> [&admin_mail
[no-highlight[

Тип

Строка

Значение

Email-адрес администратора домена.

Параметр обязателен только для SOA-записи.

]no-highlight]
=<email-адрес администратора>] [&content
[no-highlight[

Тип

Строка

Значение

Содержимое DNS-записи.

Для записи типа:

  • A — адрес в формате IPv4 (например, «194.84.46.241»).
  • AAAA — адрес в формате IPv6 (например, «2001:0db8:11a3:09d7:1f34:8a2e:07a0:765d»).
  • CNAME, MX или NS — полностью определенное имя домена (FQDN).
  • TXT — текст TXT-записи (например, «v=spf1 redirect=_spf.yandex.ru»).

]no-highlight]
=<содержимое записи>] [&priority
[no-highlight[

Тип

Число

Значение

Приоритет DNS-записи (чем меньше значение, тем выше приоритет).

Параметр обязателен только для SRV или MX-записи.

Значение по умолчанию — 10.

]no-highlight]
=<приоритет записи>] [&weight
[no-highlight[

Тип

Число

Значение

Вес SRV-записи относительно других SRV-записей для того же домена, с тем же приоритетом.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<вес SRV-записи>] [&port
[no-highlight[

Тип

Строка

Значение

TCP или UDP-порт хоста, на котором размещен сервис. Сервисом может быть, например, джаббер.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<порт хоста>] [&target
[no-highlight[

Тип

Строка

Значение

Каноническое имя хоста, предоставляющего сервис.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<каноническое имя хоста>] [&subdomain
[no-highlight[

Тип

Строка

Значение

Имя поддомена. Например, «domain.com» — имя поддомена домена «com», а «my.domain.com» — имя поддомена домена «domain.com».

Значение по умолчанию — «@» (корень домена).

Параметр нужно передать, если требуется создать или отредактировать DNS-запись не для домена, а для его поддомена.

]no-highlight]
=<имя поддомена>] [&ttl
[no-highlight[

Тип

Число

Значение

Время жизни DNS-записи в секундах.

Для SOA-записи это время, на которое кешируется значение DNS-записи промежуточными DNS-серверами. Это же время будет использоваться по умолчанию для всех остальных новых записей зоны. Допустимые значения — от 900 и до 1209600. Рекомендуемое значение — 21600.

]no-highlight]
=<время жизни записи>] [&refresh
[no-highlight[

Тип

Число

Значение

Частота проверки в секундах вторичными DNS-серверами DNS-записи для этой зоны. Допустимые значения — от 900 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время между обновлениями>] [&retry
[no-highlight[

Тип

Число

Значение

Время в секундах между повторными попытками вторичных DNS-серверов получить записи зоны. Повторные запросы отправляются, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время между попытками получить записи>] [&expire
[no-highlight[

Тип

Число

Значение

Время в секундах, по истечении которого вторичные DNS-серверы считают записи зоны несуществующими, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<предельное время>] [&neg_cache
[no-highlight[

Тип

Число

Значение

Время в секундах, в течение которого будет кешироваться отрицательный ответ (ERROR = NXDOMAIN) от DNS-сервера. Допустимые значения — от 90 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время кеширования>]

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Параметры:

ПараметрТипЗначение
Обязательные
domain Строка

Имя домена.

record_id Число

Идентификатор DNS-записи.

Необязательные
subdomain Строка

Имя поддомена. Например, «domain.com» — имя поддомена домена «com», а «my.domain.com» — имя поддомена домена «domain.com».

Значение по умолчанию — «@» (корень домена).

Параметр нужно передать, если требуется создать или отредактировать DNS-запись не для домена, а для его поддомена.

ttl Число

Время жизни DNS-записи в секундах.

Для SOA-записи это время, на которое кешируется значение DNS-записи промежуточными DNS-серверами. Это же время будет использоваться по умолчанию для всех остальных новых записей зоны. Допустимые значения — от 900 и до 1209600. Рекомендуемое значение — 21600.

refresh Число

Частота проверки в секундах вторичными DNS-серверами DNS-записи для этой зоны. Допустимые значения — от 900 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

retry Число

Время в секундах между повторными попытками вторичных DNS-серверов получить записи зоны. Повторные запросы отправляются, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

expire Число

Время в секундах, по истечении которого вторичные DNS-серверы считают записи зоны несуществующими, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

neg_cache Число

Время в секундах, в течение которого будет кешироваться отрицательный ответ (ERROR = NXDOMAIN) от DNS-сервера. Допустимые значения — от 90 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

admin_mail Строка

Email-адрес администратора домена.

Параметр обязателен только для SOA-записи.

content Строка

Содержимое DNS-записи.

Для записи типа:

  • A — адрес в формате IPv4 (например, «194.84.46.241»).
  • AAAA — адрес в формате IPv6 (например, «2001:0db8:11a3:09d7:1f34:8a2e:07a0:765d»).
  • CNAME, MX или NS — полностью определенное имя домена (FQDN).
  • TXT — текст TXT-записи (например, «v=spf1 redirect=_spf.yandex.ru»).

priority Число

Приоритет DNS-записи (чем меньше значение, тем выше приоритет).

Параметр обязателен только для SRV или MX-записи.

Значение по умолчанию — 10.

port Строка

TCP или UDP-порт хоста, на котором размещен сервис. Сервисом может быть, например, джаббер.

Параметр обязателен только для SRV-записи.

weight Число

Вес SRV-записи относительно других SRV-записей для того же домена, с тем же приоритетом.

Параметр обязателен только для SRV-записи.

target Строка

Каноническое имя хоста, предоставляющего сервис.

Параметр обязателен только для SRV-записи.

POST /api2/registrar/dns/edit
Host: pddimp.yandex.ru
PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен> ... domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &record_id
[no-highlight[

Тип

Число

Значение

Идентификатор DNS-записи.

]no-highlight]
=<идентификатор записи> [&admin_mail
[no-highlight[

Тип

Строка

Значение

Email-адрес администратора домена.

Параметр обязателен только для SOA-записи.

]no-highlight]
=<email-адрес администратора>] [&content
[no-highlight[

Тип

Строка

Значение

Содержимое DNS-записи.

Для записи типа:

  • A — адрес в формате IPv4 (например, «194.84.46.241»).
  • AAAA — адрес в формате IPv6 (например, «2001:0db8:11a3:09d7:1f34:8a2e:07a0:765d»).
  • CNAME, MX или NS — полностью определенное имя домена (FQDN).
  • TXT — текст TXT-записи (например, «v=spf1 redirect=_spf.yandex.ru»).

]no-highlight]
=<содержимое записи>] [&priority
[no-highlight[

Тип

Число

Значение

Приоритет DNS-записи (чем меньше значение, тем выше приоритет).

Параметр обязателен только для SRV или MX-записи.

Значение по умолчанию — 10.

]no-highlight]
=<приоритет записи>] [&weight
[no-highlight[

Тип

Число

Значение

Вес SRV-записи относительно других SRV-записей для того же домена, с тем же приоритетом.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<вес SRV-записи>] [&port
[no-highlight[

Тип

Строка

Значение

TCP или UDP-порт хоста, на котором размещен сервис. Сервисом может быть, например, джаббер.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<порт хоста>] [&target
[no-highlight[

Тип

Строка

Значение

Каноническое имя хоста, предоставляющего сервис.

Параметр обязателен только для SRV-записи.

]no-highlight]
=<каноническое имя хоста>] [&subdomain
[no-highlight[

Тип

Строка

Значение

Имя поддомена. Например, «domain.com» — имя поддомена домена «com», а «my.domain.com» — имя поддомена домена «domain.com».

Значение по умолчанию — «@» (корень домена).

Параметр нужно передать, если требуется создать или отредактировать DNS-запись не для домена, а для его поддомена.

]no-highlight]
=<имя поддомена>] [&ttl
[no-highlight[

Тип

Число

Значение

Время жизни DNS-записи в секундах.

Для SOA-записи это время, на которое кешируется значение DNS-записи промежуточными DNS-серверами. Это же время будет использоваться по умолчанию для всех остальных новых записей зоны. Допустимые значения — от 900 и до 1209600. Рекомендуемое значение — 21600.

]no-highlight]
=<время жизни записи>] [&refresh
[no-highlight[

Тип

Число

Значение

Частота проверки в секундах вторичными DNS-серверами DNS-записи для этой зоны. Допустимые значения — от 900 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время между обновлениями>] [&retry
[no-highlight[

Тип

Число

Значение

Время в секундах между повторными попытками вторичных DNS-серверов получить записи зоны. Повторные запросы отправляются, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время между попытками получить записи>] [&expire
[no-highlight[

Тип

Число

Значение

Время в секундах, по истечении которого вторичные DNS-серверы считают записи зоны несуществующими, если основной сервер не отвечает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<предельное время>] [&neg_cache
[no-highlight[

Тип

Число

Значение

Время в секундах, в течение которого будет кешироваться отрицательный ответ (ERROR = NXDOMAIN) от DNS-сервера. Допустимые значения — от 90 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

]no-highlight]
=<время кеширования>]

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

ПараметрТипЗначение
Обязательные
domain Строка

Имя домена.

record_id Число

Идентификатор DNS-записи.

Необязательные
subdomain Строка

Имя поддомена. Например, «domain.com» — имя поддомена домена «com», а «my.domain.com» — имя поддомена домена «domain.com».

Значение по умолчанию — «@» (корень домена).

Параметр нужно передать, если требуется создать или отредактировать DNS-запись не для домена, а для его поддомена.

ttl Число

Время жизни DNS-записи в секундах.

Для SOA-записи это время, на которое кешируется значение DNS-записи промежуточными DNS-серверами. Это же время будет использоваться по умолчанию для всех остальных новых записей зоны. Допустимые значения — от 900 и до 1209600. Рекомендуемое значение — 21600.

refresh Число

Частота проверки в секундах вторичными DNS-серверами DNS-записи для этой зоны. Допустимые значения — от 900 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

retry Число

Время в секундах между повторными попытками вторичных DNS-серверов получить записи зоны, если основной сервер ничего не вернул. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

expire Число

Время в секундах, по истечении которого вторичные DNS-сервера считают записи зоны несуществующими, если основной сервер повторно ничего не возвращает. Допустимые значения — от 90 и до 3600. Рекомендуемое значение — 900.

Параметр нужно передать, если редактируется SOA-запись.

neg_cache Число

Время в секундах, в течении которого будет кешироваться отрицательный ответ (ERROR = NXDOMAIN) от DNS-сервера. Допустимые значения — от 90 и до 86400. Рекомендуемое значение — 10800.

Параметр нужно передать, если редактируется SOA-запись.

admin_mail Строка

Email-адрес администратора домена.

Параметр обязателен только для SOA-записи.

content Строка

Содержимое DNS-записи.

Для записи типа:

  • A — адрес в формате IPv4 (например, «194.84.46.241»).
  • AAAA — адрес в формате IPv6 (например, «2001:0db8:11a3:09d7:1f34:8a2e:07a0:765d»).
  • CNAME, MX или NS — полностью определенное имя домена (FQDN).
  • TXT — текст TXT-записи (например, «v=spf1 redirect=_spf.yandex.ru»).

priority Число

Приоритет DNS-записи (чем меньше значение, тем выше приоритет).

Параметр обязателен только для SRV или MX-записи.

Значение по умолчанию — 10.

port Строка

TCP или UDP-порт хоста, на котором размещен сервис. Сервисом может быть, например, джаббер.

Параметр обязателен только для SRV-записи.

weight Число

Вес SRV-записи относительно других SRV-записей для того же домена, с тем же приоритетом.

Параметр обязателен только для SRV-записи.

target Строка

Каноническое имя хоста, предоставляющего сервис.

Параметр обязателен только для SRV-записи.

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

POST /api2/admin/dns/edit HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com&record_id=1&subdomain=www&ttl=14400&content=127.0.0.1
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com&record_id=1&subdomain=www&ttl=14400&content=127.0.0.1' 'https://pddimp.yandex.ru/api2/admin/dns/edit'
POST /api2/admin/dns/edit HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com&record_id=1&subdomain=www&ttl=14400&content=127.0.0.1
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' -d 'domain=domain.com&record_id=1&subdomain=www&ttl=14400&content=127.0.0.1' 'https://pddimp.yandex.ru/api2/admin/dns/edit'

Структура ответа

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "record_id
[no-highlight[

Тип значения

Число

Описание

Идентификатор DNS-записи.

]no-highlight]
": "{идентификатор записи}", "record
[no-highlight[

Тип значения

Объект

Описание

Информация о DNS-записи.

]no-highlight]
": { "record_id
[no-highlight[

Тип значения

Число

Описание

Идентификатор DNS-записи.

]no-highlight]
": "{идентификатор записи}", "type
[no-highlight[

Тип значения

Строка

Описание

Тип DNS-записи.

Возможные значения:

  • SRV;
  • TXT;
  • NS;
  • MX;
  • SOA;
  • A;
  • AAAA;
  • CNAME.

]no-highlight]
": "{тип записи}", "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}" "fqdn
[no-highlight[

Тип значения

Строка

Описание

Полностью определенное имя домена (FQDN).

]no-highlight]
": {"полное имя домена"}, "ttl
[no-highlight[

Тип значения

Число

Описание

Время жизни DNS-записи в секундах.

]no-highlight]
": "{время жизни записи}", "subdomain
[no-highlight[

Тип значения

Строка

Описание

Имя поддомена. Например, «my.domain.com» — имя поддомена домена «domain.com». Вместо «my.domain.com» можно использовать «my».

]no-highlight]
": "{имя поддомена}", "content
[no-highlight[

Тип значения

Строка

Описание

Содержимое DNS-записи.

]no-highlight]
": "{содержимое записи}", "priority
[no-highlight[

Тип значения

Число

Описание

Приоритет DNS-записи. Существует для MX и SRV-записей. Для остальных DNS-записей возвращается пустая строка.

]no-highlight]
": "{приоритет записи}", "operation
[no-highlight[

Тип значения

Строка

Описание

Текущее действие, совершаемое с DNS-записью. Возможно только одно значение — editing.

]no-highlight]
": "{editing}" }, "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
domain Строка

Имя домена.

record Объект

Информация о DNS-записи.

success Строка

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

Ключи объекта record
record_id Число

Идентификатор DNS-записи.

type Строка

Тип DNS-записи.

Возможные значения:

  • SRV;
  • TXT;
  • NS;
  • MX;
  • SOA;
  • A;
  • AAAA;
  • CNAME.

domain Строка

Имя домена.

fqdn Строка

Полностью определенное имя домена (FQDN).

ttl Число

Время жизни DNS-записи в секундах.

subdomain Строка

Имя поддомена. Например, «my.domain.com» — имя поддомена домена «domain.com». Вместо «my.domain.com» можно использовать «my».

content Строка

Содержимое DNS-записи.

priority Число

Приоритет DNS-записи. Существует для MX и SRV-записей. Для остальных DNS-записей возвращается пустая строка.

operation Строка

Текущее действие, совершаемое с DNS-записью. Возможно только одно значение — editing.