GET /api/v2/discovery_rules
すべての検出ルールを一覧表示

Params

Param Name Description
search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

リクエストあたりのエントリ数

Validations:

  • Must be String


GET /api/v2/discovery_rules/:id
検出ルールの表示

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/v2/discovery_rules
検出ルールの作成

Params

Param Name Description
discovery_rule
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Hash

discovery_rule[name]
Required

ユーザーに表示されるルール名を表示します

Validations:

  • Must be String

discovery_rule[search]
Required

特定のルールについて検出されたホストに一致するクエリー

Validations:

  • Must be String

discovery_rule[hostgroup_id]
Required

ホストの自動プロビジョニングに使用されるホストグループ

Validations:

  • Must be Integer

discovery_rule[hostname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ヒューマンリーダブルなホスト名を一致するホストに割り当てるパターンを定義します

Validations:

  • Must be String

discovery_rule[max_count]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ルールによってプロビジョニングされるホストの最大数量の制限を可能にします

Validations:

  • Must be Integer

discovery_rule[priority]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ルールを順番に配置します。低い数字が先に来ます。数値はゼロより大きくなければなりません

Validations:

  • Must be Integer

discovery_rule[enabled]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

フラグはルールの一時停止に使用されます

Validations:

  • Must be 'true' or 'false' or '1' or '0'

discovery_rule[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

discovery_rule[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/v2/discovery_rules/:id
ルールの更新

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

discovery_rule
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Hash

discovery_rule[name]
Optional

ユーザーに表示されるルール名を表示します

Validations:

  • Must be String

discovery_rule[search]
Optional

特定のルールについて検出されたホストに一致するクエリー

Validations:

  • Must be String

discovery_rule[hostgroup_id]
Optional

ホストの自動プロビジョニングに使用されるホストグループ

Validations:

  • Must be Integer

discovery_rule[hostname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ヒューマンリーダブルなホスト名を一致するホストに割り当てるパターンを定義します

Validations:

  • Must be String

discovery_rule[max_count]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ルールによってプロビジョニングされるホストの最大数量の制限を可能にします

Validations:

  • Must be Integer

discovery_rule[priority]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ルールを順番に配置します。低い数字が先に来ます。数値はゼロより大きくなければなりません

Validations:

  • Must be Integer

discovery_rule[enabled]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

フラグはルールの一時停止に使用されます

Validations:

  • Must be 'true' or 'false' or '1' or '0'

discovery_rule[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

discovery_rule[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


DELETE /api/v2/discovery_rules/:id
ルールの削除

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.