GET /api/http_proxies
List of HTTP Proxies

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
location string
location_id integer
name string
organization string
organization_id integer
url string

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:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Identifier of the HTTP Proxy

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ 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:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

http_proxy
required

Validations:

  • Hash

http_proxy[name]
required

The HTTP Proxy name

Validations:

  • String

http_proxy[url]
required

URL of the HTTP Proxy

Validations:

  • String

http_proxy[username]
optional , nil allowed

Username used to authenticate with the HTTP Proxy

Validations:

  • String

http_proxy[password]
optional , nil allowed

Password used to authenticate with the HTTP Proxy

Validations:

  • String

http_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

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:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

http_proxy
required

Validations:

  • Hash

http_proxy[name]
optional

The HTTP Proxy name

Validations:

  • String

http_proxy[url]
optional

URL of the HTTP Proxy

Validations:

  • String

http_proxy[username]
optional , nil allowed

Username used to authenticate with the HTTP Proxy

Validations:

  • String

http_proxy[password]
optional , nil allowed

Password used to authenticate with the HTTP Proxy

Validations:

  • String

http_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

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:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..