API For User-Pass

List sub-users

get

Returns a paginated list of sub-users for the authenticated account, with support for keyword search by user_name, as well as sorting and ordering.

Authorizations

api_key

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', 'user_name', 'status', 'created_at', 'use_key', 'usage_cap', 'data_used', 'ip_usage_cap', 'ip_used'. Default: id

order_bystringOptional

Sort order: desc or asc. Default: desc

keywordstringOptional

Keyword to search within the user_name field.

Responses

200

Successful response

application/json

Sub-users 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/user-passes/get-list

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "message": "text",
  "result": {
    "items": [
      {
        "id": 1,
        "user_name": "text",
        "use_key": "text",
        "usage_cap": 1,
        "ip_usage_cap": 1,
        "data_used": 1,
        "ip_used": 1,
        "status": 1,
        "note": "text",
        "created_at": 1,
        "updated_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1
  }
}

Create sub-user

post

Creates a new sub-user (User-Pass credentials) and optionally applies traffic and IP usage limits.

Authorizations

api_key

api-keystringRequired

Body

application/json

user_namestringRequired

Sub-user username.

Example: user_1

use_keystringRequired

Sub-user password.

Example: pass_123

statusintegerRequired

Sub-user status. 1: active, 2: disable

Example: 1

notestringOptional

Optional note for internal tracking.

Example: This is Sub User 1

usage_capintegerOptional

Traffic usage cap in bytes.

Example: 1000000000

ip_usage_capintegerOptional

IP usage cap (-1 for unlimited).

Example: -1

Responses

200

Successful response

application/json

Sub-user 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/user-passes/create

HTTPcURLJavaScriptPython

POST /client/v1/user-passes/create HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "user_name": "user_1",
  "use_key": "pass_123",
  "status": 1,
  "note": "This is Sub User 1",
  "usage_cap": 1000000000,
  "ip_usage_cap": -1
}

{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "user_name": "text",
    "use_key": "text",
    "usage_cap": 1,
    "ip_usage_cap": 1,
    "data_used": 1,
    "ip_used": 1,
    "status": 1,
    "note": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Update sub-user

put

Updates an existing sub-user by ID, including password, status, note, and optional traffic/IP usage caps.

Authorizations

api_key

api-keystringRequired

Body

application/json

idintegerRequired

Sub-user ID to update.

Example: 88

user_namestringOptional

Sub-user username.

Example: user_1

use_keystringRequired

Sub-user password.

Example: pass_123

statusintegerRequired

Sub-user status. 1: active, 2: disable

Example: 1

notestringOptional

Optional note for internal tracking.

Example: This is Sub User 1

usage_capintegerOptional

Traffic usage cap in bytes.

Example: 1000000000

ip_usage_capintegerOptional

IP usage cap (-1 for unlimited).

Example: -1

Responses

200

Successful response

application/json

Sub-user 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/user-passes/update

HTTPcURLJavaScriptPython

PUT /client/v1/user-passes/update HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "id": 88,
  "user_name": "user_1",
  "use_key": "pass_123",
  "status": 1,
  "note": "This is Sub User 1",
  "usage_cap": 1000000000,
  "ip_usage_cap": -1
}

{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "user_name": "text",
    "use_key": "text",
    "usage_cap": 1,
    "ip_usage_cap": 1,
    "data_used": 1,
    "ip_used": 1,
    "status": 1,
    "note": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Delete sub-user

delete

Deletes a sub-user by ID.

Authorizations

api_key

api-keystringRequired

Body

application/json

idintegerRequired

Sub-user ID to delete.

Example: 88

Responses

200

Successful response

application/json

Sub-user 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/user-passes/delete

HTTPcURLJavaScriptPython

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

{
  "id": 88
}

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