Smart_proxies

>>>

GET /api/smart_proxies
List all smart proxies

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a 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:

  • 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.
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:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
smart_proxy
required

Validations:

  • Must be a Hash
smart_proxy[name]
required

Validations:

  • Must be a String
smart_proxy[url]
required

Validations:

  • Must be a 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
>>>

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:

  • 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 a String
smart_proxy
required

Validations:

  • Must be a Hash
smart_proxy[name]
optional

Validations:

  • Must be a String
smart_proxy[url]
optional

Validations:

  • Must be a 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
>>>

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:

  • 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 a 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:

  • 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 a 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:

  • 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 a String