Order operations

Order operations

post

Execute an operation. The list of allowed operations is returned by get /user/orders, in the "allowed_operations" field

Authorizations

api-key

Path parameters

order_idintegerRequiredExample: 10000

Body

application/json

operationstring · enumRequired

Operation code

• channels-change-ip Change dynamic IP address
• channels-reset Reboot modem
• channels-set-autoreset Set automatic reboot interval for mobile modem
• channels-relocate Change equipment: channel "moves" to another modem within the selected location
• server-start Start server
• server-stop Stop server
• server-reboot Reboot server
• server-reset Cold reset of the server

Example: channels-resetPossible values:

channelsinteger[]Optional

Optional list of channel IDs for channels-* operations If not specified, all channels in the order are implied

Example: [1401,1402]

location_idintegerOptional

Optional desired location ID for "channels-relocate" Only for "Mobile proxies +" plan with multiport option

Example: 8

operator_idintegerOptional

Optional operator ID for "channels-relocate" Only for orders with multiport option

Example: 8

intervalintegerOptional

Optional automatic reboot interval for "channels-set-autoreset" Interval is given in seconds, cannot be less than 60. If interval is not specified or 0, autoreset is disabled

Example: 60

Responses

200

OK

application/json

operation_statusstring · enumOptionalExample: completePossible values:

401

Unauthorized

404

Order not found

422

Validation error

application/json

post

/user/orders/{order_id}/perform

HTTPcURLJavaScriptPython

POST /api/user/orders/{order_id}/perform HTTP/1.1
Host: v4.dev.proxy-solutions.net
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "operation": "channels-reset",
  "channels": [
    1401,
    1402
  ],
  "location_id": 8,
  "operator_id": 8,
  "interval": 60
}

{
  "operation_status": "complete",
  "order": {
    "id": 10000,
    "status": "active",
    "service": {
      "id": 4,
      "provider": "server-proxies",
      "name": "City proxies"
    },
    "location": {
      "id": 24,
      "type": "city",
      "name": "New York",
      "country_name": "USA"
    },
    "operator": {
      "id": 37,
      "name": "Orange"
    },
    "period": 30,
    "quantity": 1,
    "minimal_payment": 1.81,
    "amount": 1.81,
    "converted_amount": 100,
    "auto_continuation": false,
    "allowed_operations": [],
    "resources_allocated": true
  }
}