configure_purge

Use this command to define a purge operation of data results on one or more Guardium® systems.

This API is available in Guardium V9.5 and later.

REST API syntax

This API is available as a REST service with the PUT method. Call this API as follows: 
PUT https://[Guardium hostname or IP address]:8443/restAPI/configure_purge

GuardAPI syntax

configure_purge parameter=value

Parameters

Parameter Value type Description
purgeAtAge Integer Required. Number of days after which results data is purged.
purgeWithoutArchive Boolean Required. Determines whether or not results data that has not been archived can be purged. For results data that are archived outside of your Guardium system, set to 1. Valid values:
  • 0: no
  • 1: yes
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Examples

To purge results data after 2 days, but only if the results have been archived:

grdapi configure_purge purgeAtAge=2 purgeWithoutArchive=0