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

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

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

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

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

POST /api2/admin/dns/edit
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...

domain=<имя домена>
&record_id=<идентификатор записи>
[&admin_mail=<email-адрес администратора>]
[&content=<содержимое записи>]
[&priority=<приоритет записи>]
[&weight=<вес SRV-записи>]
[&port=<порт хоста>]
[&target=<каноническое имя хоста>]
[&subdomain=<имя поддомена>]
[&ttl=<время жизни записи>]
[&refresh=<время между обновлениями>]
[&retry=<время между попытками получить записи>]
[&expire=<предельное время>]
[&neg_cache=<время кеширования>]

Заголовки:

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

ПДД-токен.
Название Описание
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-записи.
Параметр Тип Значение
Обязательные
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'

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

{
  "domain": "{имя домена}", 
  "record_id": "{идентификатор записи}",  
  "record":
  {
    "record_id": "{идентификатор записи}",
    "type": "{тип записи}",     
    "domain": "{имя домена}"
    "fqdn": {"полное имя домена"},    
    "ttl": "{время жизни записи}",     
    "subdomain": "{имя поддомена}",     
    "content": "{содержимое записи}",
    "priority": "{приоритет записи}",
    "operation": "{editing}"    
  },
  "success": "{статус выполнения запроса}"
}
Название Тип значения Описание
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.
Название Тип значения Описание
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.