v1
latestOpenAPI 3.0.32026-07-2246176.0 KBManage IP whitelist
Manage the IP whitelist for a datacenter subaccount. All four operations share this endpoint via the required type query parameter.
Operations and required permissions:
- get — list current IPs (datacenter_shared:read or datacenter_dedicated:read)
- add — append IPs without removing existing ones (datacenter_shared:write or datacenter_dedicated:write)
- set — replace the entire whitelist (datacenter_shared:write or datacenter_dedicated:write)
- remove — delete specific IPs (datacenter_shared:delete or datacenter_dedicated:delete)
IP label format: For add and set, each ip[] value may include a label prefix separated by a colon: ip[]=Office:1.2.3.4. Everything before the last colon is the label; the last segment is the IP.
Rate limit: Mutations (add, set, remove) are limited to 1 request per 30 minutes per subaccount.
Propagation: After a successful mutation, allow up to 10 minutes for IPs to synchronize across all proxies.
Path parameters
Query parameters
Operation to perform: get reads the current whitelist; add appends IPs to the existing list; set replaces the entire whitelist; remove deletes specific IPs.
One or more public IPv4 addresses to add, set, or remove. Required for add, set, and remove. Each value may include an optional label prefix separated by a colon — e.g. Office:1.2.3.4 sets the label "Office" for that IP. Cannot exceed the account's maxips limit.
[ "Office:1.2.3.4", "5.6.7.8" ]
When present (any value), the get response includes a labels object mapping each whitelisted IP to its assigned label. Has no effect for other operation types.
Response
Operation succeeded. Response shape differs by type.
Example response
{
"status": "ok",
"maxips": 3,
"whitelisted": [
"1.2.3.4",
"5.6.7.8"
],
"labels": {
"1.2.3.4": "Office",
"5.6.7.8": ""
}
}