Proxies

Add a proxy

Use this API to add a proxy to your account.

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

namestringRequired

The proxy name

Example: My Proxy

Responses

201

Proxy added successfully

application/json

successbooleanRequired

messagestringRequiredExample: Proxy added successfully

401

Unauthorized access

403

Your plan does not have API access

406

Proxy not supported by TexAu

422

Requested workspace does not belongs to you

500

Error occurred in adding proxy

post

/api/v1/public/proxies

HTTPcURLJavaScriptPython

POST /api/v1/public/proxies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

connectedAccountIdstringRequired

Responses

201

Proxy purchased successfully

application/json

successbooleanRequired

messagestringRequiredExample: Proxy added successfully

401

Unauthorized access

403

Your plan does not have API access

422

Requested workspace does not belongs to you

500

Error occurred in purchasing proxy

post

/api/v1/public/proxies/buy

HTTPcURLJavaScriptPython

POST /api/v1/public/proxies/buy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

proxyIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

namestringOptional

The proxy name

Example: My Proxy

Responses

200

Proxy update successful

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Proxy does not exist

406

Proxy not supported by TexAu

422

Requested workspace does not belongs to you

500

Error occurred while updating the proxy

put

/api/v1/public/proxies/{proxyId}

HTTPcURLJavaScriptPython

PUT /api/v1/public/proxies/{proxyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

401

Unauthorized access

403

Your plan does not have API access

404

Proxy does not exist

422

Requested workspace does not belongs to you

500

Error in fetching proxies

get

/api/v1/public/proxies

HTTPcURLJavaScriptPython

GET /api/v1/public/proxies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

proxyIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Proxies fetch successful

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Proxy does not exist

422

Requested workspace does not belongs to you

500

Error in fetching proxies

get

/api/v1/public/proxies/{proxyId}

HTTPcURLJavaScriptPython

GET /api/v1/public/proxies/{proxyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

proxyIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Proxy deleted successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Proxy does not exist

412

Proxy in use, cannot be deleted

422

Requested workspace does not belongs to you

500

Error in deleting proxy

delete

/api/v1/public/proxies/{proxyId}

HTTPcURLJavaScriptPython

DELETE /api/v1/public/proxies/{proxyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Proxy deleted successfully"
}