DKIMドメイン取得

指定されたドメインとセレクタに該当する登録済みDKIMドメイン情報を返す。

セレクタを指定せずにドメインのみ指定した場合はドメインに該当する登録済みDKIMドメイン情報の一覧を返す。

存在しないドメインもしくはセレクタが指定された場合空のデータを返す。

リクエスト

エンドポイント

/v1/domains/authentications?domain=[URLエンコードしたドメイン]&selector=[URLエンコードしたセレクタ]

HTTPメソッド

GET

リクエストボディ

なし

レスポンス

ステータスコード
状態
コード
成功 200
クエリパラメータのバリデーションエラー 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
要素名
要素数
説明
code 数値 1 ステータスコード
domain 文字列 1 ドメイン
selector 文字列 1 セレクタ
public_key 文字列 1 公開鍵
type 文字列 1 AUTHENTICATION 固定
status 文字列 1 VALIDATED 検証済
VALIDATING 未検証
default 真偽値 1 優先的に署名に使用するセレクタかどうか
bit_size 数値 1 鍵のビット長

 

要素名
要素数
説明
code 数値 1 ステータスコード
data ドメイン型の配列 0:*  
ドメイン
要素名
要素数
説明
domain 文字列 1 ドメイン
selector 文字列 1 セレクタ
public_key 文字列 1 公開鍵
type 文字列 1 AUTHENTICATION 固定
status 文字列 1

VALIDATED 検証済
VALIDATING 未検証

default 真偽値 1 優先的に署名に使用するセレクタかどうか
bit_size 数値 1 鍵のビット長
 

成功

{"code": 200, "domain":"example.com","selector":"selectorhere","public_key":"XXXXXXXXXXXXXXXX","type":"AUTHENTICATION","status":"VALIDATED","default":false,"bit_size":2048}

 

{
  "code": 200,
  "data": [
    {"domain":"example.com","selector":"selector1","public_key":"XXXXXXXXXXXXXXXX","type":"AUTHENTICATION","status":"VALIDATED","default":true,"bit_size":1024},
    {"domain":"example.com","selector":"selector2","public_key":"YYYYYYYYYYYYYYYY","type":"AUTHENTICATION","status":"VALIDATING","default":false,"bit_size":2048}
  ]
}

 
失敗

{"code":404,"error":"resource not found"}