GET /api/compliance/policies
Richtlinien auflisten

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
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
Zeige Richtlinie

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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
Richtlinie erstellen

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

policy
verpflichtend

Validations:

  • Must be a Hash

policy[name]
verpflichtend

Name der Richtlinie

Validations:

  • Must be a String

policy[description]
optional , nil erlaubt

Beschreibung der Richtlinie

Validations:

  • Must be a String

policy[scap_content_id]
verpflichtend

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
verpflichtend

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optional , nil erlaubt

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optional , nil erlaubt

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

Validations:

  • Must be a String

policy[day_of_month]
optional , nil erlaubt

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

Validations:

  • Must be a Integer

policy[cron_line]
optional , nil erlaubt

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optional , nil erlaubt

Richtlinie auf Hostgruppe anwenden

Validations:

  • Must be an array of any type

policy[host_ids]
optional , nil erlaubt

Richtlinie auf Hosts anwenden

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil erlaubt

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optional , nil erlaubt

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[deploy_by]
verpflichtend

How the policy should be deployed

Validations:

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

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
Richtlinie aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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

Name der Richtlinie

Validations:

  • Must be a String

policy[description]
optional , nil erlaubt

Beschreibung der Richtlinie

Validations:

  • Must be a String

policy[scap_content_id]
optional

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
optional

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optional , nil erlaubt

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optional , nil erlaubt

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

Validations:

  • Must be a String

policy[day_of_month]
optional , nil erlaubt

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

Validations:

  • Must be a Integer

policy[cron_line]
optional , nil erlaubt

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optional , nil erlaubt

Richtlinie auf Hostgruppe anwenden

Validations:

  • Must be an array of any type

policy[host_ids]
optional , nil erlaubt

Richtlinie auf Hosts anwenden

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optional , nil erlaubt

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optional , nil erlaubt

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[deploy_by]
optional

How the policy should be deployed

Validations:

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

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
Richtlinie löschen

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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
SCAP-Inhalt einer Richtlinie anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

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.