GET /api/compliance/policies
List Policies

Params

Param name Description
search
optional

필터 결과

Validations:

  • Must be a String

order
optional

결과 정렬

Validations:

  • Must be a String

page
optional

페이지네이션 결과

Validations:

  • Must be a String

per_page
optional

요청 당 항목 수

Validations:

  • Must be a String


GET /api/compliance/policies/:id
Show a Policy

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.


POST /api/compliance/policies
Create a Policy

Params

Param name Description
policy
required

Validations:

  • Must be a Hash

policy[name]
required

Policy name

Validations:

  • Must be a String

policy[description]
optional , nil allowed

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
required

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
required

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optional , nil allowed

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optional , nil allowed

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

Validations:

  • Must be a String

policy[day_of_month]
optional , nil allowed

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

Validations:

  • Must be a Integer

policy[cron_line]
optional , nil allowed

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optional , nil allowed

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
optional , nil allowed

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil allowed

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optional , nil allowed

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

policy[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


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

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.

policy
required

Validations:

  • Must be a Hash

policy[name]
optional

Policy name

Validations:

  • Must be a String

policy[description]
optional , nil allowed

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
optional

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
optional

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optional , nil allowed

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optional , nil allowed

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

Validations:

  • Must be a String

policy[day_of_month]
optional , nil allowed

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

Validations:

  • Must be a Integer

policy[cron_line]
optional , nil allowed

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optional , nil allowed

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
optional , nil allowed

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil allowed

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optional , nil allowed

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

policy[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


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

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.


GET /api/compliance/policies/:id/content
Show a policy's SCAP content

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.


GET /api/compliance/policies/:id/tailoring
Show a policy's Tailoring file

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.