Smart proxies

>>>

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

GET /api/smart_proxies/:id
Show a smart proxy

Examples

GET /api/smart_proxies/980190962-DHCP%20Proxy
200
{
  "created_at": "2022-03-29 08:45:40 UTC",
  "updated_at": "2022-03-29 08:45:40 UTC",
  "hosts_count": 0,
  "name": "DHCP Proxy",
  "id": 980190962,
  "url": "https://somewhere.net:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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

Examples

POST /api/smart_proxies
{
  "smart_proxy": {
    "name": "master02",
    "url": "http://server:8443"
  }
}
201
{
  "created_at": "2022-03-29 08:46:04 UTC",
  "updated_at": "2022-03-29 08:46:04 UTC",
  "hosts_count": 0,
  "name": "master02",
  "id": 982965218,
  "url": "http://server:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    }
  ],
  "locations": [],
  "organizations": []
}

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

Examples

PUT /api/smart_proxies/980190962-DHCP%20Proxy
{
  "smart_proxy": {
    "name": "master02",
    "url": "http://server:8443"
  }
}
200
{
  "created_at": "2022-03-29 08:45:40 UTC",
  "updated_at": "2022-03-29 08:46:04 UTC",
  "hosts_count": 0,
  "name": "master02",
  "id": 980190962,
  "url": "http://server:8443",
  "features": [
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "DNS",
      "id": 49142851
    },
    {
      "capabilities": [],
      "name": "TFTP",
      "id": 303403661
    },
    {
      "capabilities": [],
      "name": "DHCP",
      "id": 219245707
    },
    {
      "capabilities": [],
      "name": "Puppet CA",
      "id": 783807086
    },
    {
      "capabilities": [],
      "name": "Puppet",
      "id": 1006510553
    },
    {
      "capabilities": [],
      "name": "BMC",
      "id": 821748566
    },
    {
      "capabilities": [],
      "name": "Chef Proxy",
      "id": 848995175
    },
    {
      "capabilities": [],
      "name": "Realm",
      "id": 982965213
    },
    {
      "capabilities": [],
      "name": "Logs",
      "id": 814728799
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

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

Examples

DELETE /api/smart_proxies/281110143-Unused%20Proxy
{
  "smart_proxy": {}
}
200
{
  "id": 281110143,
  "name": "Unused Proxy",
  "url": "http://else.where:45672",
  "created_at": "2022-03-29T08:45:40.948Z",
  "updated_at": "2022-03-29T08:45:40.948Z",
  "expired_logs": "0"
}

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

Examples

POST /api/smart_proxies/980190962-DHCP%20Proxy/refresh
{
  "smart_proxy": {}
}
422
{
  "error": {
    "id": 980190962,
    "errors": {
      "base": [
        "Unable to communicate with the proxy: it's down"
      ]
    },
    "full_messages": [
      "Unable to communicate with the proxy: it's down"
    ]
  }
}

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