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": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "A proxy with Logs feature",
      "id": 814728799,
      "url": "http://else.where:45674",
      "features": [
        {
          "name": "DHCP",
          "id": 219245707
        },
        {
          "name": "DNS",
          "id": 49142851
        },
        {
          "name": "Puppet",
          "id": 1006510553
        },
        {
          "name": "Logs",
          "id": 814728799
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "BMC proxy",
      "id": 821748566,
      "url": "http://else.where:45673",
      "features": [
        {
          "name": "BMC",
          "id": 821748566
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "DHCP Proxy",
      "id": 980190962,
      "url": "https://somewhere.net:8443",
      "features": [
        {
          "name": "DHCP",
          "id": 219245707
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "DNS Proxy",
      "id": 113629430,
      "url": "http://else.where:45671",
      "features": [
        {
          "name": "DNS",
          "id": 49142851
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "Puppetmaster Proxy",
      "id": 182953976,
      "url": "http://else.where:4567",
      "features": [
        {
          "name": "Puppet",
          "id": 1006510553
        },
        {
          "name": "Puppet CA",
          "id": 783807086
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "Realm Proxy",
      "id": 982965213,
      "url": "http://else.where:1337",
      "features": [
        {
          "name": "Realm",
          "id": 982965213
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "name": "TFTP Proxy",
      "id": 298486374,
      "url": "http://somewhere.else",
      "features": [
        {
          "name": "TFTP",
          "id": 303403661
        }
      ]
    },
    {
      "created_at": "2018-11-15 19:01:27 UTC",
      "updated_at": "2018-11-15 19:01:27 UTC",
      "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 field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

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