Proxies
Add a proxy
Use this API to add a proxy to your account.
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
The proxy name
My Proxy
Proxy added successfully
Unauthorized access
Your plan does not have API access
Proxy not supported by TexAu
Requested workspace does not belongs to you
Error occurred in adding proxy
POST /api/v1/public/proxies HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"name": "My Proxy",
"credentials": {
"ip": "171.76.224.31",
"port": "8080",
"username": "username",
"password": "password"
}
}
{
"success": true,
"message": "Proxy added successfully",
"data": {
"id": "The proxy ID",
"name": "The proxy name",
"location": {
"city": "London",
"region": "England",
"country": "United Kingdom",
"countryCode": "GB"
},
"credentials": {
"ip": "http://94.131.28.88",
"port": "29842",
"username": "amazah",
"password": "dMWP4DKef"
},
"type": "static|rotating"
}
}
Buy a proxy
Use this API to buy a proxy for connected account.
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Proxy purchased successfully
Unauthorized access
Your plan does not have API access
Requested workspace does not belongs to you
Error occurred in purchasing proxy
POST /api/v1/public/proxies/buy HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"connectedAccountId": "text"
}
{
"success": true,
"message": "Proxy added successfully",
"data": {
"id": "The proxy ID",
"name": "The proxy name",
"location": {
"city": "London",
"region": "England",
"country": "United Kingdom",
"countryCode": "GB"
},
"credentials": {
"ip": "http://94.131.28.88",
"port": "29842",
"username": "amazah",
"password": "dMWP4DKef"
},
"type": "static|rotating"
}
}
Update a proxy
Use this API to update proxy credentials, in case it gets expired or updated from provider
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
The proxy name
My Proxy
Proxy update successful
Unauthorized access
Your plan does not have API access
Proxy does not exist
Proxy not supported by TexAu
Requested workspace does not belongs to you
Error occurred while updating the proxy
PUT /api/v1/public/proxies/{proxyId} HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"name": "My Proxy",
"credentials": {
"ip": "171.76.224.31",
"port": "8080",
"username": "username",
"password": "password"
}
}
{
"success": true,
"message": "Proxy update successful",
"data": {
"id": "The proxy ID"
}
}
List all proxies
This API will be used for listing all proxies of your account by their name
The page No
0
The Page Size
10
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Proxies fetch successful
Unauthorized access
Your plan does not have API access
Proxy does not exist
Requested workspace does not belongs to you
Error in fetching proxies
GET /api/v1/public/proxies HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*
{
"success": true,
"message": "Proxies fetch successful",
"total": 1,
"data": [
{
"id": "The proxy ID",
"name": "The proxy name",
"isUsable": true
}
]
}
Get proxy by ID
This API will be used to get location
and credentials
of proxy by ID
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Proxies fetch successful
Unauthorized access
Your plan does not have API access
Proxy does not exist
Requested workspace does not belongs to you
Error in fetching proxies
GET /api/v1/public/proxies/{proxyId} HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*
{
"success": true,
"message": "Execution fetched successfully",
"data": {
"id": "The proxy ID",
"name": "The proxy name",
"isUsable": true,
"credentials": {
"ip": "http://94.131.28.88",
"port": "29842",
"username": "amazah",
"password": "dMWP4DKef"
},
"location": {
"city": "London",
"region": "England",
"country": "United Kingdom",
"countryCode": "GB"
}
}
}
Delete proxy by ID
This API will be used to delete proxy from your TexAu account
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Proxy deleted successfully
Unauthorized access
Your plan does not have API access
Proxy does not exist
Proxy in use, cannot be deleted
Requested workspace does not belongs to you
Error in deleting proxy
DELETE /api/v1/public/proxies/{proxyId} HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*
{
"success": true,
"message": "Proxy deleted successfully"
}
Last updated