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
Som alle parameters voor een host op

GET /api/hostgroups/:hostgroup_id/parameters
Som alle parameters voor een host groep op

GET /api/domains/:domain_id/parameters
Som alle parameters van een domein op

GET /api/operatingsystems/:operatingsystem_id/parameters
Som alle parameters voor een besturingssysteem op

GET /api/locations/:location_id/parameters
Som alle parameters voor een locatie op

GET /api/organizations/:organization_id/parameters
Som alle parameters voor een organisatie op

GET /api/subnets/:subnet_id/parameters
Som alle parameters voor een subnet op

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

Validations:

  • Must be a String
subnet_id
optional

ID of subnet

Validations:

  • Must be a String
show_hidden
optional

Bekijk verstopte waarden

Validations:

  • Must be one of: true, false, 1, 0.
search
optional

filter resultaten

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id 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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
domain_name
host_group_name
host_name
key_type
location_name
name
organization_name
os_name
parameter_type
subnet_name
type
value
>>>

GET /api/hosts/:host_id/parameters/:id
Toon een geneste parameter voor een host

GET /api/hostgroups/:hostgroup_id/parameters/:id
Toon een geneste parameter voor een host groep

GET /api/domains/:domain_id/parameters/:id
Toon geneste parameter van een domein

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Toon een geneste parameter voor een besturingssysteem

GET /api/locations/:location_id/parameters/:id
Toon een geneste parameter voor een lokatie

GET /api/organizations/:organization_id/parameters/:id
Toon een geneste parameter voor een organisatie

GET /api/subnets/:subnet_id/parameters/:id
Toon een geneste parameter voor een subnet

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

Validations:

  • Must be a String
subnet_id
optional

ID of subnet

Validations:

  • Must be a String
id
required

ID van de parameter

Validations:

  • Must be a String
show_hidden
optional

Bekijk verstopte waarden

Validations:

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

POST /api/hosts/:host_id/parameters
Maak een geneste parameter voor een host

POST /api/hostgroups/:hostgroup_id/parameters
Maak een geneste parameter voor een host groep

POST /api/domains/:domain_id/parameters
Maak een geneste parameter voor een domein

POST /api/operatingsystems/:operatingsystem_id/parameters
Maak een geneste parameter voor een besturingssysteem

POST /api/locations/:location_id/parameters
Maak een geneste parameter voor een locatie

POST /api/organizations/:organization_id/parameters
Maak een geneste parameter voor een organisatie

POST /api/subnets/:subnet_id/parameters
maak een geneste parameter voor een subnet

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

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
Wijzig een geneste parameter voor een host

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Wijzig een geneste parameter voor een host groep

PUT /api/domains/:domain_id/parameters/:id
Wijzig een geneste parameter voor een domein

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Wijzig een geneste parameter voor een operating system

PUT /api/locations/:location_id/parameters/:id
Wijzig een geneste parameter voor een lokatie

PUT /api/organizations/:organization_id/parameters/:id
Wijzig een geneste parameter voor een organisatie

PUT /api/subnets/:subnet_id/parameters/:id
Wijzig een geneste parameter voor een subnet

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

Validations:

  • Must be a String
id
required

ID van de 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
Verwijder een geneste parameter voor een host

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Verwijder een geneste parameter voor een host groep

DELETE /api/domains/:domain_id/parameters/:id
Verwijder een geneste parameter voor een domain

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Verwijder een geneste parameter voor een besturingssysteem

DELETE /api/locations/:location_id/parameters/:id
Verwijder een geneste parameter voor een lokatie

DELETE /api/organizations/:organization_id/parameters/:id
Verwijder een geneste parameter voor een organisatie

DELETE /api/subnets/:subnet_id/parameters/:id
Verwijder een geneste parameter voor een subnet

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

Validations:

  • Must be a String
id
required

ID van de parameter

Validations:

  • Must be a String
subnet_id
optional

ID of subnet

Validations:

  • Must be a String
>>>

DELETE /api/hosts/:host_id/parameters
Verwijder alle geneste parameters voor een host

DELETE /api/hostgroups/:hostgroup_id/parameters
Verwijder alle geneste parameters voor een host groep

DELETE /api/domains/:domain_id/parameters
Verwijder alle geneste parameters voor een domein

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Verwijder alle geneste parameters voor een besturingssysteem

DELETE /api/locations/:location_id/parameters
Verwijder alle geneste parameters voor een lokatie

DELETE /api/organizations/:organization_id/parameters
Verwijder alle geneste parameters voor een organisatie

DELETE /api/subnets/:subnet_id/parameters
Verwijder alle geneste parameters voor een subnet

Params

Param name Description
host_id
optional

ID van de host

Validations:

  • Must be a String
hostgroup_id
optional

ID van de host groep

Validations:

  • Must be a String
domain_id
optional

ID van het domein

Validations:

  • Must be a String
operatingsystem_id
optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
optional

ID van de locatie

Validations:

  • Must be a String
organization_id
optional

ID van de organisatie

Validations:

  • Must be a String
subnet_id
optional

ID of subnet

Validations:

  • Must be a String