Schemas

CreateOrUpdateProxyCommentRequest

CreateOrUpdateProxyCommentRequest
  • object
    Example: {"comment":"string"}
    Properties:
    • comment
      string
      Required
      Comment for the proxy. You can add any information you may need or want, but keep in mind the maximum length of the comment.
      Example: "string"
      Maximum number of items: 255

OrderProxyRequest

OrderProxyRequest
  • object
    Example: {"filters":{"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":["Kazan"],"geo_operator":["mts"],"type":["shared"],"protocol":["http"]},"period":1,"price":"1.23"}
    Properties:
    • filters
      object or null
      Proxy order filters
      Example: {"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":["Kazan"],"geo_operator":["mts"],"type":["shared"],"protocol":["http"]}
    • period
      integer
      Required
      Proxy's duration period (in days)
      Example: 1
    • price
      string
      Required
      Proxy's purchase price (in USD)
      Example: "1.23"

UpdateProxyRequest

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

ProxyResource

ProxyResource
  • object
    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"

ErrorResponse

ErrorResponse
  • object
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

FiltersResponse

FiltersResponse
  • object
    Example: {"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":[{"geo_city":"Moscow","geo_country":"RU"}],"geo_operator":[{"geo_operator":"mts","geo_country":"RU"}],"type":["shared"],"protocol":["http"]}
    Properties:
    • geo_country
      array<string>

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

      Example: ["RU"]
      Items:
      • string
        Example: "RU"
    • geo_region
      array<string>
      Region name where server is located
      Example: ["Tatarstan Republic"]
      Items:
      • string
        Example: "Tatarstan Republic"
    • geo_city
      array
      City name where proxy server is located.
      Example: [{"geo_city":"Moscow","geo_country":"RU"}]
      Items:
      • object
        Example: {"geo_city":"Moscow","geo_country":"RU"}
    • geo_operator
      array
      Name of the operator of the proxy server.
      Example: [{"geo_operator":"mts","geo_country":"RU"}]
      Items:
      • object
        Example: {"geo_operator":"mts","geo_country":"RU"}
    • type
      array<string>
      Proxy type
      Example: ["shared"]
      Items:
      • string
        Example: "shared"
        Enum: private shared
    • protocol
      array<string>
      Protocol type
      Example: ["http"]
      Items:
      • string
        Example: "http"
        Enum: http socks5