Guardium API A- Z Reference

List of GuardAPI and REST API Functions

A

B

C

J

O

W

X

Y

Z

A

API commands beginning with A.

GuardAPI function name	REST enabled?	REST resource name	REST method
add_action_to_fam_rule	Yes	addActionToFAMRule	POST
add_all_to_schedule	Yes	addAllToSchedule	POST
add_approved_stap_client	Yes	addApprovedClient	POST
add_assessment_datasource	Yes	addAssessmentDatasource	POST
add_assessment_datasource_group	Yes	addAssessmentDatasourceGroup	POST
add_assessment_test	Yes	addAssessmentTest	POST
add_assessment_test_by_dsId	Yes	addAssessmentTestByDsType	POST
add_autodetect_task	Yes	addAutoDetectTask	POST
add_classifier_datasource	Yes	clsAddDatasource	POST
add_classifier_datasource_group	Yes	clsAddDatasourceGroup	POST
add_connection_properties	Yes	addConProperties	POST
add_custom_property_to_datasources_in_group	Yes	addCustomPropToDatasourcesInGroup	POST
add_custom_property_to_datasource_by_id	Yes	datasourceAddCustomProp	POST
add_custom_property_to_datasource_by_name	Yes	datasourceAddCustomProp	POST
add_datasource_to_entitlement_optimization	Yes	addDatasourceToEntitlementOptimization	PUT
add_datasource_to_group	Yes	addDatasource	POST
add_dm_to_profile	Yes	addDMToProfile	PUT
add_domain_to_universal_connector_allowed_domains	Yes	addDomainToUcAllowedDomains	POST
add_group_to_quick_search	No
add_ip_to_sg	Yes	addCollectorsIPtoGSecurityGroup	POST
add_mfa_exempt_users	Yes	addExemptUsers	PUT
add_objects_native_audit	Yes	enableNativeAuditOnObjects	POST
add_ranger_config	Yes	addConfig	POST
add_ranger_hdfs_config	Yes	addHDFSConfig	POST
add_ranger_service	Yes	mapServiceToConfig	POST
add_receiver_to_rule_action	Yes	addReceiveToRuleAction	POST
add_stream	Yes	addStream	POST
add_threshold_to_rule	Yes	addRule	PUT
add_time_period	Yes	timePeriodAdd	POST
apply_rules_on_discoveredinstances	Yes	applyRulesToDIs	PUT
assign_analytic_case	Yes	assignAnalyticCase	PUT
assign_collectors	Yes	assignCollectors	PUT
assign_load_balancer_groups	No
assign_qr_condition_to_action	Yes	assignQrConditionToAction	POST
audit_process_run_status	Yes	AuditProcessRunStatus	GET
auto_execute_suggested_dependencies	No

B

API commands beginning with B.

GuardAPI function name	REST enabled?	REST resource name	REST method
backup_cm_list_candidates	Yes	listCandidates	GET
backup_cm_set	Yes	setBackupCM	PUT

C

API commands beginning with C.

GuardAPI function name	REST enabled?	REST resource name	REST method
cancel_distributed_report_target	No
change_cli_password	Yes	changeCliPassword	POST
change_rule_order	Yes	changeRuleOrder	PUT
change_tracker_get_events	Yes	getHealthEvents	GET
change_tracker_get_params	Yes	getParam	GET
change_tracker_get_tasks	Yes	getTasks	GET
change_tracker_reset	Yes	reset	PUT
change_tracker_set_params	Yes	setParam	PUT
clear_cas_template_set	Yes	clearCasTemplateSet	PUT
clevis_bind	No
clone_assessment	Yes	cloneAssessment	POST
clone_cas_template_set	Yes	cloneCasTemplateSet	POST
clone_extraction_profile	Yes	cloneExtractionProfile	PUT
clone_policy	Yes	clonePolicy	POST
close_default_events	No		PUT
configure_archive	Yes	configArchive	PUT
configure_data_streaming	Yes	dataStreaming	POST
configure_export	Yes	configExport	PUT
configure_mfa	Yes	configMfa	POST
configure_purge	Yes	configurePurge	PUT
configure_results_archive	Yes	configResultsArchive	PUT
configure_results_export	Yes	configResutsExport	POST
configure_system_backup	Yes	configBackup	POST
copy_key_file	Yes	copyKeyFile	PUT
copy_rule	Yes	copyRule	POST
copy_rules	Yes	copyRules	POST
create_adhoc_policy_analyzer	Yes	setSchedule	PUT
create_ad_hoc_audit_and_run_once	Yes	createAuditProcess	POST
create_ad_hoc_audit_and_run_with_name	Yes	createAuditProcessWithReportName	POST
create_ad_hoc_audit_for_security_assessment	Yes	createAuditProcForSA	POST
create_alias	Yes	createAlias	POST
create_allowed_db	Yes	create	POST
create_api_parameter_mapping	Yes	addParamMappingForFunction	POST
create_assessment	Yes	addAssessment	POST
create_autodetect_process	Yes	createAutoDetectProcess	POST
create_aws_secrets_manager_config	Yes	createAwsSecretsManagerConfig	POST
create_cas_host_instance	Yes	createCasHostInstance	POST
create_cas_template	Yes	createCasTemplate	POST
create_cas_template_set	Yes	createCasTemplateSet	POST
create_classifier_action	Yes	actionAdd	POST
create_classifier_document_rule	Yes	ruleDocumentAdd	POST
create_classifier_policy	Yes	policyAdd	POST
create_classifier_process	Yes	processAdd	POST
create_classifier_rule	Yes	ruleAdd	POST
create_cloudTitle	Yes	createCloudTitle	POST
create_cloud_datasource	Yes	createCloudDS	POST
create_computed_attribute	Yes	create	POST
create_constant_attribute	Yes	create	POST
create_custom_table_ldap_import	Yes	createLdapConfig	POST
create_cyberark_config	Yes	createCyberarkConfig	POST
create_datasource	Yes	create	POST
create_datasourceRef_by_id	Yes	createRef	POST
create_datasourceRef_by_name	Yes	createRef	POST
create_datasource_custom_property	Yes	createCustomProp	POST
create_datasource_group	Yes	createGroup	POST
create_db_user_mapping	Yes	create	POST
create_ef_mapping	Yes	createEfMapping	PUT
create_entry_location	Yes	addLocation	POST
create_fam_rule	Yes	createPolicyRule	POST
create_group	Yes	create	POST
create_hashicorp_config	Yes	createHashicorpConfig	POST
create_hierarchical_member_to_group_by_desc	Yes	addHMemberToGroup	POST
create_member_to_group_by_desc	Yes	addMemberToGroup	POST
create_member_to_group_by_id	Yes	addMemberToGroup	POST
create_member_to_group_DAMX_Standard_Activity	No
create_member_to_group_DAMX_Suspicious_Connections	No
create_online_report	Yes	createReportResult	POST
create_policy	Yes	createRuleSet	POST
create_qr_action	Yes	createQrAction	POST
create_qr_add_where	Yes	createQrAddWhere	POST
create_qr_add_where_by_id	Yes	createQrAddWhereById	POST
create_qr_condition	Yes	createQrCondition	POST
create_qr_definition	Yes	createQRdefinition	POST
create_qr_replace_element	Yes	createQrReplaceElement	POST
create_qr_replace_element_byId	Yes	createQrReplaceElementById	POST
create_quarantine_allowed_until	Yes	addQuarantineAllowedUntil	POST
create_quarantine_until	Yes	addQuarantineUntil	POST
create_role	Yes	createRole	POST
create_rule	Yes	createRule	POST
create_rule_action	Yes	actionAdd	POST
create_sql_configuration	Yes	createSqlConfiguration	POST
create_stap_inspection_engine	Yes	createStapInspectionEngin	POST
create_test_detail_exception	Yes	createNew	POST
create_test_exception	Yes	create	POST
create_user	Yes	createUser	POST
create_user_hierarchy	Yes	create	POST

