GET /api/compliance/policies
List Policies

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo 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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

policy
richiesto

Validations:

  • Must be a Hash

policy[name]
richiesto

Policy name

Validations:

  • Must be a String

policy[description]
opzionale , consentito nil

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
richiesto

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
richiesto

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
opzionale , consentito nil

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
opzionale , consentito nil

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

Validations:

  • Must be a String

policy[day_of_month]
opzionale , consentito nil

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

Validations:

  • Must be a Integer

policy[cron_line]
opzionale , consentito nil

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

Validations:

  • Must be a String

policy[hostgroup_ids]
opzionale , consentito nil

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
opzionale , consentito nil

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opzionale , consentito nil

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opzionale , consentito nil

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[deploy_by]
richiesto

How the policy should be deployed

Validations:

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

policy[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

policy[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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
richiesto

Validations:

  • Must be a Hash

policy[name]
opzionale

Policy name

Validations:

  • Must be a String

policy[description]
opzionale , consentito nil

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
opzionale

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
opzionale

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
opzionale , consentito nil

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
opzionale , consentito nil

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

Validations:

  • Must be a String

policy[day_of_month]
opzionale , consentito nil

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

Validations:

  • Must be a Integer

policy[cron_line]
opzionale , consentito nil

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

Validations:

  • Must be a String

policy[hostgroup_ids]
opzionale , consentito nil

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
opzionale , consentito nil

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
opzionale , consentito nil

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
opzionale , consentito nil

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[deploy_by]
opzionale

How the policy should be deployed

Validations:

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

policy[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

policy[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

Validations:

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