API For Whitelist

List whitelist entries

get

Returns a paginated list of whitelist entries for the authenticated account, with support for sorting and ordering.

Authorizations

api-keystringRequired

Query parameters

limitintegerOptional

Maximum number of items to return per page. Default: 30

pageintegerOptional

Requested page number (1-based). Default: 1

sort_bystringOptional

Field to sort by: 'id', 'ip', 'status', 'created_at', 'updated_at', 'description'. Default: id

order_bystringOptional

Sort order: desc or asc. Default: desc

Responses

200

Successful response

application/json

Whitelist entries list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

400

Bad request

application/json

403

Authentication error

application/json

get/client/v1/white-list/get-list

GET /client/v1/white-list/get-list HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*

{
  "success": true,
  "message": "text",
  "result": {
    "items": [
      {
        "id": 1,
        "ip": "text",
        "status": 1,
        "description": "text",
        "created_at": 1,
        "updated_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1
  }
}

Create whitelist entries

post

Creates one or more whitelist entries from the provided list of IP addresses.

Authorizations

api-keystringRequired

Body

ipsstring[]Required

List of IP addresses to add to the whitelist.

Example: ["127.0.0.1","127.0.0.2","127.0.0.3"]

Responses

200

Successful response

application/json

Whitelist creation response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

400

Bad request

application/json

403

Authentication error

application/json

post/client/v1/white-list/create

POST /client/v1/white-list/create HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "ips": [
    "127.0.0.1",
    "127.0.0.2",
    "127.0.0.3"
  ]
}

{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "ip": "text",
    "status": 1,
    "description": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Update whitelist entries

put

Updates one or more whitelist entries by ID, allowing changes to status and description.

Authorizations

api-keystringRequired

Body

idsinteger[]Required

List of whitelist entry IDs.

Example: [111,222,333]

descriptionstringOptional

Description for the whitelist entries.

Example: white list 1

statusintegerOptional

Whitelist entry status. 1: enabled, 2: disabled

Example: 1

Responses

200

Successful response

application/json

Whitelist update response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

400

Bad request

application/json

403

Authentication error

application/json

put/client/v1/white-list/update

PUT /client/v1/white-list/update HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "ids": [
    111,
    222,
    333
  ],
  "description": "white list 1",
  "status": 1
}

{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "ip": "text",
    "status": 1,
    "description": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Delete whitelist entries

delete

Deletes one or more whitelist entries by ID.

Authorizations

api-keystringRequired

Body

idsinteger[]Required

List of whitelist entry IDs.

Example: [111,222,333]

Responses

200

Successful response

application/json

Whitelist deletion response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

400

Bad request

application/json

403

Authentication error

application/json

delete/client/v1/white-list/delete

DELETE /client/v1/white-list/delete HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "ids": [
    111,
    222,
    333
  ]
}

{
  "success": true,
  "message": "text",
  "result": {
    "deleted": true
  }
}