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": "2019-11-07 08:34:09 UTC",
      "updated_at": "2019-11-07 08:34:09 UTC",
      "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 organisations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id 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

Validations:

  • Must be a number.

Search fields

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