GET /api/compliance/policies
List Policies

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

policy
requerido

Validations:

  • Must be a Hash

policy[name]
requerido

Policy name

Validations:

  • Must be a String

policy[description]
opcional , nil permitido

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
requerido

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
requerido

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
opcional , nil permitido

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
opcional , nil permitido

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

Validations:

  • Must be a String

policy[day_of_month]
opcional , nil permitido

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

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nil permitido

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

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nil permitido

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nil permitido

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nil permitido

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nil permitido

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

policy[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

policy[name]
opcional

Policy name

Validations:

  • Must be a String

policy[description]
opcional , nil permitido

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
opcional

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
opcional

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
opcional , nil permitido

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
opcional , nil permitido

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

Validations:

  • Must be a String

policy[day_of_month]
opcional , nil permitido

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

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nil permitido

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

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nil permitido

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nil permitido

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nil permitido

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nil permitido

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

policy[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

Validations:

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