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:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

smart_proxy_id
optional

Validations:

  • Must be a String

environment_id
optional

Validations:

  • Must be a String

dryrun
optional

Validations:

  • Must be one of: true, false, 1, 0

except
optional

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

Validations:

  • Must be a String


GET /api/smart_proxies
List all smart proxies

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 results

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


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

Params

Param name Description
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.


POST /api/smart_proxies
Create a smart proxy

Params

Param name Description
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 organisations 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:

  • 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 organisations 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:

  • Must be a String


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

Params

Param name Description
id
required

Validations:

  • Must be a String