list_staps

This API returns a list of database servers that host S-TAPs that report to the specified Guardium® system, both as primary and secondary host. Optionally, return only the databases having S-TAPs for which the specified Guardium system is the active host.

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

REST API syntax

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

GuardAPI syntax

list_staps parameter=value

Parameters

Parameter Value type Description
onlyActive Boolean Valid values:
  • 0: list all hosts whose S-TAPs are configured to use this Guardium system as either a primary or secondary host.
  • 1: list only those hosts having S-TAPs for which this Guardium system is the active host.

Default = 1 (true)
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 find databases that host S-TAPs that report to this Guardium system, as both the primary and secondary host:

grdapi list_staps onlyActive=false

This command provides the following output:

staps:
stap host = 144.129.31.33
stap host = 144.129.31.17
stap host = 144.129.31.248
ok