GET /api/compliance/policies
Listar políticas

Parâmentros

Nome parâmetro Descrição
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

Classificar campo e ordem, ex.: ‘id DESC’

Validations:

  • Must be a String

page
opcional

Número de página, iniciando em 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para retornar

Validations:

  • Must be a number.

Pesquisar campos

Nome do campo Tipo Valores possíveis
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
Exibir uma política

Parâmentros

Nome parâmetro Descrição
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
Criar uma política

Parâmentros

Nome parâmetro Descrição
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

Nome da política

Validations:

  • Must be a String

policy[description]
opcional , nulo permitido

Descrição da política

Validations:

  • Must be a String

policy[scap_content_id]
requerido

ID de conteúdo SCAP de política

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
requerido

ID de perfil de conteúdo SCAP de política

Validations:

  • Must be a Integer

policy[period]
opcional , nulo permitido

Período de agendamento da política (semanalmente, mensalmente, personalizado)

Validations:

  • Must be a String

policy[weekday]
opcional , nulo permitido

Dia da semana de agendamento da política (apenas se o período for == “semanalmente”)

Validations:

  • Must be a String

policy[day_of_month]
opcional , nulo permitido

Dia do mês de agendamento da política (apenas se o período for == “mensalmente”)

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nulo permitido

Linha cron de agendamento da política (apenas se o período for == “personalizado”)

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nulo permitido

Aplicar política a grupos de hosts

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nulo permitido

Aplicar política aos hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nulo permitido

ID do arquivo de personalização

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nulo permitido

ID do perfil do arquivo de personalização

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 , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

policy[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/compliance/policies/:id
Atualizar uma política

Parâmentros

Nome parâmetro Descrição
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

Nome da política

Validations:

  • Must be a String

policy[description]
opcional , nulo permitido

Descrição da política

Validations:

  • Must be a String

policy[scap_content_id]
opcional

ID de conteúdo SCAP de política

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
opcional

ID de perfil de conteúdo SCAP de política

Validations:

  • Must be a Integer

policy[period]
opcional , nulo permitido

Período de agendamento da política (semanalmente, mensalmente, personalizado)

Validations:

  • Must be a String

policy[weekday]
opcional , nulo permitido

Dia da semana de agendamento da política (apenas se o período for == “semanalmente”)

Validations:

  • Must be a String

policy[day_of_month]
opcional , nulo permitido

Dia do mês de agendamento da política (apenas se o período for == “mensalmente”)

Validations:

  • Must be a Integer

policy[cron_line]
opcional , nulo permitido

Linha cron de agendamento da política (apenas se o período for == “personalizado”)

Validations:

  • Must be a String

policy[hostgroup_ids]
opcional , nulo permitido

Aplicar política a grupos de hosts

Validations:

  • Must be an array of any type

policy[host_ids]
opcional , nulo permitido

Aplicar política aos hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opcional , nulo permitido

ID do arquivo de personalização

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opcional , nulo permitido

ID do perfil do arquivo de personalização

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 , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

policy[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/compliance/policies/:id
Excluir uma política

Parâmentros

Nome parâmetro Descrição
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
Exibir um conteúdo SCAP da política

Parâmentros

Nome parâmetro Descrição
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
Exibir o arquivo de personalização da política

Parâmentros

Nome parâmetro Descrição
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.