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 , nil allowed

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
optional , nil allowed

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
optional , nil allowed

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
optional , nil allowed

Media ID


Value: Must be a number.
hostgroup[ptable_id]
optional , nil allowed

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
optional , nil allowed

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
optional , nil allowed

Domain ID


Value: Must be a number.
hostgroup[realm_id]
optional , nil allowed

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
optional , nil allowed

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 , nil allowed

Parent ID of the host group


Value: Must be a number.
hostgroup[environment_id]
optional , nil allowed

Environment ID


Value: Must be a number.
hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID


Value: Must be a number.
hostgroup[operatingsystem_id]
optional , nil allowed

Operating system ID


Value: Must be a number.
hostgroup[architecture_id]
optional , nil allowed

Architecture ID


Value: Must be a number.
hostgroup[medium_id]
optional , nil allowed

Media ID


Value: Must be a number.
hostgroup[ptable_id]
optional , nil allowed

Partition table ID


Value: Must be a number.
hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID


Value: Must be a number.
hostgroup[subnet_id]
optional , nil allowed

Subnet ID


Value: Must be a number.
hostgroup[domain_id]
optional , nil allowed

Domain ID


Value: Must be a number.
hostgroup[realm_id]
optional , nil allowed

Realm ID


Value: Must be a number.
hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID


Value: Must be a number.
hostgroup[root_pass]
optional , nil allowed

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