D

API commands beginning with D.

GuardAPI function name	REST enabled?	REST resource name	REST method
datamart_copy_file_bundle	Yes	copyFileBundle	PUT
datamart_include_file_header	Yes	includeFileHeader	PUT
datamart_refresh_metadata	Yes	refreshMetadata	PUT
datamart_run_once_now	Yes	runOnceNow	PUT
datamart_set_active	Yes	setActive	PUT
datamart_set_date_format	Yes	setDateFormat	PUT
datamart_set_inactive	Yes	setInactive	PUT
datamart_update_copy_file_info	Yes	updateCopyFileInfo	PUT
datamart_validate_copy_file_info	Yes	validateCopyFileInfo	PUT
delete_adhoc_policy_analyzer	Yes	deleteSchedule	DELETE
delete_alerter_snmp_settings	Yes	deleteSnmpSettings	DELETE
delete_alias	Yes	deleteAlias	DELETE
delete_allowed_db_by_entry_id	Yes	delete_by_entry_id	DELETE
delete_allowed_db_by_user	Yes	delete_by_user	DELETE
delete_analytic_user_feedback	Yes	deleteUserFeedback	PUT
delete_api_parameter_mapping	Yes	removeParamMappingForFunction	DELETE
delete_approved_stap_client	Yes	removeApprovedClient	DELETE
delete_archive_configuration	Yes	deleteArchiveConfig	DELETE
delete_assessment	Yes	deleteAssessment	DELETE
delete_assessment_datasource	Yes	deleteAssessmentDatasource	DELETE
delete_assessment_datasource_group	Yes	deleteAssessmentDatasourceGroup	DELETE
delete_assessment_test	Yes	deleteAssessmentTest	DELETE
delete_audit_process	Yes	deleteAuditProcess	DELETE
delete_audit_process_result	Yes	deleteResults	DELETE
delete_autodetect_process	Yes	deleteAutodetectProcess	DELETE
delete_autodetect_scans_for_process	Yes	deleteAutoDetectScansForProcess	DELETE
delete_aws_secrets_manager_config	Yes	deleteAwsSecretsManagerConfig	DELETE
delete_cas_host	Yes	deleteCasHost	DELETE
delete_cas_host_instance	Yes	deleteCasHostInstance	DELETE
delete_cas_template	Yes	deleteCasTemplate	DELETE
delete_cas_template_set	Yes	deleteCasTemplateSet	DELETE
delete_classifier_action	Yes	actionDel	DELETE
delete_classifier_document_rule	Yes	ruleDocumentDel	DELETE
delete_classifier_policy	Yes	policyDel	DELETE
delete_classifier_process	Yes	processDel	DELETE
delete_classifier_rule	Yes	ruleDel	DELETE
delete_computed_attribute	Yes	remove	DELETE
delete_constant_attribute	Yes	remove	DELETE
delete_custom_table_ldap_import	Yes	deleteLdapImport	DELETE
delete_cust_table_distribution_schedule	Yes	deleteSchedule	DELETE
delete_cyberark_config	Yes	deleteCyberarkConfig	DELETE
delete_datasourceRef_by_id	Yes	deleteRef	DELETE
delete_datasourceRef_by_name	Yes	deleteRef	DELETE
delete_datasource_by_id	Yes	delete	DELETE
delete_datasource_by_name	Yes	delete	DELETE
delete_datasource_custom_property	Yes	deleteCustomProp	DELETE
delete_datasource_group	Yes	deleteGroup	DELETE
delete_db_user_mapping	Yes	delete	DELETE
delete_distributed_report_result_for_period	No
delete_ef_mapping	Yes	deleteEfMapping	DELETE
delete_entry_location	Yes	removeLocation	DELETE
delete_export_configuration	Yes	deleteExportConfig	DELETE
delete_group_by_desc	Yes	delete	DELETE
delete_group_by_id	Yes	delete	DELETE
delete_group_from_quick_search	No
delete_hashicorp_config	Yes	deleteHashicorpConfig	DELETE
delete_hierarchical_member_from_group_by_desc	Yes	removeHMemberFromGroup	DELETE
delete_imscheckpoint_record	Yes	deleteIMSCheckpoint	DELETE
delete_inactive_stap	Yes	deleteInactiveStap	POST
delete_invalid_stap	No
delete_member_from_group_by_desc	Yes	removeMemberFromGroup	DELETE
delete_member_from_group_by_id	Yes	removeMemberFromGroup	DELETE
delete_oauth_clients	No		DELETE
delete_policy	Yes	deletePolicy	DELETE
delete_quarantine	Yes	deleteQuarantine	DELETE
delete_ranger_hdfs_config	Yes	deleteHDFSConfig	DELETE
delete_results_archive_configuration	Yes	deleteResultsArchiveConfig	DELETE
delete_results_export_configuration	Yes	deleteResultsExport	DELETE
delete_rule	Yes	removeRule	DELETE
delete_schedule	Yes	deleteSchedule	DELETE
delete_sql_configuration	Yes	removeSqlConfiguration	DELETE
delete_stap_inspection_engine	Yes	removeInspectionEngine	DELETE
delete_stream	Yes	deleteStream	DELETE
delete_system_backup_configuration	Yes	deleteSystemBackup	DELETE
delete_test_detail_exception	Yes	deleteException	DELETE
delete_test_detail_exception_by_id	Yes	deleteExceptionById	DELETE
delete_test_exception	Yes	deleteException	DELETE
delete_test_exception_by_id	Yes	deleteException	DELETE
delete_user	Yes	deleteUser	DELETE
delete_user_hierarchy_by_entry_id	Yes	delete_by_entry_id	DELETE
delete_user_hierarchy_by_user	Yes	delete_by_user	DELETE
disable_advanced_threat_scanning	Yes	disableEagleEye	PUT
disable_auto_execute_suggested_dependencies	No
disable_big_data_interface	Yes	disable	DELETE
disable_datastream	Yes	disableStream	POST
disable_deprecated_protocols	No
disable_embed_eastern_font	No
disable_entitlement_optimization	Yes	disableEntitlementOptimization	PUT
disable_fam_crawler	Yes	disableFamCrawler	PUT
disable_health_analyzer	Yes	disableHealthAnalyzer	PUT
disable_ip_to_host_aliases	Yes	disableIpToHostAliases	PUT
disable_monitoring_ranger_service	Yes	disableService	PUT
disable_native_audit	Yes	disableNativeAudit	POST
disable_outliers_detection	Yes	disableOutliersDetection	PUT
disable_outliers_detection_agg	Yes	disableOutliersDetectionOnAgg	PUT
disable_outliers_detection_cross_cm_agg	Yes	disableOutliersDetectionOnAggCrossCm	PUT
disable_outliers_detection_cross_cm_collector	Yes	disableOutliersDetectionOnCollectorsCrossCM	PUT
disable_persistent_queue_universal_connector	Yes	disablePersistentQueue	GET
disable_policy_analyzer	Yes	stopAnalyzer	PUT
disable_purge	Yes	disablePurge	DELETE
disable_quick_search	Yes	disableQuickSearch	PUT
disable_riskspotter	Yes	disableRiskspotter	POST
disable_special_attributes	No		PUT
disable_test_result_detail_string_setting	Yes	disableDetailStringSetting	POST
disable_threat_detection_use_case	Yes	disableUseCase	POST
disable_threat_finder	Yes	disableThreadFinder	PUT
discover_streams	Yes	discoverStreams	GET
display_stap_config	Yes	displayTapConfig	GET

