GET /api/hosts
List all hosts.

Params

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

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


Value: Must be String
host[ip]
optional

not required if using a subnet with DHCP proxy


Value: Must be String
host[mac]
optional

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


Value: Must be String
host[architecture_id]
optional

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


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

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


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

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

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

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

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


Value: Must be String
host[medium_id]
optional

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

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


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

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


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

nil means host is bare metal


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

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

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

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

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

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

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

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

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

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

Value: Must be String
host[managed]
optional

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

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


Value: Must be String
host[comment]
optional

Additional information about this host


Value: Must be String
host[capabilities]
optional

Value: Must be String
host[compute_profile_id]
optional

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

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

Value: Must be String
host[ip]
optional

not required if using a subnet with dhcp proxy


Value: Must be String
host[mac]
optional

not required if its a virtual machine


Value: Must be String
host[architecture_id]
optional

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

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

Value: Must be a number.
host[operatingsystem_id]
optional

Value: Must be String
host[puppet_class_ids]
optional

Value: Must be an array of any type
host[medium_id]
optional

Value: Must be a number.
host[ptable_id]
optional

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

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

Value: Must be a number.
host[sp_subnet_id]
optional

Value: Must be a number.
host[model_id]
optional

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

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

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

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

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

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

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

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

Value: Must be String
host[managed]
optional

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

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


Value: Must be String
host[capabilities]
optional

Value: Must be String
host[compute_attributes]
optional

Value: Must be a Hash

DELETE /api/hosts/:id
Delete an 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.