Add a basic proxy

POST

/api/proxy/createBaseProxy

Add proxy information. The added proxy can be used for assigning to a profile.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Header Params

Body Params application/json

Example

{
    "protocol": "socks5",
    "host": "127.0.0.1",
    "port": 10809,
    "proxyUsername": "name",
    "proxyPassword": "pass",
    "rotateUrl": "https://testip.com",
    "repeatItem": false,
    "publicViewing": 0,
    "proxyMethod": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1:30898/api/proxy/createBaseProxy' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "protocol": "socks5",
    "host": "127.0.0.1",
    "port": 10809,
    "proxyUsername": "name",
    "proxyPassword": "pass",
    "rotateUrl": "https://testip.com",
    "repeatItem": false,
    "publicViewing": 0,
    "proxyMethod": 0
}'

Responses

🟢200OK

Default Response

This response does not have a body.

Example

{
    "duplicateCheck": false,
    "host": "127.0.0.1",
    "id": "df9264933e9b4981aaa00036faa28e6e",
    "isGlobalProxyInfo": false,
    "isIpNoChange": false,
    "mainUserId": "2c92b02392f6578a0192fae0e33d000b",
    "port": 10809,
    "protocol": "socks5",
    "proxyMethod": 0,
    "proxyPassword": "ef60cf3c6eecc42cc9a719d0d6dca767da7052e321311db7e02dea73b6acc37d@456bitbrowser",
    "proxyUsername": "name",
    "publicViewing": 0,
    "repeatItem": false,
    "rotateUrl": "https://testip.com",
    "userId": "2c92b02392f6578a0192fae0e33d000b"
}

🟠400Bad request

Modified at 2025-08-16 06:45:36

Proxy detect

Update basic proxy