Params

Param name Description
puppetclass_id
optional

ID of Puppet class

Validations:

  • Must be a String

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

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
optional

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]

Search fields

Field name Type Possible values
architecture
class
config_group string
environment
host
id
label
location
location_id
medium
name
organization
organization_id
os
os_description
os_id
os_major
os_minor
os_title
params string
template
title