Hostgroups

>>>

GET /api/hostgroups
List all host groups

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
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 and order by a searchable field, e.g. '<field> 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 string
host string
id integer
label string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params string
template string
title string
>>>

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

Examples

GET /api/hostgroups/928644286
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2025-11-11 20:12:33 UTC",
  "updated_at": "2025-11-11 20:12:33 UTC",
  "id": 928644286,
  "name": "hostgroup1",
  "title": "hostgroup1",
  "description": null,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "inherited_compute_profile_id": null,
  "inherited_domain_id": null,
  "inherited_puppet_proxy_id": null,
  "inherited_puppet_ca_proxy_id": null,
  "inherited_compute_resource_id": null,
  "inherited_operatingsystem_id": null,
  "inherited_architecture_id": null,
  "inherited_medium_id": null,
  "inherited_ptable_id": null,
  "inherited_subnet_id": null,
  "inherited_subnet6_id": null,
  "inherited_realm_id": null,
  "inherited_pxe_loader": null,
  "parameters": [
    {
      "priority": 60,
      "created_at": "2025-11-11 20:12:33 UTC",
      "updated_at": "2025-11-11 20:12:33 UTC",
      "id": 767575239,
      "name": "x",
      "parameter_type": "string",
      "associated_type": "host group",
      "hidden_value?": false,
      "value": "original"
    }
  ],
  "template_combinations": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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.
show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0.
>>>

POST /api/hostgroups
Create a host group

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
hostgroup
required

Validations:

  • Must be a Hash
hostgroup[name]
required

Name of the host group

Validations:

  • Must be a String
hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • Must be a String
hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

Validations:

  • Must be a number.
hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • Must be a number.
hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.
hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID

Validations:

  • Must be a number.
hostgroup[architecture_id]
optional , nil allowed

Architecture ID

Validations:

  • Must be a number.
hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.
hostgroup[medium_id]
optional , nil allowed

Media ID

Validations:

  • Must be a number.
hostgroup[ptable_id]
optional , nil allowed

Partition table ID

Validations:

  • Must be a number.
hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • Must be a number.
hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.
hostgroup[domain_id]
optional , nil allowed

Domain ID

Validations:

  • Must be a number.
hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • Must be a number.
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:

  • Must be a String
hostgroup[group_parameters_attributes][value]
required

Parameter value

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.
hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.
hostgroup[root_pass]
optional , nil allowed

Root password on provisioned hosts

Validations:

  • Must be a 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
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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.
hostgroup
required

Validations:

  • Must be a Hash
hostgroup[name]
optional

Name of the host group

Validations:

  • Must be a String
hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • Must be a String
hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

Validations:

  • Must be a number.
hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • Must be a number.
hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.
hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID

Validations:

  • Must be a number.
hostgroup[architecture_id]
optional , nil allowed

Architecture ID

Validations:

  • Must be a number.
hostgroup[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.
hostgroup[medium_id]
optional , nil allowed

Media ID

Validations:

  • Must be a number.
hostgroup[ptable_id]
optional , nil allowed

Partition table ID

Validations:

  • Must be a number.
hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • Must be a number.
hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.
hostgroup[domain_id]
optional , nil allowed

Domain ID

Validations:

  • Must be a number.
hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • Must be a number.
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:

  • Must be a String
hostgroup[group_parameters_attributes][value]
optional

Parameter value

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.
hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.
hostgroup[root_pass]
optional , nil allowed

Root password on provisioned hosts

Validations:

  • Must be a 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
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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 /api/hostgroups/:id/clone
Clone a host group

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
name
required

Validations:

  • Must be a String
>>>

PUT /api/hostgroups/:id/rebuild_config
Rebuild orchestration config

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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.
only
optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type
children_hosts
optional

Operate on child hostgroup hosts

Validations:

  • Must be one of: true, false, 1, 0.