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
Список всех параметров узла

GET /api/hostgroups/:hostgroup_id/parameters
Список всех параметров группы узлов

GET /api/domains/:domain_id/parameters
Список всех параметров домена

GET /api/operatingsystems/:operatingsystem_id/parameters
Список всех параметров операционной системы

GET /api/locations/:location_id/parameters
Список всех параметров местоположения

GET /api/organizations/:organization_id/parameters
Список всех параметров для организации

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

Примеры

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"
    }
  ]
}

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String

show_hidden
необязательно

Display hidden values

Validations:

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

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип 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
Показать вложенный параметр узла

GET /api/hostgroups/:hostgroup_id/parameters/:id
Показать вложенный параметр группы узлов

GET /api/domains/:domain_id/parameters/:id
Показать вложенный параметр домена

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Показать вложенный параметр операционной системы

GET /api/locations/:location_id/parameters/:id
Показать вложенный параметр местоположения

GET /api/organizations/:organization_id/parameters/:id
Показать вложенный параметр организации

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

Примеры

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

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String

id
обязательно

Код параметра

Validations:

  • Must be a String

show_hidden
необязательно

Display hidden values

Validations:

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


POST /api/hosts/:host_id/parameters
Создать вложенный параметр для узла

POST /api/hostgroups/:hostgroup_id/parameters
Создать вложенный параметр для группы узлов

POST /api/domains/:domain_id/parameters
Создать вложенный параметр для домена

POST /api/operatingsystems/:operatingsystem_id/parameters
Создать вложенный параметр для операционной системы

POST /api/locations/:location_id/parameters
Создать вложенный параметр для местоположения

POST /api/organizations/:organization_id/parameters
Создать вложенный параметр для организации

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

Примеры

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

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String

parameter
обязательно

Validations:

  • Must be a Hash

parameter[name]
обязательно

Validations:

  • Must be a String

parameter[value]
обязательно

Validations:

  • Must be a String

parameter[parameter_type]
обязательно

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.


PUT /api/hosts/:host_id/parameters/:id
Изменить вложенный параметр для узла

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Изменить вложенный параметр для группы узлов

PUT /api/domains/:domain_id/parameters/:id
Изменить вложенный параметр для домена

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Изменить вложенный параметр для операционной системы

PUT /api/locations/:location_id/parameters/:id
Изменить вложенный параметр для местоположения

PUT /api/organizations/:organization_id/parameters/:id
Изменить вложенный параметр для организации

PUT /api/subnets/:subnet_id/parameters/:id
Update a nested parameter for a subnet

Примеры

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

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

id
обязательно

Код параметра

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String

parameter
обязательно

Validations:

  • Must be a Hash

parameter[name]
необязательно

Validations:

  • Must be a String

parameter[value]
необязательно

Validations:

  • Must be a String

parameter[parameter_type]
необязательно

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.


DELETE /api/hosts/:host_id/parameters/:id
Удалить вложенный параметр узла

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Удалить вложенный параметр группы узлов

DELETE /api/domains/:domain_id/parameters/:id
Удалить вложенный параметр домена

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Удалить вложенный параметр операционной системы

DELETE /api/locations/:location_id/parameters/:id
Удалить вложенный параметр местоположения

DELETE /api/organizations/:organization_id/parameters/:id
Удалить вложенный параметр организации

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

Примеры

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

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

id
обязательно

Код параметра

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String


DELETE /api/hosts/:host_id/parameters
Удалить все вложенные параметры узла

DELETE /api/hostgroups/:hostgroup_id/parameters
Удалить все вложенные параметры группы узлов

DELETE /api/domains/:domain_id/parameters
Удалить все вложенные параметры домена

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Удалить все вложенные параметры операционной системы

DELETE /api/locations/:location_id/parameters
Удалить все вложенные параметры местоположения

DELETE /api/organizations/:organization_id/parameters
Удалить все вложенные параметры организации

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

Примеры

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

]

Параметры

Имя параметра Описание
host_id
необязательно

Код узла

Validations:

  • Must be a String

hostgroup_id
необязательно

Код группы узлов

Validations:

  • Must be a String

domain_id
необязательно

Код домена

Validations:

  • Must be a String

operatingsystem_id
необязательно

Код операционной системы

Validations:

  • Must be a String

location_id
необязательно

Код местоположения

Validations:

  • Must be a String

organization_id
необязательно

Код организации

Validations:

  • Must be a String

subnet_id
необязательно

Код подсети

Validations:

  • Must be a String