update_datasource_custom_property

Use this command to update the associated values of a datasource custom property.

This API is available in Guardium V11.4 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/datasource_custom_prop

GuardAPI syntax

update_datasource_custom_property parameter=value

Parameters

Parameter Value type Description
addValues String The values that are to be added to the custom property.
deleteValues String The values that are to be deleted from the custom property.
name String Required. The name of the custom property.
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

The following example deletes the value "Retail" from the custom property "Business Unit":
grdapi update_datasource_custom_property name="Business Unit" deleteValues="Retail"
The following example adds the value "Trading" to the custom property "Business Unit":
grdapi update_datasource_custom_property name="Business Unit" addValues="Trading"