GET /api/smart_proxies
List all smart proxies

Examples

GET /api/smart_proxies
200
{
  "total": 8,
  "subtotal": 8,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "A proxy with Logs feature",
      "id": 814728799,
      "url": "http://else.where:45674",
      "features": [
        {
          "capabilities": [],
          "name": "DHCP",
          "id": 219245707
        },
        {
          "capabilities": [],
          "name": "DNS",
          "id": 49142851
        },
        {
          "capabilities": [],
          "name": "Puppet",
          "id": 1006510553
        },
        {
          "capabilities": [],
          "name": "Logs",
          "id": 814728799
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "BMC proxy",
      "id": 821748566,
      "url": "http://else.where:45673",
      "features": [
        {
          "capabilities": [],
          "name": "BMC",
          "id": 821748566
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "DHCP Proxy",
      "id": 980190962,
      "url": "https://somewhere.net:8443",
      "features": [
        {
          "capabilities": [],
          "name": "DHCP",
          "id": 219245707
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "DNS Proxy",
      "id": 113629430,
      "url": "http://else.where:45671",
      "features": [
        {
          "capabilities": [],
          "name": "DNS",
          "id": 49142851
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "Puppetmaster Proxy",
      "id": 182953976,
      "url": "http://else.where:4567",
      "features": [
        {
          "capabilities": [],
          "name": "Puppet",
          "id": 1006510553
        },
        {
          "capabilities": [],
          "name": "Puppet CA",
          "id": 783807086
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "Realm Proxy",
      "id": 982965213,
      "url": "http://else.where:1337",
      "features": [
        {
          "capabilities": [],
          "name": "Realm",
          "id": 982965213
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "TFTP Proxy",
      "id": 298486374,
      "url": "http://somewhere.else",
      "features": [
        {
          "capabilities": [],
          "name": "TFTP",
          "id": 303403661
        }
      ]
    },
    {
      "created_at": "2021-11-26 08:11:04 UTC",
      "updated_at": "2021-11-26 08:11:04 UTC",
      "hosts_count": 0,
      "name": "Unused Proxy",
      "id": 281110143,
      "url": "http://else.where:45672",
      "features": []
    }
  ]
}

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. ‘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, ‘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
location	string
location_id	integer
name	string
organization	string
organization_id	integer
url	string