API documentation

These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for <a href=“common_parameters.html”>global parameters</a>, go to <a href=“common_parameters.html”>this link</a>.

>>>

GET /api/hosts/:host_id/parameters
List all parameters for a host

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

GET /api/domains/:domain_id/parameters
List all parameters for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters
List all parameters for an operating system

GET /api/locations/:location_id/parameters
List all parameters for a location

GET /api/organizations/:organization_id/parameters
List all parameters for an organization

GET /api/subnets/:subnet_id/parameters
List all parameters for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
subnet_id optional	ID of subnet Validations: String
show_hidden optional	Display hidden values Validations: Must be one of: `true`, `false`, `1`, `0`.
search optional	filter results Validations: String
order optional	Sort and order by a searchable field, e.g. '<field> DESC' Validations: String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return, 'all' to return all results Validations: Must match regular expression `/\A([1-9]\d*\|all)\Z$/`.

Search fields

Field name	Type	Possible values
domain_name	string
host_group_name	string
host_name	string
id	integer
key_type	string
location_name	string
name	string
organization_name	string
os_name	string
parameter_type	string
subnet_name	text
type	string
value	text

>>>

GET /api/hosts/:host_id/parameters/:id
Show a nested parameter for a host

GET /api/hostgroups/:hostgroup_id/parameters/:id
Show a nested parameter for a host group

GET /api/domains/:domain_id/parameters/:id
Show a nested parameter for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Show a nested parameter for an operating system

GET /api/locations/:location_id/parameters/:id
Show a nested parameter for a location

GET /api/organizations/:organization_id/parameters/:id
Show a nested parameter for an organization

GET /api/subnets/:subnet_id/parameters/:id
Show a nested parameter for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
subnet_id optional	ID of subnet Validations: String
id required	ID of parameter Validations: String
show_hidden optional	Display hidden values Validations: Must be one of: `true`, `false`, `1`, `0`.

>>>

POST /api/hosts/:host_id/parameters
Create a nested parameter for a host

POST /api/hostgroups/:hostgroup_id/parameters
Create a nested parameter for a host group

POST /api/domains/:domain_id/parameters
Create a nested parameter for a domain

POST /api/operatingsystems/:operatingsystem_id/parameters
Create a nested parameter for an operating system

POST /api/locations/:location_id/parameters
Create a nested parameter for a location

POST /api/organizations/:organization_id/parameters
Create a nested parameter for an organization

POST /api/subnets/:subnet_id/parameters
Create a nested parameter for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
subnet_id optional	ID of subnet Validations: String
parameter required	Validations: Hash
parameter[name] required	Validations: String
parameter[value] required	Validations: String
parameter[parameter_type] required	Type of value Validations: Must be one of: `string`, `boolean`, `integer`, `real`, `array`, `hash`, `yaml`, `json`.

>>>

PUT /api/hosts/:host_id/parameters/:id
Update a nested parameter for a host

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Update a nested parameter for a host group

PUT /api/domains/:domain_id/parameters/:id
Update a nested parameter for a domain

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Update a nested parameter for an operating system

PUT /api/locations/:location_id/parameters/:id
Update a nested parameter for a location

PUT /api/organizations/:organization_id/parameters/:id
Update a nested parameter for an organization

PUT /api/subnets/:subnet_id/parameters/:id
Update a nested parameter for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
id required	ID of parameter Validations: String
subnet_id optional	ID of subnet Validations: String
parameter required	Validations: Hash
parameter[name] optional	Validations: String
parameter[value] optional	Validations: String
parameter[parameter_type] optional	Type of value Validations: Must be one of: `string`, `boolean`, `integer`, `real`, `array`, `hash`, `yaml`, `json`.

>>>

DELETE /api/hosts/:host_id/parameters/:id
Delete a nested parameter for a host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Delete a nested parameter for a host group

DELETE /api/domains/:domain_id/parameters/:id
Delete a nested parameter for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Delete a nested parameter for an operating system

DELETE /api/locations/:location_id/parameters/:id
Delete a nested parameter for a location

DELETE /api/organizations/:organization_id/parameters/:id
Delete a nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters/:id
Delete a nested parameter for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
id required	ID of parameter Validations: String
subnet_id optional	ID of subnet Validations: String

>>>

DELETE /api/hosts/:host_id/parameters
Delete all nested parameters for a host

DELETE /api/hostgroups/:hostgroup_id/parameters
Delete all nested parameters for a host group

DELETE /api/domains/:domain_id/parameters
Delete all nested parameters for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Delete all nested parameters for an operating system

DELETE /api/locations/:location_id/parameters
Delete all nested parameter for a location

DELETE /api/organizations/:organization_id/parameters
Delete all nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters
Delete all nested parameters for a subnet

Params

Param name	Description
host_id optional	ID of host Validations: String
hostgroup_id optional	ID of host group Validations: String
domain_id optional	ID of domain Validations: String
operatingsystem_id optional	ID of operating system Validations: Must be a number.
location_id optional	ID of location Validations: String
organization_id optional	ID of organization Validations: String
subnet_id optional	ID of subnet Validations: String

Parameters

GET /api/hosts/:host_id/parameters List all parameters for a host

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

GET /api/domains/:domain_id/parameters List all parameters for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters List all parameters for an operating system

GET /api/locations/:location_id/parameters List all parameters for a location

GET /api/organizations/:organization_id/parameters List all parameters for an organization

GET /api/subnets/:subnet_id/parameters List all parameters for a subnet

Params

Search fields

GET /api/hosts/:host_id/parameters/:id Show a nested parameter for a host

