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]
необязательно , nil разрешен

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]
необязательно , nil разрешен

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
необязательно , nil разрешен

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

Validations:

  • Must be a String

policy[day_of_month]
необязательно , nil разрешен

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

Validations:

  • Must be a Integer

policy[cron_line]
необязательно , nil разрешен

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

Validations:

  • Must be a String

policy[hostgroup_ids]
необязательно , nil разрешен

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
необязательно , nil разрешен

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
необязательно , nil разрешен

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
необязательно , nil разрешен

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]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

policy[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

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]
необязательно , nil разрешен

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]
необязательно , nil разрешен

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
необязательно , nil разрешен

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

Validations:

  • Must be a String

policy[day_of_month]
необязательно , nil разрешен

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

Validations:

  • Must be a Integer

policy[cron_line]
необязательно , nil разрешен

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

Validations:

  • Must be a String

policy[hostgroup_ids]
необязательно , nil разрешен

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
необязательно , nil разрешен

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
необязательно , nil разрешен

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
необязательно , nil разрешен

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]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

policy[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

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.