GET /api/compliance/policies
Enumerar políticas

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
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
Mostrar una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

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
Crear una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

policy
requerido

Validations:

  • Must be a Hash

policy[name]
requerido

Nombre de la política

Validations:

  • Must be a String

policy[description]
opcional , nil permitido

Descripción de la política

Validations:

  • Must be a String

policy[scap_content_id]
requerido

ID de contenido de política de SCAP

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
requerido

ID de perfil de contenido de política de SCAP

Validations:

  • Must be a Integer

policy[period]
opcional , nil permitido

Periodo de programación de la política (semanal, mensual, personalizado)

Validations:

  • Must be a String

policy[weekday]
opcional , nil permitido

Programación de la política, día de la semana (solo si el periodo es == “semanal”)

Validations:

  • Must be a String

policy[day_of_month]
opcional , nil permitido

Programación de la política, día del mes (solo si el periodo es == “mensual”)

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nil permitido

Programación de la política, línea de tiempo (solo si el periodo es == “personalizado”)

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nil permitido

Aplicar política a grupos de hosts

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nil permitido

Aplicar política a los hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nil permitido

Personalizando el ID del archivo

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nil permitido

Personalizando el ID del archivo de perfil

Validations:

  • Must be a Integer

policy[deploy_by]
requerido

How the policy should be deployed

Validations:

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

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
Actualizar una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

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

Nombre de la política

Validations:

  • Must be a String

policy[description]
opcional , nil permitido

Descripción de la política

Validations:

  • Must be a String

policy[scap_content_id]
opcional

ID de contenido de política de SCAP

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
opcional

ID de perfil de contenido de política de SCAP

Validations:

  • Must be a Integer

policy[period]
opcional , nil permitido

Periodo de programación de la política (semanal, mensual, personalizado)

Validations:

  • Must be a String

policy[weekday]
opcional , nil permitido

Programación de la política, día de la semana (solo si el periodo es == “semanal”)

Validations:

  • Must be a String

policy[day_of_month]
opcional , nil permitido

Programación de la política, día del mes (solo si el periodo es == “mensual”)

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nil permitido

Programación de la política, línea de tiempo (solo si el periodo es == “personalizado”)

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nil permitido

Aplicar política a grupos de hosts

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nil permitido

Aplicar política a los hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nil permitido

Personalizando el ID del archivo

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nil permitido

Personalizando el ID del archivo de perfil

Validations:

  • Must be a Integer

policy[deploy_by]
opcional

How the policy should be deployed

Validations:

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

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
Eliminar una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

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
Mostrar el contenido de SCAP de una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

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
Mostrar el archivo de personalización de una política

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

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.