GET /api/hostgroups
List all hostgroups.

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

Validations:

  • Must be String


GET /api/hostgroups/:id
Show a hostgroup.

Params

Param name Description
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.


POST /api/hostgroups
Create an hostgroup.

Params

Param name Description
hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
required

Validations:

  • Must be String

hostgroup[parent_id]
optional

Validations:

  • Must be a number.

hostgroup[environment_id]
optional

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional

Validations:

  • Must be a number.

hostgroup[medium_id]
optional

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional

Validations:

  • Must be a number.

hostgroup[domain_id]
optional

Validations:

  • Must be a number.

hostgroup[puppet_proxy_id]
optional

Validations:

  • Must be a number.


PUT /api/hostgroups/:id
Update an hostgroup.

Params

Param name Description
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.

hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
optional

Validations:

  • Must be String

hostgroup[parent_id]
optional

Validations:

  • Must be a number.

hostgroup[environment_id]
optional

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional

Validations:

  • Must be a number.

hostgroup[medium_id]
optional

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional

Validations:

  • Must be a number.

hostgroup[domain_id]
optional

Validations:

  • Must be a number.

hostgroup[puppet_proxy_id]
optional

Validations:

  • Must be a number.


DELETE /api/hostgroups/:id
Delete an hostgroup.

Params

Param name Description
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.