Parameters

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

Examples

GET /api/hosts/host477/parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 70,
      "created_at": "2022-03-29 08:30:14 UTC",
      "updated_at": "2022-03-29 08:30:14 UTC",
      "id": 767575239,
      "name": "parameter4",
      "parameter_type": "string",
      "value": "parameter value 17"
    }
  ]
}

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

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

Examples

GET /api/hosts/host632/parameters/767575240-parameter56
200
{
  "priority": 70,
  "created_at": "2022-03-29 08:34:32 UTC",
  "updated_at": "2022-03-29 08:34:32 UTC",
  "id": 767575240,
  "name": "parameter56",
  "parameter_type": "string",
  "value": "*****"
}

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

Examples

POST /api/hostgroups/636252244-Common/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 60,
  "created_at": "2022-03-29 08:30:41 UTC",
  "updated_at": "2022-03-29 08:30:41 UTC",
  "id": 767575240,
  "name": "parameter2",
  "parameter_type": "string",
  "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
parameter
required

Validations:

  • Must be a Hash
parameter[name]
required

Validations:

  • Must be a String
parameter[value]
required

Validations:

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

Examples

PUT /api/domains/22495316-mydomain-net/parameters/665394701-parameter
{
  "parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "priority": null,
  "created_at": "2022-03-29 08:35:10 UTC",
  "updated_at": "2022-03-29 08:35:32 UTC",
  "id": 665394701,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

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

Examples

DELETE /api/hosts/host666/parameters/767575246-parameter67
{
  "parameter": {}
}
200
{
  "id": 767575246,
  "name": "parameter67",
  "value": "parameter value 80",
  "reference_id": 26,
  "created_at": "2022-03-29T08:35:32.564Z",
  "updated_at": "2022-03-29T08:35:32.564Z",
  "priority": 70,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_value": "parameter value 80"
}

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

Examples

DELETE /api/hostgroups/636252244-Common/parameters
{
  "parameter": {}
}
200
[

]

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