E

API commands beginning with E.

GuardAPI function name	REST enabled?	REST resource name	REST method
enable_advanced_threat_scanning	Yes	enableEagleEye	PUT
enable_big_data_interface	Yes	enable	PUT
enable_datastream	Yes	enableStream	POST
enable_disable_ip_restriction	Yes	enableDisabledIPRestriction	POST
enable_disable_monitoring_streams	Yes	monitorStream	PUT
enable_embed_eastern_font	No
enable_entitlement_optimization	Yes	enableEntitlementOptimization	PUT
enable_fam_crawler	Yes	enableFamCrawler	PUT
enable_health_analyzer	Yes	enableHealthAnalyzer	PUT
enable_health_traffic_job	Yes	enableTraffic	POST
enable_ip_to_host_aliases	Yes	enableIpToHostAliases	PUT
enable_monitoring_ranger_service	Yes	enableService	PUT
enable_native_audit	Yes	enableNativeAudit	POST
enable_outliers_detection	Yes	enableOutliersDetection	PUT
enable_outliers_detection_agg	Yes	enableOutliersDetectionOnAgg	PUT
enable_outliers_detection_cross_cm_agg	Yes	enableOutliersDetectionCrossCMOnAgg	PUT
enable_outliers_detection_cross_cm_collector	Yes	enableOutliersDetectionCrossCMOnCollector	PUT
enable_persistent_queue_universal_connector	Yes	enablePersistentQueue	GET
enable_policy_analyzer	Yes	startAnalyzer	PUT
enable_quick_search	Yes	enableQuickSearch	PUT
enable_riskspotter	Yes	enableRiskspotter	POST
enable_special_attributes	No		PUT
enable_strong_cli_password	Yes	enableStrongPassword	POST
enable_threat_detection_use_case	Yes	enableUseCase	POST
enable_threat_finder	Yes	enableThreadFinder	PUT
encrypt_value	Yes	encryptValue	POST
execute_appUserTranslation	Yes	execute	PUT
execute_assessment	Yes	execute	PUT
execute_auditProcess	Yes	execute	PUT
execute_autodetect_process	Yes	runAutoDetectProcess	PUT
execute_cls_process	Yes	execute	PUT
execute_flatLogProcess	Yes	execute	PUT
execute_incidentGenProcess	Yes	execute	PUT
execute_incidentGenProcess_byDetails	Yes	execute	PUT
execute_ldap_user_import	Yes	importLdapUsers	POST
execute_populateGroupFromQuery	Yes	execute	PUT
export_certificate	Yes	exportCertificate	PUT
export_config	Yes	exportConfig	PUT
export_definition	No		PUT
export_log_files	Yes	exportlogfiles	POST
export_transfer_key	Yes	cp_key	POST

