GET /api/compliance/policies
List Policies

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

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
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
Show a Policy

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

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
Create a Policy

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

policy
必填

Validations:

  • Must be a Hash

policy[name]
必填

Policy name

Validations:

  • Must be a String

policy[description]
選填 , 允許空值

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
必填

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
必填

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
選填 , 允許空值

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
選填 , 允許空值

Policy schedule weekday (only if period == “weekly”)

Validations:

  • Must be a String

policy[day_of_month]
選填 , 允許空值

Policy schedule day of month (only if period == “monthly”)

Validations:

  • Must be a Integer

policy[cron_line]
選填 , 允許空值

Policy schedule cron line (only if period == “custom”)

Validations:

  • Must be a String

policy[hostgroup_ids]
選填 , 允許空值

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
選填 , 允許空值

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
選填 , 允許空值

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
選填 , 允許空值

Tailoring file profile 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]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

policy[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/compliance/policies/:id
Update a Policy

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

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]
選填

Policy name

Validations:

  • Must be a String

policy[description]
選填 , 允許空值

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
選填

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
選填

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
選填 , 允許空值

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
選填 , 允許空值

Policy schedule weekday (only if period == “weekly”)

Validations:

  • Must be a String

policy[day_of_month]
選填 , 允許空值

Policy schedule day of month (only if period == “monthly”)

Validations:

  • Must be a Integer

policy[cron_line]
選填 , 允許空值

Policy schedule cron line (only if period == “custom”)

Validations:

  • Must be a String

policy[hostgroup_ids]
選填 , 允許空值

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
選填 , 允許空值

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
選填 , 允許空值

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
選填 , 允許空值

Tailoring file profile 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]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

policy[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/compliance/policies/:id
Delete a Policy

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

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
Show a policy's SCAP content

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

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
Show a policy's Tailoring file

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

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.