GET /api/hostgroups
List all host groups

GET /api/puppetclasses/:puppetclass_id/hostgroups
List all host groups for a Puppet class

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
puppetclass_id
Optional

ID of Puppet class


Value: Must be String
search
Optional

filter results


Value: Must be String
order
Optional

sort results


Value: Must be String
page
Optional

paginate results


Value: Must be String
per_page
Optional

number of entries per request


Value: Must be String

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

Params

Param Name Description
id
Required

Value: 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
Create a host group

Params

Param Name Description
hostgroup
Required

Value: Must be a Hash
hostgroup[name]
Required

Name of the host group


Value: Must be String
hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Media ID


Value: Must be a number.
hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Domain ID


Value: Must be a number.
hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Root password on provisioned hosts


Value: Must be String

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

Params

Param Name Description
id
Required

Value: 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

Value: Must be a Hash
hostgroup[name]
Optional

Name of the host group


Value: Must be String
hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Media ID


Value: Must be a number.
hostgroup[ptable_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Domain ID


Value: Must be a number.
hostgroup[realm_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Root password on provisioned hosts


Value: Must be String

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

Params

Param Name Description
id
Required

Value: 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
name
Required

Value: Must be String