POST /api/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy.

POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses
Import puppet classes from puppet proxy for an environment

POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy for an environment

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

smart_proxy_id
optional

Validations:

  • String

environment_id
optional

Validations:

  • String

dryrun
optional

Validations:

  • boolean

except
optional

Optional comma-delimited string containing either ‘new’, ‘updated’, or ‘obsolete’ that is used to limit the imported Puppet classes

Validations:

  • String


GET /api/smart_proxies
List all smart proxies

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


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

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/smart_proxies
Create a smart proxy

Params

Param name Description
smart_proxy
required

Validations:

  • Hash

smart_proxy[name]
required

Validations:

  • String

smart_proxy[url]
required

Validations:

  • String

smart_proxy[download_policy]
optional , nil allowed

Download Policy of the capsule, must be one of immediate, on_demand, background, inherit

Validations:

  • 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

Params

Param name Description
id
required

Validations:

  • String

smart_proxy
required

Validations:

  • Hash

smart_proxy[name]
optional

Validations:

  • String

smart_proxy[url]
optional

Validations:

  • String

smart_proxy[download_policy]
optional , nil allowed

Download Policy of the capsule, must be one of immediate, on_demand, background, inherit

Validations:

  • 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

Params

Param name Description
id
required

Validations:

  • String


PUT /api/smart_proxies/:id/refresh
Refresh smart proxy features

Params

Param name Description
id
required

Validations:

  • String