GET /api/puppetclasses
List all Puppet classes

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

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

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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

host_id
optional

ID of host

Validations:

  • String

hostgroup_id
optional

ID of host group

Validations:

  • String

environment_id
optional

ID of environment

Validations:

  • String

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

Search fields

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

GET /api/puppetclasses/:id
Show a Puppet class

GET /api/hosts/:host_id/puppetclasses/:id
Show a Puppet class for host

GET /api/hostgroups/:hostgroup_id/puppetclasses/:id
Show a Puppet class for a host group

GET /api/environments/:environment_id/puppetclasses/:id
Show a Puppet class for an environment

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

host_id
optional

ID of host

Validations:

  • String

hostgroup_id
optional

ID of host group

Validations:

  • String

environment_id
optional

ID of environment

Validations:

  • String

id
required

ID of Puppet class

Validations:

  • String


POST /api/puppetclasses
Create a Puppet class

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

puppetclass
required

Validations:

  • Hash

puppetclass[name]
required

Validations:

  • String


PUT /api/puppetclasses/:id
Update a Puppet class

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • String

puppetclass
required

Validations:

  • Hash

puppetclass[name]
optional

Validations:

  • String


DELETE /api/puppetclasses/:id
Delete a Puppet class

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • String