Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API For Proxy Connect Config

List connection configs

get

Returns a paginated list of proxy connection configurations for the authenticated account, with support for sorting and ordering.

Authorizations
api-keystringRequired
Query parameters
limitintegerOptional

Maximum number of items to return per page.

pageintegerOptional

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

sort_bystringOptional

Field to sort by: 'id', 'start_port', 'end_port', 'created_at', 'updated_at'. Default: start_port

order_bystringOptional

Sort order: desc or asc. Default: desc

Responses
200

Successful response

application/json

Connection configurations list response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

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

{
  "success": true,
  "message": "text",
  "result": {
    "items": [
      {
        "id": 1,
        "user_id": 1,
        "server_id": 1,
        "proxy_type": 1,
        "country_code": null,
        "city_code": null,
        "state_code": null,
        "isp_code": null,
        "start_port": 1,
        "end_port": 1,
        "is_keep": 1,
        "is_random_ip": 1,
        "session_time": "text",
        "created_at": 1,
        "updated_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1
  }
}

Create connection config

post

Creates a new proxy connection configuration by allocating a port range based on the requested quantity and applying optional targeting filters and session settings.

Authorizations
api-keystringRequired
Body
proxy_typeintegerOptional

Proxy type identifier.

Example: 1
country_codestringOptional

Country code used to target proxies.

Example: US
city_codestringOptional

City code used to target proxies.

Example: villa_rica
state_codestringOptional

State/region code used to target proxies.

Example: california
isp_codestringOptional

ISP code used to target proxies.

Example: isp_code
quantityintegerRequired

Number of ports to allocate for this configuration.

Example: 10
session_typeintegerRequired

Session mode. 1: Rotation, 2: Sticky

Example: 2
session_timeintegerOptional

Sticky session duration (minutes).

Example: 33
Responses
200

Successful response

application/json

Connection configuration creation response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

post/client/v1/proxy-connection/create
POST /client/v1/proxy-connection/create HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "proxy_type": 1,
  "country_code": "US",
  "city_code": "villa_rica",
  "state_code": "california",
  "isp_code": "isp_code",
  "quantity": 10,
  "session_type": 2,
  "session_time": 33
}
{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "user_id": 1,
    "server_id": 1,
    "proxy_type": 1,
    "country_code": null,
    "city_code": null,
    "state_code": null,
    "isp_code": null,
    "start_port": 1,
    "end_port": 1,
    "is_keep": 1,
    "is_random_ip": 1,
    "session_time": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Update connection config

put

Updates an existing proxy connection configuration identified by start_port, including targeting filters and session settings.

Authorizations
api-keystringRequired
Body
start_portintegerRequired

Start port of the configuration to update.

Example: 7000
country_codestringOptional

Country code used to target proxies.

Example: US
city_codestringOptional

City code used to target proxies.

Example: villa_rica
state_codestringOptional

State/region code used to target proxies.

Example: california
isp_codestringOptional

ISP code used to target proxies.

Example: isp_code
session_typeintegerRequired

Session mode. 1: Rotation, 2: Sticky

Example: 2
session_timeintegerOptional

Sticky session duration (minutes).

Example: 33
Responses
200

Successful response

application/json

Connection configuration update response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

put/client/v1/proxy-connection/update
PUT /client/v1/proxy-connection/update HTTP/1.1
Host: sandbox.9proxy.com
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "start_port": 7000,
  "country_code": "US",
  "city_code": "villa_rica",
  "state_code": "california",
  "isp_code": "isp_code",
  "session_type": 2,
  "session_time": 33
}
{
  "success": true,
  "message": "text",
  "result": {
    "id": 1,
    "user_id": 1,
    "server_id": 1,
    "proxy_type": 1,
    "country_code": null,
    "city_code": null,
    "state_code": null,
    "isp_code": null,
    "start_port": 1,
    "end_port": 1,
    "is_keep": 1,
    "is_random_ip": 1,
    "session_time": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Delete connection configs

delete

Deletes one or more proxy connection configurations identified by their start_port values.

Authorizations
api-keystringRequired
Body
start_portsinteger[]Required

List of start_port values to delete.

Example: [7000,7001,7005]
Responses
200

Successful response

application/json

Connection configuration deletion response payload.

successbooleanOptional

Indicates whether the request was successful.

messagestringOptional

Human-readable response message.

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

{
  "start_ports": [
    7000,
    7001,
    7005
  ]
}
{
  "success": true,
  "message": "text",
  "result": {
    "deleted": true
  }
}
PreviousAPI For Whitelist
NextClient Development

Last updated

Was this helpful?