API documentation

Params

Param name	Description
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 and order by a searchable field, e.g. '<field> DESC' Validations: 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
content_source	string
content_view	string
host	string
id	integer
label	string
lifecycle_environment	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

Examples

GET /api/hostgroups/636252244-Common
200
{
  "content_source_id": null,
  "content_source_name": null,
  "content_view_id": null,
  "content_view_name": null,
  "lifecycle_environment_id": null,
  "lifecycle_environment_name": null,
  "kickstart_repository_id": null,
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "compute_profile_id": 980190962,
  "compute_profile_name": "1-Small",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "realm_id": null,
  "realm_name": null,
  "created_at": "2023-08-23 19:55:45 UTC",
  "updated_at": "2023-08-23 19:55:45 UTC",
  "id": 636252244,
  "name": "Common",
  "title": "Common",
  "description": null,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "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": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 767575238,
      "name": "group1",
      "parameter_type": "string",
      "associated_type": "host group",
      "hidden_value?": false,
      "value": "group1"
    }
  ],
  "template_combinations": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common"
    },
    {
      "id": 113629430,
      "provisioning_template_id": 104314179,
      "provisioning_template_name": "MyFinish",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common"
    }
  ],
  "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: Integer
organization_id optional	Set the current organization context for the request Validations: Integer
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: Must be one of: `true`, `false`, `1`, `0`.

Examples

POST /api/hostgroups
{
  "hostgroup": {
    "name": "New Hostgroup",
    "content_source_id": 281110143
  }
}
201
{
  "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": "2023-08-23 19:56:28 UTC",
  "updated_at": "2023-08-23 19:56:28 UTC",
  "id": 928644302,
  "name": "New Hostgroup",
  "title": "New Hostgroup",
  "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": [],
  "template_combinations": [],
  "locations": [],
  "organizations": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Integer
organization_id optional	Set the current organization context for the request Validations: Integer
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: 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`, `Grub 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: String
hostgroup[group_parameters_attributes][value] required	Parameter value Validations: 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: 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: Must be a number.
hostgroup[content_view_id] optional	Content view ID Validations: Must be a number.
hostgroup[lifecycle_environment_id] optional	Lifecycle environment ID Validations: Must be a number.
hostgroup[kickstart_repository_id] optional	Kickstart repository ID Validations: Must be a number.

Examples

PUT /api/hostgroups/636252244
{
  "hostgroup": {
    "name": "New Name",
    "content_source_id": 281110143
  }
}
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "compute_profile_id": 980190962,
  "compute_profile_name": "1-Small",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "realm_id": null,
  "realm_name": null,
  "created_at": "2023-08-23 19:55:45 UTC",
  "updated_at": "2023-08-23 19:56:28 UTC",
  "id": 636252244,
  "name": "New Name",
  "title": "New Name",
  "description": null,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "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": null,
      "created_at": "2023-08-23 19:55:45 UTC",
      "updated_at": "2023-08-23 19:55:45 UTC",
      "id": 767575238,
      "name": "group1",
      "parameter_type": "string",
      "associated_type": "host group",
      "hidden_value?": false,
      "value": "group1"
    }
  ],
  "template_combinations": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 113629430,
      "provisioning_template_id": 104314179,
      "provisioning_template_name": "MyFinish",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    }
  ],
  "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: Integer
organization_id optional	Set the current organization context for the request Validations: Integer
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: 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`, `Grub 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: String
hostgroup[group_parameters_attributes][value] optional	Parameter value Validations: 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: 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: Must be a number.
hostgroup[content_view_id] optional	Content view ID Validations: Must be a number.
hostgroup[lifecycle_environment_id] optional	Lifecycle environment ID Validations: Must be a number.
hostgroup[kickstart_repository_id] optional	Kickstart repository ID Validations: Must be a number.

Params

Param name

Description

location_id
optional

Set the current location context for the request

Validations:

Integer

organization_id
optional

Set the current organization context for the request

Validations:

Integer

id
required

Validations:

string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

Params

Param name

Description

location_id
optional

Set the current location context for the request

Validations:

Integer

organization_id
optional

Set the current organization context for the request

Validations:

Integer

name
required

Validations:

String

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Integer
organization_id optional	Set the current organization context for the request Validations: Integer
id required	Validations: string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
only optional	Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status 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`.

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

Search fields

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

Examples

Params

POST /api/hostgroups
Create a host group

Examples

Params

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

Examples

Params

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

Params

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

Params

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

Params

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

Search fields

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

Examples

Params

POST /api/hostgroups Create a host group

Examples

Params

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

Examples

Params

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

Params

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

Params

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

Params

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

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

POST /api/hostgroups
Create a host group

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

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

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

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