Метод PutEmailIdentityDkimSigningAttributes
Перепроверяет DKIM-подпись адреса в каталоге и возвращает ее статус. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Важно
В Yandex Cloud Postbox метод работает не так, как в Amazon SES: он не изменяет настройки DKIM-подписи, а только синхронно проверяет DNS-записи DKIM. Изменить способ настройки DKIM-подписи или ее параметры с помощью метода нельзя.
Запрос
PUT /v2/email/identities/{EmailIdentity}/dkim/signing HTTP/2
Path-параметры
|
Параметр |
Описание |
|
|
Тип: string. Адрес, DKIM-подпись которого нужно перепроверить. |
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"SigningAttributesOrigin": "AWS_SES|EXTERNAL"
}
|
Параметр |
Описание |
|
|
Тип: string. Способ настройки DKIM-подписи адреса. Возможные значения:
Значение должно совпадать с текущим способом настройки DKIM-подписи адреса. Его можно узнать в поле Обязательный параметр. |
Параметр SigningAttributes не поддерживается. Если передать его в запросе, метод вернет ошибку 400 BadRequestException.
Ответы
200 OK
{
"DkimStatus": "<статус_DKIM>",
"DkimTokens": [
"<селектор_для_открытого_ключа>"
]
}
|
Параметр |
Описание |
|
|
Тип: string. Результат проверки DKIM-подписи в DNS-конфигурации адреса. Возможные значения:
|
|
|
Тип: array. Список селекторов для идентификации открытого ключа. Тип для селектора: string. |
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе неправильно указаны заголовки или параметры. Также возвращается, если передан параметр |
|
|
Адрес не найден. |
|
|
При вызове запроса превышена квота. |