Config groups

>>>

GET /foreman_puppet/api/config_groups
List of config groups

Params

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

Search fields

Field name Type Possible values
class
name
>>>

GET /foreman_puppet/api/config_groups/:id
Show a config group

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 /foreman_puppet/api/config_groups
Create a config group

Params

Param name Description
config_group
required

Validations:

  • Must be a Hash
config_group[name]
required

Validations:

  • Must be a String
config_group[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
>>>

PUT /foreman_puppet/api/config_groups/:id
Update a config group

Params

Param name Description
id
required

Validations:

  • Must be a String
config_group
required

Validations:

  • Must be a Hash
config_group[name]
optional

Validations:

  • Must be a String
config_group[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type
>>>

DELETE /foreman_puppet/api/config_groups/:id
Delete a config group

Params

Param name Description
id
required

Validations:

  • Must be a String