F

API commands beginning with F.

GuardAPI function name	REST enabled?	REST resource name	REST method
f5_add_apps_config	No		POST
f5_add_data_params	No		POST
f5_delete_apps_config	No		DELETE
f5_delete_data_params	No		DELETE
f5_list_apps_config	No		GET
f5_list_data_params	No		GET
f5_update_data_params	No		PUT
fipsmode	Yes	ModifyFipsmode	POST
flatten_hierarchical_groups	Yes	execute	PUT

G

API commands beginning with G.

GuardAPI function name	REST enabled?	REST resource name	REST method
generate_ssl_key_universal_connector	Yes	generateSSLKeyUniversalConnector	POST
generate_transfer_key	Yes	regenkeys	POST
getFieldsTitles	Yes	getFieldsTitles	GET
getOAuthTokenExpirationTime	No		GET
get_all_modifiable_guard_params	Yes	getAllModifiableGuardParams	GET
get_assessment_result	Yes	getAssessmentResult	GET
get_datamart_info	No		PUT
get_datasource_custom_properties	Yes	listCustomProps	GET
get_debug_level	No
get_definitions_data_sets	Yes	getDefinitionTypes	GET
get_definitions_items	Yes	getDefinitionsItems	GET
get_distributed_report_target_info	No
get_entitlement_optimization_info	Yes	getEntitlementOptimizationInfo	PUT
get_expiration_date_for_restored_day	Yes	getExpirationForRestoredDate	GET
get_extraction_profile_info	Yes	listExtractionProfiles	GET
get_fam_crawler_info	Yes	getFamCrawlerInfo	GET
get_flatLogProcessType	Yes	getFlatLogProcessType	GET
get_guard_param	Yes	getGuardParam	GET
get_hadoop_cluster_status	Yes	getHadoopClusterStatus	GET
get_health_traffic_status	Yes	getTrafficFrequency	GET
get_insights_agent_config	Yes	getInsightsAgentParams	GET
get_ip_restriction_config	Yes	getConfiguration	GET
get_ip_to_alias_overwrites	Yes	getIpToAliasOverwrites	GET
get_ip_to_alias_selected	Yes	getIpToAliasSelected	GET
get_istap_config	Yes	get_istap_config	GET
get_istap_status	Yes	get_istap_status	GET
get_job_process_concurrency_limit	No
get_load_balancer_load_map	No
get_load_balancer_params	No
get_mfa_configuration	Yes	getActiveConfig	GET
get_native_audit_collectors	Yes	getCollectorsList	GET
get_native_audit_configurations	Yes	getNativeAuditConfiguration	GET
get_native_audit_objects	Yes	getNativeObjectList	GET
get_outliers_detection_info	No
get_policy_analyzer_status	Yes	getStatus	GET
get_purge_batch_size	No		GET
get_quick_search_info	Yes	getQuickSearchInfo	GET
get_ranger_config	Yes	getAmbariConfigByClusterName	GET
get_ranger_hdfs_config	Yes	getHDFSConfig	GET
get_ranger_services_status	Yes	monitorServices	GET
get_registered_units	Yes	getRegisteredUnits	GET
get_secured_protocols_info	No		GET
get_solr_cluster_info	No
get_solr_errors	No
get_solr_status	No
get_streams	Yes	getStreams	GET
get_test_result_detail_string_setting	Yes	getDetailStringSetting	GET
get_threat_detection_use_case_info	Yes	getCaseTypesInfo	GET
get_unit_data	Yes	getUnitData	GET
get_unit_pinger	No		GET
get_universal_connector_allowed_domains	Yes	getUcDomainsAllowedDomains	GET
get_universal_connector_status	Yes	getUniversalConnectorStatus	GET
get_va_summary_key	Yes	getVASummaryKey	GET
get_ztap_logging_config	Yes	getZtapLoggingConfig	GET
gim_assign_bundle_or_module_to_client_by_version	Yes	assignBundleOrModuleToClientByVersion	PUT
gim_assign_latest_bundle_or_module_to_client	Yes	assignLatestBundleOrModuleToClient	PUT
gim_cancel_install	Yes	cancelInstall	PUT
gim_cancel_uninstall	Yes	cancelUninstall	PUT
gim_get_available_modules	Yes	getAvailableModules	GET
gim_get_client_last_event	Yes	listClientStatus	GET
gim_get_global_param	No
gim_get_modules_running_status	No
gim_list_bundles	Yes	listBundles	GET
gim_list_client_modules	Yes	listClientModules	GET
gim_list_client_params	Yes	listClientParams	GET
gim_list_mandatory_params	No		GET
gim_list_registered_clients	Yes	listRegisteredClients	GET
gim_list_unused_bundles	Yes	listUnusedBundles	GET
gim_load_package	Yes	loadPackage	GET
gim_remote_activation	No
gim_remove_bundle	Yes	removeBundleByPackageName	DELETE
gim_reset_client	No
gim_schedule_install	Yes	scheduleInstall	PUT
gim_schedule_uninstall	Yes	scheduleUninstall	PUT
gim_set_diagnostics	No
gim_set_global_param	No
gim_unassign_client_module	Yes	unassignClientModule	PUT
gim_uninstall_module	Yes	uninstallModule	DELETE
gim_update_client_params	Yes	updateClientParams	PUT
grant_role_to_object_by_id	Yes	addRole	PUT
grant_role_to_object_by_Name	Yes	addRole	PUT

