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

Examples

GET /api/hosts/host158/parameters
200
{
  "total": 2,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = parameter2",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 70,
      "created_at": "2018-11-16 10:02:48 UTC",
      "updated_at": "2018-11-16 10:02:48 UTC",
      "id": 767575240,
      "name": "parameter2",
      "value": "X"
    }
  ]
}

Params

Param name Description
host_id
optional

ID of host

Validations:

  • Must be a String
hostgroup_id
optional

ID of host group

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 number.
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

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

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