Residential Proxies

Операции для резидентских прокси

Купить дополнительный трафик (Residential)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Body

application/json

amountintegerRequired

Объём в ГБ

Example: 5

promo_codestring · nullableOptional

Responses

200

Успешно

application/json

successbooleanRequired

post

/user/api/orders/{id}/add-bandwidth

HTTPcURLJavaScriptPython

POST /user/api/orders/{id}/add-bandwidth HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "amount": 5,
  "promo_code": "text"
}

200

Успешно

{
  "success": true
}

Список саб-пользователей

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

offsetintegerRequiredExample: 0

limitintegerRequiredExample: 20

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

get

/user/api/proxies/sub-users

HTTPcURLJavaScriptPython

GET /user/api/proxies/sub-users HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "offset": 0,
  "limit": 20
}

200

Успешно

{
  "success": true,
  "data": {}
}

Получить саб-пользователя по ID

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

get

/user/api/proxies/sub-user/{user_id}

HTTPcURLJavaScriptPython

GET /user/api/proxies/sub-user/{user_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Успешно

{
  "success": true,
  "data": {}
}

Удалить саб-пользователя

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

delete

/user/api/proxies/sub-user/{user_id}

HTTPcURLJavaScriptPython

DELETE /user/api/proxies/sub-user/{user_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Успешно

{
  "success": true,
  "data": {}
}

Редактировать саб-пользователя (имя/пакет)

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Body

application/json

proxy_typestringRequired

standart | premium

Example: standart

namestringRequired

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

patch

/user/api/proxies/sub-user/{user_id}

HTTPcURLJavaScriptPython

PATCH /user/api/proxies/sub-user/{user_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "proxy_type": "standart",
  "name": "text"
}

200

Успешно

{
  "success": true,
  "data": {}
}

Создать саб-пользователя

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

proxy_typestringRequiredExample: standart

namestringRequired

dataintegerRequired

Объём в ГБ

Example: 5

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

post

/user/api/proxies/sub-user

HTTPcURLJavaScriptPython

POST /user/api/proxies/sub-user HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "proxy_type": "standart",
  "name": "text",
  "data": 5
}

200

Успешно

{
  "success": true,
  "data": {}
}

Добавить трафик саб-пользователю

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Body

application/json

proxy_typestringRequiredExample: standart

dataintegerRequired

Объём в ГБ

Example: 5

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

post

/user/api/proxies/sub-user/{user_id}/data/add

HTTPcURLJavaScriptPython

POST /user/api/proxies/sub-user/{user_id}/data/add HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "proxy_type": "standart",
  "data": 5
}

200

Успешно

{
  "success": true,
  "data": {}
}

Списать трафик у саб-пользователя

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Body

application/json

proxy_typestringRequiredExample: standart

dataintegerRequired

Объём в ГБ

Example: 5

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

post

/user/api/proxies/sub-user/{user_id}/data/subtract

HTTPcURLJavaScriptPython

POST /user/api/proxies/sub-user/{user_id}/data/subtract HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "proxy_type": "standart",
  "data": 5
}

200

Успешно

{
  "success": true,
  "data": {}
}

Сменить пароль саб-пользователя

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Body

application/json

proxy_typestringRequiredExample: standart

Responses

200

Успешно

application/json

successbooleanOptional

dataobjectOptional

post

/user/api/proxies/sub-user/{user_id}/password

HTTPcURLJavaScriptPython

POST /user/api/proxies/sub-user/{user_id}/password HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "proxy_type": "standart"
}

200

Успешно

{
  "success": true,
  "data": {}
}