H

API commands beginning with H.

GuardAPI function name	REST enabled?	REST resource name	REST method
health_info	Yes	getHealthInfo	GET

I

API commands beginning with I.

GuardAPI function name	REST enabled?	REST resource name	REST method
import_definitions	Yes	definitionsImport	POST
insights_registration	Yes	registerCmToInsights	POST
insights_unregistration	Yes	unregisterCmFromInsights	DELETE

K

API commands beginning with K.

GuardAPI function name	REST enabled?	REST resource name	REST method
kill_running_process	Yes	KillRunningProcess	POST

L

API commands beginning with L.

GuardAPI function name	REST enabled?	REST resource name	REST method
list_adhoc_policy_analyzer	Yes	getSchedule	GET
list_aliases	Yes	listAliases	GET
list_allowed_db_by_user	Yes	list_by_user	GET
list_all_reports	Yes	listAllReports	GET
list_approved_stap_client	Yes	listApprovedClients	GET
list_assessments	Yes	listAssessments	GET
list_assessment_tests	Yes	listAssessmentTests	GET
list_associated_stap_mu_groups	Yes	listAssociatedStapMUGroups	GET
list_audit_processes	Yes	listAuditProcesses	GET
list_autodetect_processes	Yes	listAutoDetectProcesses	GET
list_autodetect_tasks_for_process	Yes	listAutoDetectTasksForProcess	GET
list_available_tests	Yes	listAvailableTests	GET
list_aws_secrets_manager_config	Yes	listAwsSecretsManagerConfigs	GET
list_cas_hosts	Yes	listCasHosts	GET
list_cas_host_instances	Yes	listCasHostInstances	GET
list_cas_templates	Yes	listCasTemplates	GET
list_cas_template_sets	Yes	listCasTemplateSets	GET
list_classifier_policy	Yes	policyList	GET
list_classifier_process	Yes	processList	GET
list_cloud_datasource_by_name	Yes	readCloudDS	GET
list_compatibility_modes	Yes	listCompatibilityModes	GET
list_computed_attribute	Yes	list_computed_attribute	GET
list_custom_table_ldap_imports	Yes	listLdapImports	GET
list_cyberark_config	Yes	listCyberarks	GET
list_datasourceRef_by_id	Yes	readRef	GET
list_datasourceRef_by_name	Yes	readRef	GET
list_datasource_by_id	Yes	read	GET
list_datasource_by_name	Yes	read	GET
list_datasource_group_hierarchy	Yes	listDatasourceToGroupHierarchy	GET
list_datasource_group_members	Yes	listDatasources	GET
list_db_drivers	Yes	listDbDrivers	GET
list_db_drivers_by_details	Yes	listDbDriversByDetails	GET
list_db_user_mapping	Yes	list	GET
list_ef_mapping	Yes	listEfMapping	GET
list_ef_report	Yes	listAllReports	GET
list_engine_config	Yes	listEngineConfig	GET
list_entry_location	Yes	readLocation	GET
list_existing_job_dependencies	No
list_expiration_dates_for_restored_days	Yes	getExpirationForRestoredDate	GET
list_groups	Yes	listGroups	GET
list_group_by_desc	Yes	read	GET
list_group_by_id	Yes	read	GET
list_group_members_by_desc	Yes	listMembers	GET
list_group_members_by_id	Yes	listMembers	GET
list_hashicorp_config	Yes	listHashicorpConfigs	GET
list_health_node	Yes	getHealthNodes	GET
list_imscheckpoint_records	Yes	listIMSCheckpoints	GET
list_inspection_engines	Yes	listInspectionEngines	GET
list_installed_policies	Yes	listInstalledPolicies	GET
list_managed_units	Yes	listManagedUnits	GET
list_members_of_groups_by_desc	Yes	listGroupMembersByDesc	GET
list_members_of_groups_by_id	Yes	listGroupMembersById	GET
list_oauth_clients	No		GET
list_parameter_names_by_report_name	Yes	listParameterNamesByReportName	GET
list_param_mapping_for_function	No		GET
list_policy	Yes	listPolicy	GET
list_policy_fam_rule	Yes	policyRulesList	GET
list_policy_rules	Yes	listPolicyRules	GET
list_qr_action	Yes	listQrAction	GET
list_qr_add_where	Yes	listQrAddWhere	GET
list_qr_add_where_by_id	Yes	listQrAddWhereById	GET
list_qr_condition	Yes	listQrCondition	GET
list_qr_condition_to_action	Yes	listQrConditionToAction	GET
list_qr_definitions	Yes	listQRdefinition	GET
list_qr_replace_element	Yes	listQrReplaceElement	GET
list_qr_replace_element_byId	Yes	listQrReplaceElementById	GET
list_quick_search_groups	No
list_ranger_configs	Yes	listAmbariConfigs	GET
list_ranger_hdfs_config	Yes	listHDFSConfig	GET
list_ranger_staps	Yes	listOfSTAPs	GET
list_ready_files	No
list_roles	Yes	listRoles	GET
list_roles_granted_to_object_by_id	Yes	read	GET
list_roles_granted_to_object_by_Name	Yes	read	GET
list_rules_with_threshold	Yes	getListRulesWithThresholds	GET
list_running_processes	Yes	ListRunningProcesses	GET
list_scheduler_jobs	No
list_schedules	Yes	listTriggers	GET
list_staps	Yes	listActiveStaps	GET
list_stap_verification_results	Yes	listStapVerificationAllResults	GET
list_test_detail_exception	Yes	listExceptions	GET
list_test_exception	Yes	listExceptions	GET
list_test_exception_by_id	Yes	listExceptions	GET
list_users	Yes	listUsers	GET
list_user_hierarchy_by_parent_user	Yes	list_by_parent_user	GET
list_user_roles	Yes	listUserRoles	GET
list_utilization_thresholds	No		GET
load_mongodb	No
load_mongodb_by_datasource	No
local_disable_big_data_intelligence	Yes	localDisableSonar	PUT
local_disable_deprecated_protocols	No
local_enable_big_data_interface	Yes	localEnable	PUT

