機能説明
ダッシュボード、API/SMTPを利用することを許容するIPアドレス範囲を指定します。
許容するIPアドレス範囲に、接続者を含まない設定はエラーとなります。
空文字を指定すると、制限しない設定となります。
指定しない項目は、変更されません。
リクエスト
エンドポイント
/v1/settings/access_limits
HTTPメソッド
POST
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| api_whitelist | 文字列 | 0:1 |
カンマ区切りでIPアドレスを指定する
ハイフンでIPアドレスを範囲で指定する
※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"}}