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 för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String

show_hidden
Optional

Display hidden values

Validations:

  • Must be one of: true, false, 1, 0

search
Optional

filtrera resultat

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

paginate results

Validations:

  • Must be a String

per_page
Optional

antal poster per begäran

Validations:

  • Must be a String

Search fields

Field name Typ Possible values
domain_name string
host_group_name string
host_name string
location_name string
name string
organization_name string
os_name 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 för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String

id
Required

ID of parameter

Validations:

  • Must be a 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 för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String

parameter
Required

Validations:

  • Must be a Hash

parameter[name]
Required

Validations:

  • Must be a String

parameter[value]
Required

Validations:

  • Must be a 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

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

Params

Param Name Description
host_id
Optional

ID för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

id
Required

ID of parameter

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String

parameter
Required

Validations:

  • Must be a Hash

parameter[name]
Optional

Validations:

  • Must be a String

parameter[value]
Optional

Validations:

  • Must be a 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

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

Params

Param Name Description
host_id
Optional

ID för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

id
Required

ID of parameter

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a 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 för värd

Validations:

  • Must be a String

hostgroup_id
Optional

ID för värdgrupp

Validations:

  • Must be a String

domain_id
Optional

ID of domain

Validations:

  • Must be a String

operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String

location_id
Optional

ID of location

Validations:

  • Must be a String

organization_id
Optional

ID of organization

Validations:

  • Must be a String

subnet_id
Optional

ID of subnet

Validations:

  • Must be a String