GET /api/hostgroups
List all host groups

GET /api/puppetclasses/:puppetclass_id/hostgroups
List all host groups for a Puppet class

GET /api/locations/:location_id/hostgroups
List all host groups per location

GET /api/organizations/:organization_id/hostgroups
List all host groups per organization

Params

Param name Description
puppetclass_id
optional

ID of Puppet class

Validations:

  • String

location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

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


GET /api/hostgroups/:id
Show a host group

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • boolean


POST /api/hostgroups
Create a host group

Params

Param name Description
hostgroup
required

Validations:

  • Hash

hostgroup[name]
required

Name of the host group

Validations:

  • String

hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • String

hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

Validations:

  • number.

hostgroup[environment_id]
optional , nil allowed

Environment ID

Validations:

  • number.

hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • number.

hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID

Validations:

  • number.

hostgroup[architecture_id]
optional , nil allowed

Architecture ID

Validations:

  • number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
optional , nil allowed

Media ID

Validations:

  • number.

hostgroup[ptable_id]
optional , nil allowed

Partition table ID

Validations:

  • number.

hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • number.

hostgroup[domain_id]
optional , nil allowed

Domain ID

Validations:

  • number.

hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • number.

hostgroup[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
required

Name of the parameter

Validations:

  • String

hostgroup[group_parameters_attributes][value]
required

Parameter value

Validations:

  • String

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • number.

hostgroup[root_pass]
optional , nil allowed

Root password on provisioned hosts

Validations:

  • String

hostgroup[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
optional

Content source ID

Validations:

  • number.

hostgroup[content_view_id]
optional

Content view ID

Validations:

  • number.

hostgroup[lifecycle_environment_id]
optional

Lifecycle environment ID

Validations:

  • number.

hostgroup[kickstart_repository_id]
optional

Kickstart repository ID

Validations:

  • number.


PUT /api/hostgroups/:id
Update a host group

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

hostgroup
required

Validations:

  • Hash

hostgroup[name]
optional

Name of the host group

Validations:

  • String

hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • String

hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

Validations:

  • number.

hostgroup[environment_id]
optional , nil allowed

Environment ID

Validations:

  • number.

hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • number.

hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID

Validations:

  • number.

hostgroup[architecture_id]
optional , nil allowed

Architecture ID

Validations:

  • number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
optional , nil allowed

Media ID

Validations:

  • number.

hostgroup[ptable_id]
optional , nil allowed

Partition table ID

Validations:

  • number.

hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • number.

hostgroup[domain_id]
optional , nil allowed

Domain ID

Validations:

  • number.

hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • number.

hostgroup[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
optional

Name of the parameter

Validations:

  • String

hostgroup[group_parameters_attributes][value]
optional

Parameter value

Validations:

  • String

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • number.

hostgroup[root_pass]
optional , nil allowed

Root password on provisioned hosts

Validations:

  • String

hostgroup[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
optional

Content source ID

Validations:

  • number.

hostgroup[content_view_id]
optional

Content view ID

Validations:

  • number.

hostgroup[lifecycle_environment_id]
optional

Lifecycle environment ID

Validations:

  • number.

hostgroup[kickstart_repository_id]
optional

Kickstart repository ID

Validations:

  • number.


DELETE /api/hostgroups/:id
Delete a host group

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/hostgroups/:id/clone
Clone a host group

Params

Param name Description
name
required

Validations:

  • String