Get IP Whitelist

GET/web/v1/system/security/ip-whitelist JWT

Retrieves the authenticated user's IP whitelist configuration, including whether enforcement is enabled and the list of whitelisted entries.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token

Request Parameters

No request parameters required.

Request Example

No request body required.

Success Response

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "enabled": true,
    "entries": [
      "192.168.1.0/24",
      "10.0.0.1"
    ]
  }
}

Field	Type	Description
enabled	boolean	Whether IP whitelist enforcement is currently active
entries	string[]	List of whitelisted IP addresses and/or CIDR ranges

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

• Returns both the enforcement status and the whitelist entries.
• Entries support exact IP addresses (e.g. "10.0.0.1") and CIDR notation (e.g. "192.168.1.0/24").
• Use Enable IP Whitelist / Disable IP Whitelist to toggle enforcement.
• Use Replace IP Whitelist to update entries.