Proxies

Add a proxy

Use this API to add a proxy to your account.

post
Authorizations
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body
namestringRequired

The proxy name

Example: My Proxy
Responses
201
Proxy added successfully
application/json
post
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.

post
Authorizations
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body
connectedAccountIdstringRequired
Responses
201
Proxy purchased successfully
application/json
post
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

put
Authorizations
Path parameters
proxyIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body
namestringOptional

The proxy name

Example: My Proxy
Responses
200
Proxy update successful
application/json
put
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

get
Authorizations
Query parameters
startnumberOptional

The page No

Example: 0
limitnumber · min: 1 · max: 50Optional

The Page Size

Example: 10
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses
200
Proxies fetch successful
application/json
get
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

get
Authorizations
Path parameters
proxyIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses
200
Proxies fetch successful
application/json
get
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

delete
Authorizations
Path parameters
proxyIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses
200
Proxy deleted successfully
application/json
delete
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