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

Examples

GET /api/hostgroups/636252244
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "environment_id": 334344675,
  "environment_name": "production",
  "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": "2020-03-05 13:42:09 UTC",
  "updated_at": "2020-03-05 13:42:18 UTC",
  "id": 636252244,
  "name": "Common",
  "title": "Common",
  "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"
  },
  "parameters": [
    {
      "priority": null,
      "created_at": "2020-03-05 13:42:09 UTC",
      "updated_at": "2020-03-05 13:42:09 UTC",
      "id": 767575238,
      "name": "group1",
      "parameter_type": "string",
      "value": "group1"
    }
  ],
  "template_combinations": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "Common",
      "environment_id": 334344675,
      "environment_name": "production"
    }
  ],
  "puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    }
  ],
  "config_groups": [
    {
      "created_at": "2020-03-05 13:42:09 UTC",
      "updated_at": "2020-03-05 13:42:09 UTC",
      "id": 980190962,
      "name": "Monitoring",
      "puppetclasses": [
        {
          "id": 51848956,
          "name": "chkmk",
          "module_name": "chkmk"
        },
        {
          "id": 1018350795,
          "name": "nagios",
          "module_name": "nagios"
        }
      ]
    },
    {
      "created_at": "2020-03-05 13:42:09 UTC",
      "updated_at": "2020-03-05 13:42:09 UTC",
      "id": 113629430,
      "name": "Tools",
      "puppetclasses": [
        {
          "id": 113629430,
          "name": "git",
          "module_name": "git"
        },
        {
          "id": 281110143,
          "name": "vim",
          "module_name": "vim"
        }
      ]
    }
  ],
  "all_puppetclasses": [
    {
      "id": 980190962,
      "name": "base",
      "module_name": "base"
    },
    {
      "id": 51848956,
      "name": "chkmk",
      "module_name": "chkmk"
    },
    {
      "id": 1018350795,
      "name": "nagios",
      "module_name": "nagios"
    },
    {
      "id": 281110143,
      "name": "vim",
      "module_name": "vim"
    }
  ],
  "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.