set_expiration_date_for_restored_day

This command overwrites the expiration date for data that has been restored, specified by the date of the restored data, on one or more Guardium® systems. The original expiration date is defined in the restore operation (the parameter Don't purge restored data for at least).

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/expiration_date_for_restored_day

GuardAPI syntax

set_expiration_date_for_restored_day parameter=value

Parameters

Parameter Value type Description

newExpDate String Required. The new expiration date for the restored data. The format is one of: real day yyyy-mm-dd hh:mi:ss; or relative day such as NOW -10 day.

restoredDay String Required. Identifies the day whose data was restored. The format is one of: real day yyyy-mm-dd hh:mi:ss; or relative day such as NOW -10 day.

Parameter	Value type	Description
newExpDate	String	Required. The new expiration date for the restored data. The format is one of: real day `yyyy-mm-dd hh:mi:ss`; or relative day such as `NOW -10 day`.
restoredDay	String	Required. Identifies the day whose data was restored. The format is one of: real day `yyyy-mm-dd hh:mi:ss`; or relative day such as `NOW -10 day`.
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.

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

This commands sets the expiration date for restored data that was collected 10 days ago, to 10 days from now:

grdapi set_expiration_date_for_restored_day newExpDate=NOW =10 day restoredDay=NOW -10 day