Datacenter

Manage 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.

GET

account

{subAccountId}

datacenter_shared

whitelist

Manage IP whitelist

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/{subAccountId}/datacenter_shared/whitelist \
  --header 'api-token: <api-key>'

{
  "status": "ok",
  "maxips": 3,
  "whitelisted": [
    "1.2.3.4",
    "5.6.7.8"
  ],
  "labels": {
    "1.2.3.4": "Office",
    "5.6.7.8": ""
  }
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Path Parameters

subAccountId

string<uuid>

required

Query Parameters

type

enum<string>

required

Operation to perform: get reads the current whitelist; add appends IPs to the existing list; set replaces the entire whitelist; remove deletes specific IPs.

Available options:

get,

add,

remove,

set

ip[]

string[]

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.

Example:

["Office:1.2.3.4", "5.6.7.8"]

labels

string

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.

Get response (type=get)
Mutation response (type=add, set, remove)

status

string

required

Example:

"ok"

maxips

integer

required

Maximum number of IPs this account is allowed to whitelist.

Example:

3

whitelisted

string[]

required

Currently whitelisted IP addresses.

Example:

["1.2.3.4", "5.6.7.8"]

labels

object

Present only when the labels query parameter is included. Maps each whitelisted IP to its label; IPs without a label have an empty string value.

Show child attributes

Example:

{ "1.2.3.4": "Office", "5.6.7.8": "" }

Datacenter overviewGet datacenter subscription overview for a subaccount: plan details, proxy count, status, and expiration. Permission: `datacenter_shared:read` or `datacenter_dedicated:read`.

Manage IP whitelist

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/{subAccountId}/datacenter_shared/whitelist \
  --header 'api-token: <api-key>'

{
  "status": "ok",
  "maxips": 3,
  "whitelisted": [
    "1.2.3.4",
    "5.6.7.8"
  ],
  "labels": {
    "1.2.3.4": "Office",
    "5.6.7.8": ""
  }
}