GET /api/http_proxies
List of HTTP Proxies

Params

Param name Description
location_id
optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer

search
optional

필터 결과

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

Search fields

Field name 유형 Possible values
location
location_id
name
organization
organization_id
url

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Identifier of the HTTP Proxy

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

http_proxy
required

Validations:

  • Must be a Hash

http_proxy[name]
required

The HTTP Proxy name

Validations:

  • Must be a String

http_proxy[url]
required

URL of the HTTP Proxy

Validations:

  • Must be a String

http_proxy[username]
optional , nil allowed

Username used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[password]
optional , nil allowed

Password used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

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
required

Validations:

  • Must be a Hash

http_proxy[name]
optional

The HTTP Proxy name

Validations:

  • Must be a String

http_proxy[url]
optional

URL of the HTTP Proxy

Validations:

  • Must be a String

http_proxy[username]
optional , nil allowed

Username used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[password]
optional , nil allowed

Password used to authenticate with the HTTP Proxy

Validations:

  • Must be a String

http_proxy[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

Validations:

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