M

API commands beginning with M.

GuardAPI function name	REST enabled?	REST resource name	REST method
make_bundle_with_uploaded_kernel_module	No
make_primary_cm	Yes	switchCMAPIWrapper	POST
migrate_stap_config	Yes	migrateTapConfig	PUT
modify_autodetect_process	Yes	modifyAutodetectProcess	PUT
modify_ef_mapping	Yes	modifyEfMapping	PUT
modify_ef_sql_mode	Yes	modifyEfSQLMode	PUT
modify_guard_param	Yes	updateGuardParam	POST
modify_oauth_validity	No		PUT
modify_schedule	Yes	modifyTrigger	PUT
modify_va_summary_key	Yes	modifyKey	PUT
must_gather	Yes	startGatherApi	PUT

N

API commands beginning with N.

GuardAPI function name	REST enabled?	REST resource name	REST method
non_credential_scan	No		PUT
nscd	No

P

API commands beginning with P.

GuardAPI function name	REST enabled?	REST resource name	REST method
patch_cleanup	Yes	cleanup	PUT
patch_install	Yes	install	PUT
pause_or_resume_job	Yes	pauseOrResumeJob	PUT
policy_fam_rule_delete	Yes	deletePolicyRule	DELETE
policy_install	Yes	install	POST
policy_uninstall	Yes	uninstallPolicy	POST
populateMembersForGroup	Yes	populateMembersForGroup	GET
populate_from_dependencies	No		POST
populate_group_from_query	Yes	addPopulateFromQuery	POST
proxy	Yes	proxyConfig
pull_external_stap_keystore	No		PUT
push_insights_trust	Yes	pushInsightsTrust	PUT
push_parameter_to_mu	Yes	pushGuardParamToMU	POST

Q

API commands beginning with Q.

GuardAPI function name	REST enabled?	REST resource name	REST method
quick_search	Yes	quickSearch	POST

R

API commands beginning with R.

