DKIMセレクタ有効化

DKIM署名用のセレクタを有効化する。

指定されたドメインとセレクタに該当するDKIMドメインのTXTレコードを取得し、TXTレコードが正しい場合のみ有効化される。

有効化する際、指定したドメインに利用可能なセレクタが存在しなかった場合、デフォルトセレクタに設定する。

リクエスト

エンドポイント

/v1/domains/authentications/enable

HTTPメソッド

POST

リクエストボディ

JSON形式であること

要素名
型
要素数
制限
説明
domain 文字列 1

半角英数字 . - 最大253文字
ドメイン形式の文字列であること

 ドメイン
selector 文字列 1 半角英数字 -(ハイフン) .(ピリオド) _(アンダーバー) 最大63文字まで セレクタ
リクエストボディサンプル

{
  "domain": "example.com",
  "selector": "selectorhere",
}

レスポンス

ステータスコード
状態
コード
成功 200
パラメータのバリデーションエラー 400
TXTレコードの検証に失敗 400
指定したセレクタが存在しない 400
既に有効化されている 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504

レスポンスボディ

要素名
型
要素数
説明
code 数値 1 ステータスコード
domain 文字列 1 ドメイン
selector 文字列 1 セレクタ
public_key 文字列 1 公開鍵
status 文字列 1 VALIDATED 固定
default 真偽値 1 優先的に署名に使用するセレクタかどうか
bit_size 数値 1 鍵のビット長
成功

{"bit_size":2048,"code":200,"default":true,"domain":"example.com","public_key":"XXXXXXXXXXXXXXXX","selector":"selectorhere","status":"VALIDATED"

失敗

{"code":400,"validation_errors":{"selector":"required"}}

{"code":400,"validation_errors":{"selector":"txt record not found"}}

{"code":400,"validation_errors":{"selector":"invalid not exists"}}

{"code":400,"validation_errors":{"selector":"already enabled"}}