[api] - Components Docs

Схемы

CreateOrUpdateProxyCommentRequest

object
Пример: {"comment":"string"}
Свойства:
- comment
  string
  Обязательный
  Comment
  Пример: "string"
  Максимальное количество элементов: 255

OrderProxyRequest

object
Пример: {"filters":{"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":["Kazan"],"geo_operator":["mts"],"type":["shared"],"protocol":["http"]},"period":1,"price":"1.23"}
Свойства:
- filters
  object
  Proxy order filters
  Пример: {"geo_country":["RU"],"geo_region":["Tatarstan Republic"],"geo_city":["Kazan"],"geo_operator":["mts"],"type":["shared"],"protocol":["http"]}
- period
  integer
  Обязательный
  Order days
  Пример: 1
- price
  string
  Обязательный
  Order price
  Пример: "1.23"

ProxyResource

object
Пример: {"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"}
Свойства:
- id
  integer:int64
  Order id
  Пример: 1
- login
  string or null
  Login to connect
  Пример: "string"
  Максимальное количество элементов: 255
- password
  string or null
  Password to connect
  Пример: "string"
  Максимальное количество элементов: 255
- protocol
  string
  Protocol to connect
  Пример: "http"
  Перечисление: http socks5
- host
  string
  Host/ip to connect
  Пример: "string"
  Максимальное количество элементов: 255
- port
  integer
  Port to connect
  Пример: 8080
- geo_country
  string
  Country code in ISO-2
  Пример: "RU"
- geo_city
  string or null
  City name
  Пример: "Moscow"
  Максимальное количество элементов: 255
- geo_operator
  string or null
  Operator name
  Пример: "mts"
  Максимальное количество элементов: 255
- private
  boolean
  Proxy type
  Пример: true
- comment
  string or null
  Comment
  Пример: "string"
  Максимальное количество элементов: 255
- rotate_ip_url
  string or null
  Url to rotate proxy IP-address
  Пример: "string"
- start_at
  string:date-time
  Order start datetime (UTC ISO-8601)
  Пример: "2019-08-24T14:15:22Z"
- stop_at
  string:date-time
  Order expire datetime (UTC ISO-8601)
  Пример: "2019-08-24T14:15:22Z"

ErrorResponse

object
Пример: {"message":"string","errors":{}}
Свойства:
- message
  string
  Обязательный
  Error message
  Пример: "string"
- errors
  object or null
  Input validation errors
  Пример: {}

FiltersResponse

object
Пример: {"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"]}
Свойства:
- geo_country
  array<string>
  Country code in ISO-2
  Пример: ["RU"]
  Items:
  string
  Пример: "RU"
- geo_region
  array<string>
  Region name
  Пример: ["Tatarstan Republic"]
  Items:
  string
  Пример: "Tatarstan Republic"
- geo_city
  array
  City name
  Пример: [{"geo_city":"Moscow","geo_country":"RU"}]
  Items:
  object
  Пример: {"geo_city":"Moscow","geo_country":"RU"}
- geo_operator
  array
  Operator name
  Пример: [{"geo_operator":"mts","geo_country":"RU"}]
  Items:
  object
  Пример: {"geo_operator":"mts","geo_country":"RU"}
- type
  array<string>
  Proxy type
  Пример: ["shared"]
  Items:
  string
  Пример: "shared"
  Перечисление: private shared
- protocol
  array<string>
  Proxy protocol
  Пример: ["http"]
  Items:
  string
  Пример: "http"
  Перечисление: http socks5