GET /api/hostgroups/:hostgroup_id/parameters/:id Show a nested parameter for a host group

GET /api/domains/:domain_id/parameters/:id Show a nested parameter for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters/:id Show a nested parameter for an operating system

GET /api/locations/:location_id/parameters/:id Show a nested parameter for a location

GET /api/organizations/:organization_id/parameters/:id Show a nested parameter for an organization

GET /api/subnets/:subnet_id/parameters/:id Show a nested parameter for a subnet

Params

POST /api/hosts/:host_id/parameters Create a nested parameter for a host

POST /api/hostgroups/:hostgroup_id/parameters Create a nested parameter for a host group

POST /api/domains/:domain_id/parameters Create a nested parameter for a domain

POST /api/operatingsystems/:operatingsystem_id/parameters Create a nested parameter for an operating system

POST /api/locations/:location_id/parameters Create a nested parameter for a location

POST /api/organizations/:organization_id/parameters Create a nested parameter for an organization

POST /api/subnets/:subnet_id/parameters Create a nested parameter for a subnet

Params

PUT /api/hosts/:host_id/parameters/:id Update a nested parameter for a host

PUT /api/hostgroups/:hostgroup_id/parameters/:id Update a nested parameter for a host group

PUT /api/domains/:domain_id/parameters/:id Update a nested parameter for a domain

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id Update a nested parameter for an operating system

PUT /api/locations/:location_id/parameters/:id Update a nested parameter for a location

PUT /api/organizations/:organization_id/parameters/:id Update a nested parameter for an organization

PUT /api/subnets/:subnet_id/parameters/:id Update a nested parameter for a subnet

Params

DELETE /api/hosts/:host_id/parameters/:id Delete a nested parameter for a host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id Delete a nested parameter for a host group

DELETE /api/domains/:domain_id/parameters/:id Delete a nested parameter for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id Delete a nested parameter for an operating system

DELETE /api/locations/:location_id/parameters/:id Delete a nested parameter for a location

DELETE /api/organizations/:organization_id/parameters/:id Delete a nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters/:id Delete a nested parameter for a subnet

Params

DELETE /api/hosts/:host_id/parameters Delete all nested parameters for a host

DELETE /api/hostgroups/:hostgroup_id/parameters Delete all nested parameters for a host group

DELETE /api/domains/:domain_id/parameters Delete all nested parameters for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters Delete all nested parameters for an operating system

DELETE /api/locations/:location_id/parameters Delete all nested parameter for a location

DELETE /api/organizations/:organization_id/parameters Delete all nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters Delete all nested parameters for a subnet

Params

GET /api/hosts/:host_id/parameters
List all parameters for a host

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

GET /api/domains/:domain_id/parameters
List all parameters for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters
List all parameters for an operating system

GET /api/locations/:location_id/parameters
List all parameters for a location

GET /api/organizations/:organization_id/parameters
List all parameters for an organization

GET /api/subnets/:subnet_id/parameters
List all parameters for a subnet

GET /api/hosts/:host_id/parameters/:id
Show a nested parameter for a host

GET /api/hostgroups/:hostgroup_id/parameters/:id
Show a nested parameter for a host group

GET /api/domains/:domain_id/parameters/:id
Show a nested parameter for a domain

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Show a nested parameter for an operating system

GET /api/locations/:location_id/parameters/:id
Show a nested parameter for a location

GET /api/organizations/:organization_id/parameters/:id
Show a nested parameter for an organization

GET /api/subnets/:subnet_id/parameters/:id
Show a nested parameter for a subnet

POST /api/hosts/:host_id/parameters
Create a nested parameter for a host

POST /api/hostgroups/:hostgroup_id/parameters
Create a nested parameter for a host group

POST /api/domains/:domain_id/parameters
Create a nested parameter for a domain

POST /api/operatingsystems/:operatingsystem_id/parameters
Create a nested parameter for an operating system

POST /api/locations/:location_id/parameters
Create a nested parameter for a location

POST /api/organizations/:organization_id/parameters
Create a nested parameter for an organization

POST /api/subnets/:subnet_id/parameters
Create a nested parameter for a subnet

PUT /api/hosts/:host_id/parameters/:id
Update a nested parameter for a host

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Update a nested parameter for a host group

PUT /api/domains/:domain_id/parameters/:id
Update a nested parameter for a domain

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Update a nested parameter for an operating system

PUT /api/locations/:location_id/parameters/:id
Update a nested parameter for a location

PUT /api/organizations/:organization_id/parameters/:id
Update a nested parameter for an organization

PUT /api/subnets/:subnet_id/parameters/:id
Update a nested parameter for a subnet

DELETE /api/hosts/:host_id/parameters/:id
Delete a nested parameter for a host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Delete a nested parameter for a host group

DELETE /api/domains/:domain_id/parameters/:id
Delete a nested parameter for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Delete a nested parameter for an operating system

DELETE /api/locations/:location_id/parameters/:id
Delete a nested parameter for a location

DELETE /api/organizations/:organization_id/parameters/:id
Delete a nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters/:id
Delete a nested parameter for a subnet

DELETE /api/hosts/:host_id/parameters
Delete all nested parameters for a host

DELETE /api/hostgroups/:hostgroup_id/parameters
Delete all nested parameters for a host group

DELETE /api/domains/:domain_id/parameters
Delete all nested parameters for a domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Delete all nested parameters for an operating system

DELETE /api/locations/:location_id/parameters
Delete all nested parameter for a location

DELETE /api/organizations/:organization_id/parameters
Delete all nested parameter for an organization

DELETE /api/subnets/:subnet_id/parameters
Delete all nested parameters for a subnet