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 organisation

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String

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

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String

id
Required

ID of parameter

Validations:

  • 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 organisation

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String

parameter
Required

Validations:

  • Must be a Hash

parameter[name]
Required

Validations:

  • Must be String

parameter[value]
Required

Validations:

  • 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 organisation

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String

id
Required

ID of parameter

Validations:

  • Must be String

parameter
Required

Validations:

  • Must be a Hash

parameter[name]
Optional

Validations:

  • Must be String

parameter[value]
Optional

Validations:

  • 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 organisation

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String

id
Required

ID of parameter

Validations:

  • 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 organisation

Params

Param Name Description
host_id
Optional

ID of host

Validations:

  • Must be String

hostgroup_id
Optional

ID of host group

Validations:

  • Must be String

domain_id
Optional

ID of domain

Validations:

  • Must be String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be String

location_id
Optional

ID of location

Validations:

  • Must be String

organization_id
Optional

ID of organisation

Validations:

  • Must be String