Skip to Content
webagent docs
API reference

Proxies

Saved proxies for sessions.

Open as .md
GET
/v1/proxies

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Response Body

OK

application/json
  1. response
proxies*array<>
Example Request
curl -X GET 'https://api.us.webagent.lookover.ai/v1/proxies'
Example Response
{  "proxies": [    {      "id": "string",      "name": "string",      "protocol": "http",      "host": "string",      "port": 1,      "username": "string",      "hasPassword": true,      "bypassHosts": [        "string"      ],      "createdAt": 0    }  ]}

Save a proxy

POST
/v1/proxies

Save a proxy. The password is sealed and never returned. 400 invalid_input for a host that is, or resolves to, a private, loopback, link-local or metadata address

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
protocol*string
Value in"http""https""socks5"
host*string
Lengthlength <= 253
port*integer
Range1 <= value <= 65535
username?string
Length1 <= length <= 256
password?string
Length1 <= length <= 256
bypassHosts?array<>
Itemsitems <= 50

Response Body

OK

application/json
  1. response
id*string
Match^prx_(us|in)_[0-9a-z]{24}$
name*string
Length1 <= length <= 100
protocol*string
Value in"http""https""socks5"
host*string
Lengthlength <= 253
port*integer
Range1 <= value <= 65535
username?string
Length1 <= length <= 256
hasPassword*boolean
bypassHosts*array<>
Itemsitems <= 50
createdAt*integer
Range0 <= value <= 9007199254740991
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/proxies' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "protocol": "http",  "host": "string",  "port": 1}'
Example Response
{  "id": "string",  "name": "string",  "protocol": "http",  "host": "string",  "port": 1,  "username": "string",  "hasPassword": true,  "bypassHosts": [    "string"  ],  "createdAt": 0}

Delete a saved proxy

DELETE
/v1/proxies/{id}

Delete a saved proxy. 404 not_found for an unknown or another project's proxy

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

id*string
Match^prx_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
deleted*boolean
Example Request
curl -X DELETE 'https://api.us.webagent.lookover.ai/v1/proxies/string'
Example Response
{  "deleted": true}
POST
/v1/proxies/{id}/test

Test a saved proxy from the API: connects through it and reports {ok, ms, exitIp?, error?}. A failing proxy is a 200 with ok: false and a fixed message. 429 rate_limited per tenant

Authorization

headerAuthorizationBearer <token>

An API key (wa_<region>_…) or a dashboard access token.

Path Parameters

id*string
Match^prx_(us|in)_[0-9a-z]{24}$

Response Body

OK

application/json
  1. response
ok*boolean
ms*integer
Range0 <= value <= 9007199254740991
exitIp?string
Lengthlength <= 45
error?string
Lengthlength <= 500
Example Request
curl -X POST 'https://api.us.webagent.lookover.ai/v1/proxies/string/test'
Example Response
{  "ok": true,  "ms": 0,  "exitIp": "string",  "error": "string"}