Schemas

CreateOrUpdateProxyCommentRequest

  • object
    Example: {"comment":"string"}
    Properties:
    • comment
      string
      Required
      Comment
      Example: "string"
      Maximum number of items: 255

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
      Proxy order filters
      Example: {"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":["Kazan"],"geo_operator":["mts"],"type":["shared"],"protocol":["http"]}
    • period
      integer
      Required
      Order days
      Example: 1
    • price
      string
      Required
      Order price
      Example: "1.23"

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","start_at":"2019-08-24T14:15:22Z","stop_at":"2019-08-24T14:15:22Z"}
    Properties:
    • id
      integer:int64
      Order id
      Example: 1
    • login
      string or null
      Login to connect
      Example: "string"
      Maximum number of items: 255
    • password
      string or null
      Password to connect
      Example: "string"
      Maximum number of items: 255
    • protocol
      string
      Protocol to connect
      Example: "http"
      Enum: http socks5
    • host
      string
      Host/ip to connect
      Example: "string"
      Maximum number of items: 255
    • port
      integer
      Port to connect
      Example: 8080
    • geo_country
      string
      Country code in ISO-2
      Example: "RU"
    • geo_city
      string or null
      City name
      Example: "Moscow"
      Maximum number of items: 255
    • geo_operator
      string or null
      Operator name
      Example: "mts"
      Maximum number of items: 255
    • private
      boolean
      Proxy type
      Example: true
    • comment
      string or null
      Comment
      Example: "string"
      Maximum number of items: 255
    • rotate_ip_url
      string or null
      Url to rotate proxy IP-address
      Example: "string"
    • 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

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

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>
      Country code in ISO-2
      Example: ["RU"]
      Items:
      • string
        Example: "RU"
    • geo_region
      array<string>
      Region name
      Example: ["Tatarstan Republic"]
      Items:
      • string
        Example: "Tatarstan Republic"
    • geo_city
      array
      City name
      Example: [{"geo_city":"Moscow","geo_country":"RU"}]
      Items:
      • object
        Example: {"geo_city":"Moscow","geo_country":"RU"}
    • geo_operator
      array
      Operator name
      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>
      Proxy protocol
      Example: ["http"]
      Items:
      • string
        Example: "http"
        Enum: http socks5