XProxy Official
  1. Rotation (Change IP)
XProxy Official
  • API document for XProxy service
  • Proxy Management
    • Get the list of devices & proxies information
      GET
    • Get status of a specific proxy
      GET
    • Get status of a specific position
      GET
    • Reboot dongle with specific proxy
      GET
    • Reboot dongle with specific position
      GET
  • Device Management
    • Change IMEI for multiple dongles
      POST
    • Add or change device note
      POST
    • Change MAC address for dongles
      POST
    • Change APN for dongles
      POST
    • Change device label
      POST
    • Connect dongle to network
      POST
    • Enable/disable WiFi for multiple dongles
      POST
    • Disconnect dongle from network
      POST
    • Reboot a specific dongle
      POST
    • Reset bus dongle
      POST
    • Get dongle information including phone number
      POST
    • Set MTU value for a dongle
      POST
  • Rotation (Change IP)
    • Manual rotation :: Rotate IP for a specific proxy or SOCKS port
      GET
    • Manual rotation :: Rotate IP for a specific position of modem in list
      GET
    • Auto rotation :: Add a rotation schedule job
      POST
    • Auto rotation :: Retrieve scheduled rotation jobs
      POST
  • Selling Platform
    • Get list of selling proxies
      GET
    • Generate selling proxies
      POST
    • Editing for single selling proxy port
      POST
    • Delete selling proxy by ID
      POST
  • SMS & USSD Utitlies
    • SMS
      • Read SMS messages
      • Send SMS message
      • Delete SMS messages
    • USSD
      • Send USSD command
      • Read USSD response
  • System Management
    • Restart XProxy Panel
    • Reboot XProxy System
  1. Rotation (Change IP)

Auto rotation :: Add a rotation schedule job

POST
{{BASE_URL}}/v2/schedule/rotation_add_job
This endpoint allows you to add a rotation schedule job.

Request

Body Params application/json
run_per_day
enum<string> 
optional
Defines if the job runs forever or during a specific time range.
Allowed values:
foreverrange
Example:
forever
positions
array[integer]
optional
An array of modem positions in the device list to apply the schedule to.
Example:
[1]
interval
integer 
optional
The time interval between each rotation.
Example:
5
unit
enum<string> 
optional
The time unit for the interval.
Allowed values:
minutessecondshours
Example:
minutes
specific_time
string 
optional
The specific time of day to run the job (in hh:mm format).
Example:
00:00
start_time
string  | null 
optional
The start time of the schedule (hh:mm:ss).
Example:
null
end_time
string  | null 
optional
The end time of the schedule (hh:mm:ss).
Example:
null
Example
{
  "run_per_day": "forever",
  "positions": [
    1
  ],
  "interval": 5,
  "unit": "minutes",
  "specific_time": "00:00",
  "start_time": null,
  "end_time": null
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://localhost/v2/schedule/rotation_add_job' \
--header 'Content-Type: application/json' \
--data-raw '{
    "run_per_day": "forever",
    "positions": [
        1
    ],
    "interval": 5,
    "unit": "minutes",
    "specific_time": "00:00",
    "start_time": null,
    "end_time": null
}'

Responses

🟢200OK
application/json
Schedule rotation added successfully.
Body
status
boolean 
optional
Example:
true
msg
string 
optional
Example:
Schedule rotation added successfully!
Example
{
  "status": true,
  "msg": "Schedule rotation added successfully!"
}
🟠400Bad Request
🔴500Server Error
Modified at 2025-04-23 02:56:40
Previous
Manual rotation :: Rotate IP for a specific position of modem in list
Next
Auto rotation :: Retrieve scheduled rotation jobs
Built with