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

Examples

GET /api/hostgroups/928644290
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "environment_id": null,
  "environment_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": "2020-05-20 13:13:20 UTC",
  "updated_at": "2020-05-20 13:13:20 UTC",
  "id": 928644290,
  "name": "hostgroup6",
  "title": "hostgroup6",
  "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_environment_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": "2020-05-20 13:13:20 UTC",
      "updated_at": "2020-05-20 13:13:20 UTC",
      "id": 767575240,
      "name": "foo",
      "parameter_type": "integer",
      "value": 42
    }
  ],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "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.