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
Vypsat všechny parametr pro stroj

GET /api/hostgroups/:hostgroup_id/parameters
Vypsat všechny parametr pro skupinu strojů

GET /api/domains/:domain_id/parameters
Vypsat všechny parametry pro doménu

GET /api/operatingsystems/:operatingsystem_id/parameters
Vypsat všechny parametr pro operační systém

GET /api/locations/:location_id/parameters
Vypsat všechny parametr pro umístění

GET /api/organizations/:organization_id/parameters
Vypsat všechny parametr pro organizaci

GET /api/subnets/:subnet_id/parameters
List all parameters for a subnet

Examples

GET /api/hosts/host2324/parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "priority": 70,
      "created_at": "2019-09-11 14:55:09 UTC",
      "updated_at": "2019-09-11 14:55:09 UTC",
      "id": 767575239,
      "name": "parameter332",
      "parameter_type": null,
      "value": "parameter value 359"
    }
  ]
}

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

Validations:

  • Must be a String

show_hidden
Optional

Zobrazit skryté hodnoty

Validations:

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

search
Optional

výsledky filtru

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

Číslo stránky, začíná od jedničky

Validations:

  • Must be a number.

per_page
Optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Název kolonky Typ Možné hodnoty
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
Zobrazit vnořený parametr pro stroj

GET /api/hostgroups/:hostgroup_id/parameters/:id
Zobrazit vnořený parametr pro skupinu strojů

GET /api/domains/:domain_id/parameters/:id
Zobrazit vnořený parametr pro doménu

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Zobrazit vnořený parametr pro operační systém

GET /api/locations/:location_id/parameters/:id
Zobrazit vnořený parametr pro umístění

GET /api/organizations/:organization_id/parameters/:id
Zobrazit vnořený parametr pro organizaci

GET /api/subnets/:subnet_id/parameters/:id
Show a nested parameter for a subnet

Examples

GET /api/hosts/host470/parameters/767575240-parameter10
200
{
  "priority": 70,
  "created_at": "2019-09-11 14:35:47 UTC",
  "updated_at": "2019-09-11 14:35:47 UTC",
  "id": 767575240,
  "name": "parameter10",
  "parameter_type": null,
  "value": "parameter value 10"
}

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

Validations:

  • Must be a String

id
Required

Identifikátor parametru

Validations:

  • Must be a String

show_hidden
Optional

Zobrazit skryté hodnoty

Validations:

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


POST /api/hosts/:host_id/parameters
Vytvořit vnořený parametr pro hostitele

POST /api/hostgroups/:hostgroup_id/parameters
Vytvořit vnořený parametr skupinu hostitelů

POST /api/domains/:domain_id/parameters
Vytvořit vnořený parametr pro doménu

POST /api/operatingsystems/:operatingsystem_id/parameters
Vytvořit vnořený parametr pro operační systém

POST /api/locations/:location_id/parameters
Vytvořit vnořený parametr pro umístění

POST /api/organizations/:organization_id/parameters
Vytvořit vnořený parametr pro organizaci

POST /api/subnets/:subnet_id/parameters
Create a nested parameter for a subnet

Examples

POST /api/domains/22495316-mydomain-net/parameters
{
  "parameter": {
    "name": "parameter2",
    "value": "X"
  }
}
201
{
  "priority": 30,
  "created_at": "2019-09-11 14:57:35 UTC",
  "updated_at": "2019-09-11 14:57:35 UTC",
  "id": 767575246,
  "name": "parameter2",
  "parameter_type": null,
  "value": "X"
}

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

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
Aktualizovat vnořený parametr pro stroj

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Aktualizovat vnořený parametr pro skupinu strojů

PUT /api/domains/:domain_id/parameters/:id
Aktualizovat vnořený parametr pro doménu

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Aktualizovat vnořený parametr pro operační systém

PUT /api/locations/:location_id/parameters/:id
Aktualizovat vnořený parametr pro umístění

PUT /api/organizations/:organization_id/parameters/:id
Aktualizovat vnořený parametr pro organizaci

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": "2019-09-11 14:58:27 UTC",
  "updated_at": "2019-09-11 14:58:41 UTC",
  "id": 665394701,
  "name": "special_key",
  "parameter_type": null,
  "value": "123"
}

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

id
Required

Identifikátor parametru

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

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
Smazat vnořený parametr pro stroj

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Smazat vnořený parametr pro skupinu strojů

DELETE /api/domains/:domain_id/parameters/:id
Smazat vnořený parametr pro doménu

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Smazat vnořený parametr pro operační systém

DELETE /api/locations/:location_id/parameters/:id
Smazat vnořený parametr pro umístění

DELETE /api/organizations/:organization_id/parameters/:id
Smazat vnořený parametr pro organizaci

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

Examples

DELETE /api/subnets/1018350795-five/parameters/297943576-parameter
{
  "parameter": {}
}
200
{
  "id": 297943576,
  "name": "parameter",
  "value": "subnet1",
  "reference_id": 1018350795,
  "created_at": "2019-09-11T14:58:27.166Z",
  "updated_at": "2019-09-11T14:58:27.166Z",
  "priority": null,
  "hidden_value": "*****",
  "key_type": null
}

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

id
Required

Identifikátor parametru

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Smazat všechny vnořené parametry pro stroj

DELETE /api/hostgroups/:hostgroup_id/parameters
Smazat všechny vnořené parametry pro skupinu strojů

DELETE /api/domains/:domain_id/parameters
Smazat všechny vnořené parametry pro doménu

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Smazat všechny vnořené parametry pro operační systém

DELETE /api/locations/:location_id/parameters
Smazat všechny vnořené parametry pro umístění

DELETE /api/organizations/:organization_id/parameters
Smazat všechny vnořené parametry pro organizaci

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

Examples

DELETE /api/operatingsystems/1073012828/parameters
{
  "parameter": {}
}
200
[

]

Params

Param Name Description
host_id
Optional

Identifikátor stroje

Validations:

  • Must be a String

hostgroup_id
Optional

Identifikátor skupiny strojů

Validations:

  • Must be a String

domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String

operatingsystem_id
Optional

Identifikátor operačního systému

Validations:

  • Must be a String

location_id
Optional

Identifikátor umístění

Validations:

  • Must be a String

organization_id
Optional

Identifikátor organizace

Validations:

  • Must be a String

subnet_id
Optional

Identif. podsítě

Validations:

  • Must be a String