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

Examples

GET /api/hostgroups
200
{
  "total": 6,
  "subtotal": 6,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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": "2021-09-01 12:55:45 UTC",
      "updated_at": "2021-09-01 12: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,
      "facet_param": "bar"
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "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": 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": "2021-09-01 12:55:45 UTC",
      "updated_at": "2021-09-01 12:55:45 UTC",
      "id": 603241515,
      "name": "db",
      "title": "db",
      "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,
      "facet_param": "bar"
    },
    {
      "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": "2021-09-01 12:55:52 UTC",
      "updated_at": "2021-09-01 12:55:52 UTC",
      "id": 928644291,
      "name": "hostgroup172",
      "title": "hostgroup172",
      "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,
      "facet_param": "bar"
    },
    {
      "subnet_id": 1018350795,
      "subnet_name": "five",
      "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": 615088209,
      "ptable_name": "Example partition table",
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": 51848956,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2021-09-01 12:55:45 UTC",
      "updated_at": "2021-09-01 12:55:45 UTC",
      "id": 1,
      "name": "Parent",
      "title": "Parent",
      "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,
      "facet_param": "bar"
    },
    {
      "subnet_id": null,
      "subnet_name": "five",
      "operatingsystem_id": null,
      "operatingsystem_name": "centos 5.3",
      "domain_id": null,
      "domain_name": "mydomain.net",
      "compute_profile_id": null,
      "compute_profile_name": "1-Small",
      "ancestry": "1",
      "parent_id": 1,
      "parent_name": "Parent",
      "ptable_id": null,
      "ptable_name": "Example partition table",
      "medium_id": null,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": null,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": null,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2021-09-01 12:55:45 UTC",
      "updated_at": "2021-09-01 12:55:45 UTC",
      "id": 928644285,
      "name": "inherited",
      "title": "Parent/inherited",
      "description": null,
      "puppet_proxy_id": null,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "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": 980190962,
      "inherited_domain_id": 22495316,
      "inherited_puppet_proxy_id": 182953976,
      "inherited_puppet_ca_proxy_id": 182953976,
      "inherited_compute_resource_id": null,
      "inherited_operatingsystem_id": 309172073,
      "inherited_architecture_id": 501905019,
      "inherited_medium_id": 980190962,
      "inherited_ptable_id": 615088209,
      "inherited_subnet_id": 1018350795,
      "inherited_subnet6_id": 51848956,
      "inherited_realm_id": null,
      "inherited_pxe_loader": "PXELinux BIOS",
      "facet_param": "bar"
    },
    {
      "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": "2021-09-01 12:55:45 UTC",
      "updated_at": "2021-09-01 12:55:45 UTC",
      "id": 866317115,
      "name": "Unusual",
      "title": "Unusual",
      "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,
      "facet_param": "bar"
    }
  ]
}

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. ‘id 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