GET /api/compliance/policies
List Policies

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entrées par requête

Validations:

  • Must be a String


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

policy
requis

Validations:

  • Must be a Hash

policy[name]
requis

Policy name

Validations:

  • Must be a String

policy[description]
optionel , nil autorisé

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
requis

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
requis

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optionel , nil autorisé

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optionel , nil autorisé

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

Validations:

  • Must be a String

policy[day_of_month]
optionel , nil autorisé

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

Validations:

  • Must be a Integer

policy[cron_line]
optionel , nil autorisé

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optionel , nil autorisé

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
optionel , nil autorisé

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optionel , nil autorisé

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optionel , nil autorisé

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

policy[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
requis

Validations:

  • Must be a Hash

policy[name]
optionel

Policy name

Validations:

  • Must be a String

policy[description]
optionel , nil autorisé

Policy description

Validations:

  • Must be a String

policy[scap_content_id]
optionel

Policy SCAP content ID

Validations:

  • Must be a Integer

policy[scap_content_profile_id]
optionel

Policy SCAP content profile ID

Validations:

  • Must be a Integer

policy[period]
optionel , nil autorisé

Policy schedule period (weekly, monthly, custom)

Validations:

  • Must be a String

policy[weekday]
optionel , nil autorisé

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

Validations:

  • Must be a String

policy[day_of_month]
optionel , nil autorisé

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

Validations:

  • Must be a Integer

policy[cron_line]
optionel , nil autorisé

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

Validations:

  • Must be a String

policy[hostgroup_ids]
optionel , nil autorisé

Apply policy to host groups

Validations:

  • Must be an array of any type

policy[host_ids]
optionel , nil autorisé

Apply policy to hosts

Validations:

  • Must be an array of any type

policy[tailoring_file_id]
optionel , nil autorisé

Tailoring file ID

Validations:

  • Must be a Integer

policy[tailoring_file_profile_id]
optionel , nil autorisé

Tailoring file profile ID

Validations:

  • Must be a Integer

policy[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

policy[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

Validations:

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