insights_registration

This API allows you to register GuardiumĀ® Data Protection to Guardium Insights which allows you to use Guardium Insights data with Guardium Data Protection features such as health and data mart reports

This API is available in Guardium v11.3 and later.

REST API syntax

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

GuardAPI syntax

insights_registration parameter=value

Parameters

Parameter Value type Description
insights_apikey_token String Required. An API token that is generated from Guardium Insights to allow external sources to execute RESTAPI calls on Guardium Insights. The token includes the encrypted Guardium Insights tenant ID.
insights_ca_cert_cn String The Insights certificate common name that is generated when the certificate is created. During the registration process, you can specify the certificate common name to verify the CN field as part of the standard certificate exchange authentication.
insights_url String Required. The Guardium Insights URL.
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.