put Change the IP address rotation frequency.

/api/client/v1/orders/{id}
proxy

Allows you to change the IP address rotation frequency. This parameter will trigger automatic IP address rotation based on the specified value. Setting it to 0 will disable IP address rotation for this proxy. Please note that some proxies do not support IP address rotation!

Parameters

id
Required
Proxy ID. The rotation frequency will be changed for the specified proxy, identified by its ID, which is generated by the OnlineProxy server upon purchase.
In: path
Example: 1
Schema:
  • integer:int64
    Example: 0

Request Body

Content Type:
application/json
  • Schema
  • Example
  • object
    UpdateProxyRequest
    Example: {"rotate_ip_freq":5}
    Properties:
    • rotate_ip_freq
      integer
      IP address rotation frequency in minutes (0 - disabled)
      Example: 5
      <= 60
      >= 0

Responses

200

OK. The IP address rotation period has been successfully changed.
Content Type:
application/json
  • Schema
  • Example
  • object
    ProxyResource
    Example: {"id":1,"login":"string","password":"string","protocol":"http","host":"string","port":8080,"geo_country":"RU","geo_city":"Moscow","geo_operator":"mts","private":true,"comment":"string","rotate_ip_url":"string","rotate_ip_freq":5,"start_at":"2019-08-24T14:15:22Z","stop_at":"2019-08-24T14:15:22Z"}
    Properties:
    • id
      integer:int64
      Order ID, generated by the OnlineProxy server upon purchasing the proxy.
      Example: 1
    • login
      string or null
      Login, use it to connect to the proxy server.
      Example: "string"
      Maximum number of items: 255
    • password
      string or null
      Password, use it to connect to the proxy server.
      Example: "string"
      Maximum number of items: 255
    • protocol
      string
      The protocol type required to connect to the proxy server.
      Example: "http"
      Enum: http socks5
    • host
      string
      Host or IP address of a proxy server.
      Example: "string"
      Maximum number of items: 255
    • port
      integer
      Port of a proxy server.
      Example: 8080
    • geo_country
      string

      The country of origin of the proxy server. Country codes are in ISO 3166-1 alpha-2 format.

      Example: "RU"
    • geo_city
      string or null
      City name where proxy server is located.
      Example: "Moscow"
      Maximum number of items: 255
    • geo_operator
      string or null
      Name of the operator of the proxy server.
      Example: "mts"
      Maximum number of items: 255
    • private
      boolean
      Proxy type
      Example: true
    • comment
      string or null
      Comment assigned to the current proxy (if any).
      Example: "string"
      Maximum number of items: 255
    • rotate_ip_url
      string or null
      URL for IP address rotation
      Example: "string"
    • rotate_ip_freq
      integer
      IP address rotation frequency in minutes (0 - disabled)
      Example: 5
      <= 60
      >= 0
    • start_at
      string:date-time

      Order start datetime UTC ISO-8601

      Example: "2019-08-24T14:15:22Z"
    • stop_at
      string:date-time

      Order expire datetime UTC ISO-8601

      Example: "2019-08-24T14:15:22Z"

400

Proxy expired. Unable to change IP address rotation period for expired proxy, please check the proxy ID.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

401

Unauthorized. Missing or invalid authentication token, please check the Authorization header.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

403

Forbidden. API access denied. Please check your Account settings to ensure that API access is enabled and your IP address is listed in the Access IPs section. If the issue persists, please contact us.

Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

422

Unprocessable Entity. Invalid or corrupted rotation token, please check the rotation token using ProxyResource schema.

Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}