GET /api/smart_proxies
List all smart proxies

Examples

GET /api/smart_proxies
200
{
  "total": 8,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "feature=TFTP",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2022-03-29 08:45:40 UTC",
      "updated_at": "2022-03-29 08:45:40 UTC",
      "hosts_count": 0,
      "name": "TFTP Proxy",
      "id": 298486374,
      "url": "http://somewhere.else",
      "features": [
        {
          "capabilities": [],
          "name": "TFTP",
          "id": 303403661
        }
      ]
    }
  ]
}

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. ‘

Maruku could not parse this XML/HTML: 
<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