GET /api/compliance/policies
ポリシーの一覧表示

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

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.

検索フィールド

フィールド名 タイプ 設定可能な値
content string
location string
location_id integer
name string
organization string
organization_id integer
profile string
tailoring_file string
tailoring_file_profile string

GET /api/compliance/policies/:id
ポリシーの表示

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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


POST /api/compliance/policies
ポリシーの作成

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

policy
必須

Validations:

  • Must be a Hash

policy[name]
必須

ポリシー名

Validations:

  • Must be a String

policy[description]
任意 , nil可

ポリシーの説明

Validations:

  • Must be a String

policy[scap_content_id]
必須

ポリシー SCAP コンテンツ ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
必須

ポリシー SCAP コンテンツプロファイル ID

Validations:

  • Must be a Integer

policy[period]
任意 , nil可

ポリシーのスケジュール期間 (週次、月次、カスタム)

Validations:

  • Must be a String

policy[weekday]
任意 , nil可

ポリシースケジュール: 平日 (period == “weekly” の場合のみ)

Validations:

  • Must be a String

policy[day_of_month]
任意 , nil可

ポリシースケジュール: 月の日付 (period == “monthly” の場合のみ)

Validations:

  • Must be a Integer

policy[cron_line]
任意 , nil可

ポリシースケジュール: cron 行 (period == “custom” の場合のみ)

Validations:

  • Must be a String

policy[hostgroup_ids]
任意 , nil可

ホストグループ にポリシーを適用

Validations:

  • Must be an array of any type

policy[host_ids]
任意 , nil可

ホストにポリシーを適用

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
任意 , nil可

テーラリングファイル ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
任意 , nil可

テーラリングファイルのプロファイル ID

Validations:

  • Must be a Integer

policy[deploy_by]
必須

How the policy should be deployed

Validations:

  • Must be one of: puppet, ansible, manual.

policy[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

policy[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


PUT /api/compliance/policies/:id
ポリシーの更新

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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

policy
必須

Validations:

  • Must be a Hash

policy[name]
任意

ポリシー名

Validations:

  • Must be a String

policy[description]
任意 , nil可

ポリシーの説明

Validations:

  • Must be a String

policy[scap_content_id]
任意

ポリシー SCAP コンテンツ ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
任意

ポリシー SCAP コンテンツプロファイル ID

Validations:

  • Must be a Integer

policy[period]
任意 , nil可

ポリシーのスケジュール期間 (週次、月次、カスタム)

Validations:

  • Must be a String

policy[weekday]
任意 , nil可

ポリシースケジュール: 平日 (period == “weekly” の場合のみ)

Validations:

  • Must be a String

policy[day_of_month]
任意 , nil可

ポリシースケジュール: 月の日付 (period == “monthly” の場合のみ)

Validations:

  • Must be a Integer

policy[cron_line]
任意 , nil可

ポリシースケジュール: cron 行 (period == “custom” の場合のみ)

Validations:

  • Must be a String

policy[hostgroup_ids]
任意 , nil可

ホストグループ にポリシーを適用

Validations:

  • Must be an array of any type

policy[host_ids]
任意 , nil可

ホストにポリシーを適用

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
任意 , nil可

テーラリングファイル ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
任意 , nil可

テーラリングファイルのプロファイル ID

Validations:

  • Must be a Integer

policy[deploy_by]
任意

How the policy should be deployed

Validations:

  • Must be one of: puppet, ansible, manual.

policy[location_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type

policy[organization_ids]
任意 , nil可

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

Validations:

  • Must be an array of any type


DELETE /api/compliance/policies/:id
ポリシーの削除

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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


GET /api/compliance/policies/:id/content
ポリシーの SCAP コンテンツを表示

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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


GET /api/compliance/policies/:id/tailoring
ポリシーのテーラリングファイルを表示

パラメーター

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

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

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