GET /api/http_proxies
HTTP プロキシーを一覧表示

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
任意

フィールドと順序のソート (例: ‘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
HTTP プロキシーを表示

GET /api/http_proxies/3
200
{
  "id": 3,
  "name": "http_proxy_225",
  "url": "http://url_225",
  "username": null
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

数値 ID または HTTP プロキシー名

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
HTTP プロキシーを作成

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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

http_proxy
必須

Validations:

  • Must be a Hash

http_proxy[name]
必須

HTTP プロキシー名

Validations:

  • Must be a String

http_proxy[url]
必須

HTTP プロキシーの URL

Validations:

  • Must be a String

http_proxy[username]
任意 , nil可

HTTP プロキシーでの認証に使用するユーザー名。

Validations:

  • Must be a String

http_proxy[password]
任意 , nil可

HTTP プロキシーでの認証に使用するパスワード。

Validations:

  • Must be a String

http_proxy[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
HTTP プロキシーを更新

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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

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]
任意

HTTP プロキシー名

Validations:

  • Must be a String

http_proxy[url]
任意

HTTP プロキシーの URL

Validations:

  • Must be a String

http_proxy[username]
任意 , nil可

HTTP プロキシーでの認証に使用するユーザー名。

Validations:

  • Must be a String

http_proxy[password]
任意 , nil可

HTTP プロキシーでの認証に使用するパスワード。

Validations:

  • Must be a String

http_proxy[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
HTTP プロキシーを削除

DELETE /api/http_proxies/2
{
  "http_proxy": {}
}
200
{
  "id": 2,
  "name": "http_proxy_224",
  "url": "http://url_224",
  "username": null,
  "password": null
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

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.