These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for global parameters, go to this link.


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

Examples

GET /api/domains/22495316-mydomain-net/parameters
200
{
  "total": 2,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "name = parameter2",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 30,
      "created_at": "2019-11-07 08:37:11 UTC",
      "updated_at": "2019-11-07 08:37:11 UTC",
      "id": 767575490,
      "name": "parameter2",
      "parameter_type": "string",
      "value": "X"
    }
  ]
}

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 string
host_group_name string
host_name string
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
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

Examples

GET /api/hosts/host343/parameters/767575241-parameter7
200
{
  "priority": 70,
  "created_at": "2019-11-07 08:37:01 UTC",
  "updated_at": "2019-11-07 08:37:01 UTC",
  "id": 767575241,
  "name": "parameter7",
  "parameter_type": "string",
  "value": "parameter value 21"
}

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

Examples

POST /api/domains/22495316-mydomain-net/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 30,
  "created_at": "2019-11-07 08:37:11 UTC",
  "updated_at": "2019-11-07 08:37:11 UTC",
  "id": 767575490,
  "name": "parameter2",
  "parameter_type": "string",
  "value": "X"
}

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

Examples

PUT /api/subnets/1018350795-five/parameters/297943576-parameter
{
  "parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "priority": null,
  "created_at": "2019-11-07 09:09:56 UTC",
  "updated_at": "2019-11-07 09:09:59 UTC",
  "id": 297943576,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

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

Examples

DELETE /api/hostgroups/636252244-Common/parameters/767575238-group1
{
  "parameter": {}
}
200
{
  "id": 767575238,
  "name": "group1",
  "value": "group1",
  "reference_id": 636252244,
  "created_at": "2019-11-07T09:09:56.749Z",
  "updated_at": "2019-11-07T09:09:56.749Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": "string",
  "searchable_value": "group1"
}

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

Examples

DELETE /api/hosts/host2698/parameters
{
  "parameter": {}
}
200
[

]

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