GET /api/http_proxies
List of HTTP Proxies

示例

GET /api/http_proxies
200
{
  "total": 0,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.


GET /api/http_proxies/:id
Show an HTTP Proxy

示例

GET /api/http_proxies/4
200
{
  "id": 4,
  "name": "http_proxies",
  "url": "http://url_18",
  "username": null
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

id
必填

Numerical ID or HTTP Proxy name

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/http_proxies
Create an HTTP Proxy

示例

POST /api/http_proxies
{
  "http_proxy": {
    "name": "http_proxy_is_smart",
    "url": "http://what????:5000"
  }
}
201
{
  "id": 2,
  "name": "http_proxy_is_smart",
  "url": "http://what????:5000",
  "username": null,
  "password": null
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

http_proxy
必填

Validations:

  • Must be a Hash

http_proxy[name]
必填

The HTTP Proxy name

Validations:

  • Must be a String

http_proxy[url]
必填

URL of the HTTP Proxy

Validations:

  • Must be a String

http_proxy[username]
選填 , 允許空值

Username used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[password]
選填 , 允許空值

Password used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
Update an HTTP Proxy

示例

PUT /api/http_proxies/1
{
  "http_proxy": {
    "url": "https://some_other_url"
  }
}
200
{
  "id": 1,
  "url": "https://some_other_url",
  "name": "http_proxies",
  "username": null,
  "password": null
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

http_proxy
必填

Validations:

  • Must be a Hash

http_proxy[name]
選填

The HTTP Proxy name

Validations:

  • Must be a String

http_proxy[url]
選填

URL of the HTTP Proxy

Validations:

  • Must be a String

http_proxy[username]
選填 , 允許空值

Username used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[password]
選填 , 允許空值

Password used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
Delete an HTTP Proxy

示例

DELETE /api/http_proxies/3
{
  "http_proxy": {}
}
200
{
  "id": 3,
  "name": "http_proxies",
  "url": "http://url_17",
  "username": null,
  "password": null
}

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.