delete_datasource_custom_property

This command deletes a custom property that was configured for your datasource.

This API is available in Guardium V11.4 and later.

REST API syntax

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

GuardAPI syntax

delete_datasource_custom_property parameter=value

Parameters

Parameter Value type Description
force Boolean

When force="1" the custom property is deleted even if it's being used by a datasource.

Valid values:
  • 0 (false)
  • 1 (true)
name String Required. The name of the property to delete.
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.

Example

The following command deletes the custom property "Business Unit" and removes it from all the datasources and datasources groups to which the property is assigned.

grdapi delete_datasource_custom_property name="Business Unit" force="1"