GET /api/compliance/policies
List Policies

Parameter

Parametername Beschreibung
search
optional

Ergebnisse filtern

Validations:

  • Must be String

order
optional

Ergebnisse sortieren

Validations:

  • Must be String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be String


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

Parameter

Parametername Beschreibung
id
verpflichtend

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

Parameter

Parametername Beschreibung
policy
verpflichtend

Validations:

  • Must be a Hash

policy[name]
verpflichtend

Policy name

Validations:

  • Must be String

policy[description]
optional , nil erlaubt

Policy description

Validations:

  • Must be String

policy[scap_content_id]
verpflichtend

Policy SCAP content ID

Validations:

  • Must be Integer

policy[scap_content_profile_id]
verpflichtend

Policy SCAP content profile ID

Validations:

  • Must be Integer

policy[period]
optional , nil erlaubt

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be String

policy[weekday]
optional , nil erlaubt

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

Validations:

  • Must be String

policy[day_of_month]
optional , nil erlaubt

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

Validations:

  • Must be Integer

policy[cron_line]
optional , nil erlaubt

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

Validations:

  • Must be String

policy[hostgroup_ids]
optional , nil erlaubt

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil erlaubt

Tailoring file ID

Validations:

  • Must be Integer

policy[tailoring_file_profile_id]
optional , nil erlaubt

Tailoring file profile ID

Validations:

  • Must be Integer

policy[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

policy[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

policy[name]
optional

Policy name

Validations:

  • Must be String

policy[description]
optional , nil erlaubt

Policy description

Validations:

  • Must be String

policy[scap_content_id]
optional

Policy SCAP content ID

Validations:

  • Must be Integer

policy[scap_content_profile_id]
optional

Policy SCAP content profile ID

Validations:

  • Must be Integer

policy[period]
optional , nil erlaubt

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be String

policy[weekday]
optional , nil erlaubt

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

Validations:

  • Must be String

policy[day_of_month]
optional , nil erlaubt

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

Validations:

  • Must be Integer

policy[cron_line]
optional , nil erlaubt

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

Validations:

  • Must be String

policy[hostgroup_ids]
optional , nil erlaubt

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil erlaubt

Tailoring file ID

Validations:

  • Must be Integer

policy[tailoring_file_profile_id]
optional , nil erlaubt

Tailoring file profile ID

Validations:

  • Must be Integer

policy[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

policy[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

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

Parameter

Parametername Beschreibung
id
verpflichtend

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

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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