GuardAPI function name	REST enabled?	REST resource name	REST method
reboot_image_universal_connector	Yes	rebootUniversalConnectorImage	GET
refresh_quick_search_groups	No
refresh_stap_info	Yes	refreshStap	GET
register_oauth_client	No		POST
register_oauth_internal_client	No
register_unit	Yes	registerUnit	POST
reinstall_policy	Yes	reinstallPolicy	POST
reinstall_policy_rule	Yes	reinstallPolicyRule	PUT
remove_all_from_schedule	Yes	removeAllFromSchedule	POST
remove_all_qr_replace_elements	Yes	removeAllQrReplaceElements	DELETE
remove_all_qr_replace_elements_byId	Yes	removeAllQrReplaceElementsById	DELETE
remove_classifier_datasource	Yes	clsRemoveDatasource	DELETE
remove_classifier_datasource_group	Yes	clsRemoveDatasourceGroup	DELETE
remove_connection_properties	Yes	removeConProperties	DELETE
remove_custom_property_from_datasources_in_group	Yes	removeCustomPropFromDatasourcesInGroup	POST
remove_custom_property_from_datasource_by_id	Yes	datasourceRemoveCustomProp	POST
remove_custom_property_from_datasource_by_name	Yes	datasourceRemoveCustomProp	POST
remove_datasource_from_entitlement_optimization	Yes	removeDatasourceFromEntitlementOptimization	PUT
remove_datasource_from_group	Yes	removeDatasource	POST
remove_dm_from_profile	Yes	removeDMFromProfile	DELETE
remove_domain_from_universal_connector_allowed_domains	Yes	removeDomainFromUcAllowedDomains	DELETE
remove_extraction_profile	Yes	removeExtractionProfile	DELETE
remove_members_of_groups_by_desc	Yes	deleteMembers	DELETE
remove_members_of_groups_by_id	Yes	deleteMembers	DELETE
remove_mfa_exempt_users	Yes	removeExemptUsers	DELETE
remove_objects_native_audit	Yes	disableNativeAuditOnObjects	POST
remove_populate_group_from_query	Yes	removePopulateByQuery	DELETE
remove_qr_action	Yes	removeQrAction	DELETE
remove_qr_add_where_by_id	Yes	removeQrAddWhereById	DELETE
remove_qr_condition	Yes	removeQrCondition	DELETE
remove_qr_definition	Yes	removeQRdefinition	DELETE
remove_qr_replace_element_byId	Yes	removeQrReplaceElementById	DELETE
remove_ranger_config	Yes	deleteConfig	DELETE
remove_ranger_service	Yes	deleteService	DELETE
remove_threshold_from_rule	Yes	deleteRule	PUT
replace_active_profile	Yes	replaceProfile	POST
reregister_agg_collector	No
rerun_datamart	No
rerun_distributed_report	No
reset_unit_utilization_data	Yes	resetUnit	PUT
reset_va_summary_by_id	Yes	resetById	PUT
reset_va_summary_by_key	Yes	resetByKey	PUT
restart_all_managed_units	No
restart_cloud_instance	Yes	restartInstance	POST
restart_job_queue_listener	Yes	execute	PUT
restart_solr	No
restart_stap	Yes	reinitializeBuffer	PUT
restart_unit_pinger	No		PUT
restore_units_after_bad_shift	No
rest_export_definition	Yes	definitionsExport	POST
retreiveUpdatedUsers	Yes	retreiveUpdatedUsers	GET
retrieveApiParameters	Yes	retrieveApiParameters	GET
retrieveAPIs	Yes	retrieveAPI	GET
revokeOAuthClient	Yes	revokeOAuthClient	DELETE
revokeOAuthToken	No		DELETE
revoke_ignore_stap	Yes	unIgnoreStap	POST
revoke_role_from_object_by_id	Yes	removeRole	DELETE
revoke_role_from_object_by_Name	Yes	removeRole	DELETE
riskspotter_set_config	Yes	setRiskspotterConfiguration	POST
rule_info_from_policy	Yes	ruleInfoFromPolicy	GET
run_custom_table_ldap_import	Yes	runLdapImport	POST
run_database_instance_discovery	Yes	runDBInstanceDiscovery	POST
run_diagnostics	Yes	runDiagnostics	PUT
run_populate_group_from_query	Yes	runPopulateByQuery	POST
run_universal_connector	Yes	runLocalUniversalConnector	GET

S

API commands beginning with S.

GuardAPI function name	REST enabled?	REST resource name	REST method
schedule_generate_mongo_filter_job	Yes	scheduleGenerateMongoFilterJob	POST
schedule_job	Yes	scheduleJob	PUT
sched_cust_table_distribution	Yes	scheduleDistribution	PUT
search	Yes	search	GET
secure_settings	Yes	secureSettings
session_inference_control	Yes	controlSessionInference	POST
session_inference_setup	Yes	setupSessionInference	PUT
setOAuthTokenExpirationTime	No		PUT
set_alerter_settings	Yes	updateAlerterSettings	POST
set_alerter_smtp_settings	Yes	updateSmtpSettings	POST
set_alerter_snmp_settings	Yes	updateSnmpSettings	POST
set_certificate_host_validation	Yes	setHostValdation	PUT
set_debug_level	No
set_distributed_report_target	No
set_enterprise_search_options	No
set_entitlement_datasource_parameter	Yes	setEntitlementDatasourceParameter	PUT
set_expiration_date_for_restored_day	Yes	setExpirationForRestoredDate	PUT
set_flatLogProcessType	Yes	setFlatLogProcessType	PUT
set_health_traffic_job_interval	Yes	setFrequency	POST
set_import	Yes	setImport	PUT
set_ip_to_alias_overwrites	Yes	setIpToAliasOverwrites	PUT
set_ip_to_alias_selected	Yes	setIpToAliasSelected	PUT
set_job_process_concurrency_limit	No
set_ktap_debug	Yes	setKtapDebug	PUT
set_load_balancer_param	No
set_outliers_detection_demo_mode	Yes	setOutlierDetectionPocMode	PUT
set_outliers_detection_parameter	No
set_outliers_detection_to_factory_settings	Yes	setOutlierDetectionFactorySettings	PUT
set_outliers_user_detection_mode	Yes	setOutliersDetectionUserMode	PUT
set_populate_group_from_query_schedule	Yes	updateImportFromQuerySchedule	PUT
set_purge_batch_size	No		PUT
set_stap_debug	Yes	setStapDebug	PUT
set_universal_connector_log_level	Yes	setUniversalConnectorLogLevel	POST
set_user_roles	Yes	setUserRoles	PUT
set_ztap_logging_config	Yes	setZtapLoggingConfig	PUT
show_alerter_settings	Yes	showAlerterSettings	GET
show_alerter_smtp_settings	Yes	showSmtpSettings	GET
show_alerter_snmp_settings	Yes	showSnmpSettings	GET
show_alerter_status	Yes	showAlterStatus	GET
show_autodetect_process_status	Yes	showAutoDetectProcessStatus	GET
show_backup_cm_ip	Yes	shoMUSecondaryCMIP	GET
show_maximum_query_duration	Yes	ShowMaxQueryDuration	GET
show_universal_connector_plugins	Yes	showLogstashPlugins	GET
start_istap_monitor	Yes	start_istap_monitor	PUT
stop_audit_process	Yes	stopAuditProcess	PUT
stop_autodetect_process	Yes	stopAutoDetectProcess	PUT
stop_istap_monitor	Yes	end_istap_monitor	PUT
stop_restart_alerter	Yes	stopRestartAlerter	POST
stop_solr	No
stop_universal_connector	Yes	stopLocalUniversalConnector	POST
store_maximum_query_duration	Yes	StoreMaxQueryDuration	PUT
store_sql_credentials	Yes	sendSqlConfiguration	POST
store_stap_approval	Yes	storeStapApproval	POST
switch_outliers_user_mode	No		PUT

