Parameters

These API calls are related to nested parameters for a host, domain, 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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


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/: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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String
id
required

ID of parameter


Value: Must be String
>>>

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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String
parameter
required
Value: Must be a Hash
parameter[name]
required
Value: Must be String
parameter[value]
required
Value: Must be String
>>>

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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String
id
required

ID of parameter


Value: Must be String
parameter
required
Value: Must be a Hash
parameter[name]
optional
Value: Must be String
parameter[value]
optional
Value: Must be String
>>>

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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String
id
required

ID of parameter


Value: Must be 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

Params

Param name Description
host_id
optional

ID of host


Value: Must be String
hostgroup_id
optional

ID of host group


Value: Must be String
domain_id
optional

ID of domain


Value: Must be String
operatingsystem_id
optional

ID of operating system


Value: Must be String
location_id
optional

ID of location


Value: Must be String
organization_id
optional

ID of organization


Value: Must be String