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
サブネットのすべてのパラメーターを一覧表示

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

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの ID

Validations:

  • Must be a String

show_hidden
任意

非表示の値の表示

Validations:

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

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
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
サブネットのネストされたパラメーターを表示

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

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの ID

Validations:

  • Must be a String

id
必須

パラメーターの ID

Validations:

  • Must be a String

show_hidden
任意

非表示の値の表示

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
サブネットのネストされたパラメーターを作成

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

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの 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
サブネットのネストされたパラメーターを更新

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

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

id
必須

パラメーターの ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの 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 /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
任意

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

id
必須

パラメーターの ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの 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 /api/hosts/host2698/parameters
{
  "parameter": {}
}
200
[

]

パラメーター

パラメーター名 記述
host_id
任意

ホストの ID

Validations:

  • Must be a String

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

domain_id
任意

ドメインの ID

Validations:

  • Must be a String

operatingsystem_id
任意

オペレーティングシステムの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

subnet_id
任意

サブネットの ID

Validations:

  • Must be a String