許容IPアドレス設定更新

ダッシュボード、API/SMTPを利用することを許可するIPアドレス範囲を指定する。

許容範囲に接続者を含まないような設定はエラーとなる。

空文字を指定すると制限なし扱いとなる。

指定しない項目は変更しない。

リクエスト

エンドポイント

/v1/settings/access_limits

HTTPメソッド

POST

リクエストボディ

JSON形式であること

要素名
型
要素数
制限
説明
api_whitelist 文字列 0:1

カンマ区切りでIPアドレスを指定する
例 192.168.0.1,192.168.0.2
範囲としての指定も可能
例 192.168.0.1-192.168.0.254
APIから設定する場合、この欄には接続者のIPアドレスを含む必要がある

 API/SMTPの利用を許容するIPアドレス範囲を指定する
dashboard_whitelist 文字列 0:1

同上

 ダッシュボードの利用を許容するIPアドレス範囲を指定する
smtp_whitelist 文字列 0:1

同上

 SMTPリレーの利用を許容するIPアドレス範囲を指定する
リクエストボディ サンプル

{
  "api_whitelist": "192.168.0.1,192.168.0.5-192.168.0.200",
  "dashboard_whitelist": "192.168.0.1,192.168.0.5-192.168.0.200",
  "smtp_whitelist": "192.168.0.1,192.168.0.5-192.168.0.100"
}

{
  "api_whitelist": "192.168.0.1,192.168.0.5-192.168.0.200"
}

レスポンス

ステータスコード
状態
コード
成功 200
リクエストボディがjsonではない 400
jsonリクエストのバリデーションエラー 400
設定が接続者を弾くようなものになっている場合 400
認証失敗 401
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
成功

{
  "code":200,
  "data":[
    {"api_whitelist":"192.168.0.1,192.168.0.5-192.168.0.20"},
    {"dashboard_whitelist":"192.168.0.1,192.168.0.5-192.168.0.20"},
    {"smtp_whitelist":"192.168.0.1-192.168.0.100"}
  ]
}

失敗

{"code":400,"data_error":{"data":"invalid format"}}

{"code":400,"validation_errors":{"api_whitelist":"invalid format"}}

{"code":400,"validation_errors":{"api_whitelist":"api whitelist must include your IP address, your IP address is 192.168.0.1"}}