T

API commands beginning with T.

GuardAPI function name	REST enabled?	REST resource name	REST method
test_datasource_connection	Yes	testConnection	POST
test_hashicorp_connection	Yes	testHashicorpConnection	POST
test_solr	No
test_solr_connectivity	No
test_solr_hardware_requirements	No

U

API commands beginning with U.

GuardAPI function name	REST enabled?	REST resource name	REST method
unassign_load_balancer_groups	No
unassign_qr_condition_from_action	Yes	unassignQrConditionFromAction	DELETE
uninstall_policy_rule	Yes	uninstallPolicyRule	DELETE
universal_connector_keystore_add	Yes	addWithOverrideKeystoreKey	POST
universal_connector_keystore_list	Yes	listKeystoreKeys	GET
universal_connector_keystore_remove	Yes	removeKeystoreKey	DELETE
unregister_unit	Yes	unRegisterUnit	POST
unschedule_datamart	Yes	unScheduleDatamart	DELETE
update_alias	Yes	updateAlias	PUT
update_assessment	Yes	updateAssessment	PUT
update_assessment_test	Yes	updateAssessmentTest	PUT
update_aws_secrets_manager_config	Yes	updateAwsSecretsManagerConfig	PUT
update_cas_host_instance	Yes	updateCasHostInstance	PUT
update_cas_template	Yes	updateCasTemplate	PUT
update_classifier_action	Yes	actionUpd	PUT
update_classifier_document_rule	Yes	ruleDocumentUpd	PUT
update_classifier_log_level	Yes	updateLogLevel	PUT
update_classifier_policy	Yes	policyUpd	PUT
update_classifier_process	Yes	processUpd	PUT
update_classifier_rule	Yes	ruleUpd	PUT
update_cloud_datasource	Yes	updateCloudDS	PUT
update_computed_attribute	Yes	update	PUT
update_constant_attribute	Yes	update	PUT
update_custom_table_ldap_import	Yes	updateLdapConfig	PUT
update_cyberark_config	Yes	updateCyberarkConfig	PUT
update_datamart	Yes	updateDatamart	PUT
update_datamart_copy_file_threadpool_params	Yes	updateDatamartCopyFileThreadpoolParameters	PUT
update_datasource_by_id	Yes	update	PUT
update_datasource_by_name	Yes	update	PUT
update_datasource_credentials_in_group	Yes	changeCredentials	PUT
update_datasource_custom_property	Yes	updateCustomProp	PUT
update_datasource_group	Yes	updateGroup	PUT
update_engine_config	Yes	updateEngineConfig	PUT
update_entry_location	Yes	updateLocation	PUT
update_group_by_desc	Yes	updateGroup	PUT
update_group_by_id	Yes	update	PUT
update_hashicorp_config	Yes	updateHashicorpConfig	PUT
update_insights_agent_config	Yes	updateInsightsAgentParams	PUT
update_insights_registration_config	Yes	updateInsightsRegistrationConfig	PUT
update_ip_restriction_allowlist	Yes	updateIpList	PUT
update_istap_config	Yes	update_istap_config	PUT
update_managed_units_ping_time	Yes	updateUnitPingTimestamp	PUT
update_policy	Yes	updatePolicy	PUT
update_policy_analyzer_interval	Yes	updateInterval	PUT
update_qr_action	Yes	updateQrAction	PUT
update_qr_add_where_by_id	Yes	updateQrAddWhereById	PUT
update_qr_condition	Yes	updateQrCondition	PUT
update_qr_definition	Yes	updateQRdefinition	PUT
update_qr_replace_element_byId	Yes	updateQrReplaceElementById	PUT
update_quarantine_allowed_until	Yes	updateQuarantineAllowedUntil	PUT
update_quarantine_until	Yes	updateQuarantineUntil	PUT
update_ranger_config	Yes	updateConfig	PUT
update_ranger_hdfs_config	Yes	updateHDFSConfig	POST
update_ranger_service	Yes	updateService	PUT
update_rule	Yes	updateRule	PUT
update_shared_secret	No
update_stap_config	Yes	updateTapConfig	PUT
update_test_detail_exception	Yes	update	PUT
update_test_exception	Yes	update	PUT
update_threshold_in_rule	Yes	updateRuleThreshold	PUT
update_user	Yes	updateUser	PUT
update_user_db	Yes	update	PUT
update_utilization_thresholds	No		PUT
upload_custom_data	Yes	uploadDate	POST

V

API commands beginning with V.

GuardAPI function name	REST enabled?	REST resource name	REST method
venafi_import	Yes	importVenafi	PUT
verify_cyberark_access	Yes	verifyCyberarkAccess	GET
verify_stap_inspection_engine_with_sequence	Yes	verifyInspectionEngineHost	POST