GET /foreman_puppet/api/puppetclasses
List all Puppet classes

GET /foreman_puppet/api/hosts/:host_id/puppetclasses
List all Puppet classes for a host

GET /foreman_puppet/api/hostgroups/:hostgroup_id/puppetclasses
List all Puppet classes for a host group

GET /foreman_puppet/api/environments/:environment_id/puppetclasses
List all Puppet classes for an environment

Params

Param name Description
host_id
optional

ID of host

Validations:

  • Must be a String
hostgroup_id
optional

ID of host group

Validations:

  • Must be a String
environment_id
optional

ID of environment

Validations:

  • Must be a String
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '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$/.

Search fields

Field name Type Possible values
config_group
environment
host string
hostgroup
key
location
name
organization