Proxies

Add a proxy

Use this API to add a proxy to your account.

post

/api/v1/public/proxies

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

namestringrequired

credentialsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/proxies' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "credentials": {
      "ip": "text",
      "port": "text",
      "username": "text",
      "password": "text"
    }
  }'

201

401

403

406

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "location": {
      "city": "text",
      "region": "text",
      "country": "text",
      "countryCode": "text"
    },
    "credentials": {
      "ip": "text",
      "port": "text",
      "username": "text",
      "password": "text"
    },
    "type": "text"
  }
}

Proxy added successfully

Buy a proxy

Use this API to buy a proxy for connected account.

post

/api/v1/public/proxies/buy

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

connectedAccountIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/proxies/buy' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "connectedAccountId": "text"
  }'

201

401

403

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "location": {
      "city": "text",
      "region": "text",
      "country": "text",
      "countryCode": "text"
    },
    "credentials": {
      "ip": "text",
      "port": "text",
      "username": "text",
      "password": "text"
    },
    "type": "text"
  }
}

Proxy purchased successfully

Update a proxy

Use this API to update proxy credentials, in case it gets expired or updated from provider

put

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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

namestring

credentialsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/public/proxies/{proxyId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "credentials": {
      "ip": "text",
      "port": "text",
      "username": "text",
      "password": "text"
    }
  }'

200

401

403

404

406

422

500

200

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text"
  }
}

Proxy update successful

List all proxies

This API will be used for listing all proxies of your account by their name

get

/api/v1/public/proxies

Authorizations

Query parameters

startnumber

limitnumber

Header parameters

X-TexAu-Contextstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/proxies' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "text",
  "total": 1,
  "data": [
    {
      "id": "text",
      "name": "text",
      "isUsable": true
    }
  ]
}

Proxies fetch successful

Get proxy by ID

This API will be used to get location and credentials of proxy by ID

get

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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/proxies/{proxyId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "isUsable": true,
    "credentials": {
      "ip": "text",
      "port": "text",
      "username": "text",
      "password": "text"
    },
    "location": {
      "city": "text",
      "region": "text",
      "country": "text",
      "countryCode": "text"
    }
  }
}

Proxies fetch successful

Delete proxy by ID

This API will be used to delete proxy from your TexAu account

delete

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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/proxies/{proxyId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

412

422

500

200

{
  "success": true,
  "message": "text"
}

Proxy deleted successfully