GET /api/smart_proxies
List all smart 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 and order by a searchable field, e.g. '<field> 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, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

include_status
optional

Flag to indicate whether to include status or not

Validations:

  • Must be one of: true, false, 1, 0.

Search fields

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

GET /api/smart_proxies/:id
Show a smart 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..

include_status
optional

Flag to indicate whether to include status or not

Validations:

  • Must be one of: true, false, 1, 0.

include_version
optional

Flag to indicate whether to include version or not

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/smart_proxies
Create a smart 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

smart_proxy
required

Validations:

  • Hash

smart_proxy[name]
required

Validations:

  • String

smart_proxy[url]
required

Validations:

  • String

smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

smart_proxy[download_policy]
optional

Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed

Validations:

  • String

smart_proxy[http_proxy_id]
optional

Id of the HTTP proxy to use with alternate content sources

Validations:

  • Integer


PUT /api/smart_proxies/:id
Update a smart 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

smart_proxy
required

Validations:

  • Hash

smart_proxy[name]
optional

Validations:

  • String

smart_proxy[url]
optional

Validations:

  • String

smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

smart_proxy[download_policy]
optional

Download Policy of the capsule, must be one of on_demand, immediate, inherit, streamed

Validations:

  • String

smart_proxy[http_proxy_id]
optional

Id of the HTTP proxy to use with alternate content sources

Validations:

  • Integer


DELETE /api/smart_proxies/:id
Delete a smart 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


PUT /api/smart_proxies/:id/refresh
Refresh smart proxy features

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


POST /api/smart_proxies/:id/import_subnets
Import subnets from Smart 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