GET /api/hosts
List all hosts

GET /api/hostgroups/:hostgroup_id/hosts
List all hosts for a host group

GET /api/locations/:location_id/hosts
List hosts per location

GET /api/organizations/:organization_id/hosts
List hosts per organization

GET /api/environments/:environment_id/hosts
List hosts per environment

Params

Param name Description
hostgroup_id
optional

ID of host group


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String
environment_id
optional

ID of environment


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/hosts/:id
Show a host

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

POST /api/hosts
Create a host

Params

Param name Description
host
required

Value: Must be a Hash
host[name]
required

Value: Must be String
host[environment_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


Value: Must be String
host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy


Value: Must be String
host[mac]
optional , nil allowed

required for managed host that is bare metal, not required if it's a virtual machine


Value: Must be String
host[architecture_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


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

required if host is managed and value is not inherited from host group


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

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

Value: Must be a number.
host[puppet_class_ids]
optional , nil allowed

Value: Must be an array of any type
host[operatingsystem_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


Value: Must be String
host[medium_id]
optional , nil allowed

required if not imaged based provisioning and host is managed and value is not inherited from host group


Value: Must be String
host[ptable_id]
optional , nil allowed

required if host is managed and custom partition has not been defined


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

required if host is managed and value is not inherited from host group


Value: Must be a number.
host[compute_resource_id]
optional , nil allowed

nil means host is bare metal


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

required if host is managed and value is not inherited from host group or default password in settings


Value: Must be String
host[model_id]
optional , nil allowed

Value: Must be a number.
host[hostgroup_id]
optional , nil allowed

Value: Must be a number.
host[owner_id]
optional , nil allowed

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

Value: Must be a number.
host[image_id]
optional , nil allowed

Value: Must be a number.
host[host_parameters_attributes]
optional , nil allowed

Value: Must be an array of any type
host[build]
optional , nil allowed

Value: Must be 'true' or 'false'
host[enabled]
optional , nil allowed

Value: Must be 'true' or 'false'
host[provision_method]
optional , nil allowed

Value: Must be String
host[managed]
optional , nil allowed

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


Value: Must be 'true' or 'false'
host[progress_report_id]
optional , nil allowed

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
optional , nil allowed

Additional information about this host


Value: Must be String
host[capabilities]
optional , nil allowed

Value: Must be String
host[compute_profile_id]
optional , nil allowed

Value: Must be a number.
host[compute_attributes]
optional , nil allowed

Value: Must be a Hash

PUT /api/hosts/:id
Update a host

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.
host
required

Value: Must be a Hash
host[name]
optional

Value: Must be String
host[environment_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


Value: Must be String
host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy


Value: Must be String
host[mac]
optional , nil allowed

required for managed host that is bare metal, not required if it's a virtual machine


Value: Must be String
host[architecture_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


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

required if host is managed and value is not inherited from host group


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

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

Value: Must be a number.
host[puppet_class_ids]
optional , nil allowed

Value: Must be an array of any type
host[operatingsystem_id]
optional , nil allowed

required if host is managed and value is not inherited from host group


Value: Must be String
host[medium_id]
optional , nil allowed

required if not imaged based provisioning and host is managed and value is not inherited from host group


Value: Must be String
host[ptable_id]
optional , nil allowed

required if host is managed and custom partition has not been defined


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

required if host is managed and value is not inherited from host group


Value: Must be a number.
host[compute_resource_id]
optional , nil allowed

nil means host is bare metal


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

required if host is managed and value is not inherited from host group or default password in settings


Value: Must be String
host[model_id]
optional , nil allowed

Value: Must be a number.
host[hostgroup_id]
optional , nil allowed

Value: Must be a number.
host[owner_id]
optional , nil allowed

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

Value: Must be a number.
host[image_id]
optional , nil allowed

Value: Must be a number.
host[host_parameters_attributes]
optional , nil allowed

Value: Must be an array of any type
host[build]
optional , nil allowed

Value: Must be 'true' or 'false'
host[enabled]
optional , nil allowed

Value: Must be 'true' or 'false'
host[provision_method]
optional , nil allowed

Value: Must be String
host[managed]
optional , nil allowed

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


Value: Must be 'true' or 'false'
host[progress_report_id]
optional , nil allowed

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
optional , nil allowed

Additional information about this host


Value: Must be String
host[capabilities]
optional , nil allowed

Value: Must be String
host[compute_profile_id]
optional , nil allowed

Value: Must be a number.
host[compute_attributes]
optional , nil allowed

Value: Must be a Hash

DELETE /api/hosts/:id
Delete a host

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.

GET /api/hosts/:id/status
Get status of host

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

PUT /api/hosts/:id/puppetrun
Force a Puppet agent run on the host

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

PUT /api/hosts/:id/disassociate
Disassociate the host from a VM

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

PUT /api/hosts/:id/power
Run a power operation on host

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
power_action
required

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)


Value: Must be String

PUT /api/hosts/:id/boot
Boot host from specified device

Params

Param name Description
id
required

Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
device
required

boot device, valid devices are disk, cdrom, pxe, bios


Value: Must be String

POST /api/hosts/facts
Upload facts for a host, creating the host if required

Params

Param name Description
name
required

hostname of the host


Value: Must be String
facts
required

hash containing the facts for the host


Value: Must be Hash
certname
optional

optional: certname of the host


Value: Must be String
type
optional

optional: the STI type of host to create


Value: Must be String