Modems

Get all modems

GET https://mobile.proxy-seller.com/api/v1/modems

This request will return all your modems

Example

https://mobile.proxy-seller.com/api/v1/modems

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

[
  {
    "id": "63c234098746e15666325bf9f",
    "ip": "",
    "use": false,
    "status": "DOWN",
    "ipProxy": "101.111.44.191",
    "portHttp": "40303",
    "portSocks": "50303",
    "simProvider": "MTS UKR",
    "simNumber": null,
    "hostId": "21vjv1224n45v7457mvcas"
  }
]

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

Change modem IP

PATCH https://mobile.proxy-seller.com/api/v1/modems/{modemId}/change-ip

This request changes the IP of the specified modem.

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/change-ip

Path parameters

Name	Type	Description
modemId*	String	id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Request body

Name	Type	Description
value*	String	ip address to be set on the modem

Example request body:

{
  "value": "127.0.0.1"
}

Response

200

true

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

400

INVALID_MODEM_ID,
INVALID_IP_ADDRESS

404

INVALID_MODEM

Set modem on PAUSE

POST https://mobile.proxy-seller.com/api/v1/modems/{modemId}/pause

This request pauses the modem's operation

Example

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/pause

Path parameters

Name	Type	Description
modemId*	String	id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

{
  "success": false,
  "response": "modem-already-unused",
  "code": 0
}

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

404

MODEM_NOT_FOUND,
(body can content error description, if error on pause occurred)

UNPAUSE modem

POST https://mobile.proxy-seller.com/api/v1/modems/{modemId}/unpause

This request resumes the modem on pause

Example

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/unpause

Path parameters

Name	Type	Description
modemId*	String	Id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

{
  "success": false,
  "response": "modem-already-used",
  "code": 0
}

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

404

MODEM_NOT_FOUND,
(body can content error description, if error on pause occurred)

Reboot modem

Reboot a specific modem.

PATCH https://mobile.proxy-seller.com/api/v1/modems/{modemId}/reboot

This request reboot selected modem.

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/reboot

Path parameters

Name	Type	Description
modemId*	String	id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

successful answer has no body, the success state is determined by the status 200

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

Modem rotation

Set or change rotation settings on your modem.

POST https://mobile.proxy-seller.com/api/v1/modems/{modemId}/rotation

This request set or change modem rotation.

Example

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/rotation

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Query parameters

Name	Type	Description
rotation*	Number	rotation time on min

If you set 5 min rotation modem will change rotaton every 5 min.

If the rotation is not set, it will be reset

Example request with query

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/rotation?rotation=5

Response

200

successful answer has no body, the success state is determined by the status 200

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

404

INVALID_MODEM

Modem authorizations

Get modem authorization.

GET https://mobile.proxy-seller.com/api/v1/modems/{modemId}/auths

This request returns all authorizations that are set on the modem

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/auths

Path parameters

Name	Type	Description
modemId*	String	Id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

[
  {
    "id": "62326bcaf3904578675f9ef7",
    "authType": "LOGIN",
    "login": "jAck",
    "password": "re456pas",
    "ip": ""
  }
]

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

404

 INVALID_MODEM

Limit for modems

If you need to set a speed or traffic limit within the modem.

POST https://mobile.proxy-seller.com/api/v1/modems/proxyLimit

This request sets limits on the modem.

Attention! If the modem has authorizations (users) and proxy limits are set on at least one of them, at the moment of setting limits on the modem, all limits from authorizations will be reset

Example

https://mobile.proxy-seller.com/api/v1/modems/proxyLimit

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Request body

Name	Type	Description
modemIds*	Array of string	Array of modem id
speedLimit*	Number	modem speed limit in bits
trafficLimit*	Number	traffic speed limit in bits
outOfLimitNotifications*	Boolean	to notify me of the end of the limit?

Example request body

{
    "modemIds": ["63c234098746e15666325bf9f"],
    "speedLimit": 209715200,
    "trafficLimit" 4294967296,
    "outOfLimitNotifications": false
}

Response

200

{
  "failedModems": []
}

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH,
MODEM_${id}_HAVE_INSUFFICIENT_PRIVELIGIES

400

INVALID_MODEM_IDS

404

MODEM_NOT_FOUND, RATE_NOT_FOUND

Send a report

If you encounter a problem with your modem, please submit a report.

POST https://mobile.proxy-seller.com/api/v1/modems/report

This point sends a report of a problem with one or more modems.

Example

https://mobile.proxy-seller.com/api/v1/modems/report

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Request body

Name	Type	Description
hostId*	String	id of host
modemIds*	Array of string	Array of modem id
description*	String	description of problem with modem
locale*	string	language, at now you can sent "en"

Example request body

{
    "hostId": "21vjv1224n45v7457mvcas",
    "modemIds": [
        "63c234098746e15666325bf9f"
    ],
    "description": "not working",
    "locale": "en"
}

Response

200

successful answer has no body, the success state is determined by the status 200

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

404

MODEM_${id}_NOT_FOUND

Delete modems limits

DELETE https://mobile.proxy-seller.com/api/v1/modems/{modemId}/proxyLimits

This request removes all set limits from the modem.

Example

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f/proxyLimits

Path parameters

Name	Type	Description
modemId*	String	id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

true

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH

Delete modem

DELETE https://mobile.proxy-seller.com/api/v1/modems/{modemId}

This request removes modem.

Be careful it can cause irreversible effects.

Example

https://mobile.proxy-seller.com/api/v1/modems/63c234098746e15666325bf9f

Path parameters

Name	Type	Description
modemId*	String	id of modem

Headers

Name	Value
Content-Type	application/json
Authorization*	<YOUR_API_TOKEN>

Response

200

successful answer has no body, the success state is determined by the status 200

401

AUTHORIZATION_FAILED,
IP_AUTHORIZATION_FAILED,
HOST_USER_ID_AND_AUTH_DOES_NOT_MATCH