Skip to content

Latest commit

 

History

History

README.md

IBM Guardium Data Security Center Python client

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install ibm-gdsc-sdk-saas==1.0.0

(you may need to run pip with root permission: sudo pip install ibm-gdsc-sdk-saas==1.0.0)

Then import the package:

import ibm_gdsc_sdk_saas

Getting Started

Please follow the installation procedure and then run the following:

import os
import ibm_gdsc_sdk_saas
from ibm_gdsc_sdk_saas.models.tenantuserv3_get_users_response import Tenantuserv3GetUsersResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint



# Configure HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = os.environ['URL'],
    username = os.environ['API_USERNAME'],
    password = os.environ['API_PASSWORD']
)

# Configure API key authorization: ApiKeyAuth
#configuration.api_key['ApiKeyAuth'] = os.environ['API_KEY']
configuration.verify_ssl = False
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#configuration.api_key_prefix['ApiKeyAuth'] = "Basic"
# Enter a context with an instance of the API client

with ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.JumpboxServiceApi(api_client)
    uid = '' # str | Email. (optional)

    try:
        # Summary: Get users Description: Get all users base on a tenantID.
        api_response = api_instance.jumpbox_service_get_users(uid=uid)
        print("The response of JumpboxServiceApi->jumpbox_service_get_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JumpboxServiceApi->jumpbox_service_get_users: %s\n" % e)
Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AssetsServiceApi assets_service_asset_ingestion POST /api/v3/assets/ingestion AssetIngestion - Asset Ingestion Api to ingest assets from different applications including asset extensibility assets.
AssetsServiceApi assets_service_asset_ingestion_manual_trigger POST /api/v3/assets/ingestion/trigger AssetIngestionManualTrigger - Manual trigger for Scheduled Asset Ingestion of databases.
AssetsServiceApi assets_service_clone_policy POST /api/v3/assets/policies/{policy_id}/clone ClonePolicy - Clone a policy.
AssetsServiceApi assets_service_create_update_policy POST /api/v3/assets/policies CreateUpdatePolicy - Create/update new Policy.
AssetsServiceApi assets_service_delete_filter_template_for_assets DELETE /api/v3/assets/filters/template/{template_id} DeleteFilterTemplateForAssets - Deleting a template using TemplateID in manage assets.
AssetsServiceApi assets_service_delete_policies DELETE /api/v3/assets/policies DeletePolicies - Delete Policy returns response code and message.
AssetsServiceApi assets_service_fetch_asset_change_log POST /api/v3/assets/logs FetchAssetChangeLog - Fetch the logs for any actions performed on assets.
AssetsServiceApi assets_service_fetch_asset_dashboard GET /api/v3/assets/dashboard/{widget_type} FetchAssetDashboard - Gets Filter Templates for Dshboard Widgets.
AssetsServiceApi assets_service_fetch_asset_list POST /api/v3/assets FetchAssetList - Asset Fetch Api .
AssetsServiceApi assets_service_fetch_assets_for_merge_split GET /api/v3/assets/configuration FetchAssetsForMergeSplit : Fetch assets for Merge and Split.
AssetsServiceApi assets_service_find_asset_name GET /api/v3/assets/name FindAssetName - Checks if the given Asset Name has already been assigned to an asset.
AssetsServiceApi assets_service_get_asset_overview GET /api/v3/assets/overview GetAssetOverview - Get asset overview widgets data for a particular asset.
AssetsServiceApi assets_service_get_asset_topology POST /api/v3/assets/topology GetAssetTopology- Get list of topology for a parent asset.
AssetsServiceApi assets_service_get_filter_template_for_assets GET /api/v3/assets/filters/templates GetFilterTemplateForAssets - Get list of filters query templates for manage assets.
AssetsServiceApi assets_service_get_filters_for_assets GET /api/v3/assets/filters GetFiltersForAssets - Get a list of filters category and sub category with all data.
AssetsServiceApi assets_service_list_policy GET /api/v3/assets/policies ListPolicy - List all policies.
AssetsServiceApi assets_service_list_rule GET /api/v3/assets/policies/{policy_id}/rules ListRule - List all rules for a policy.
AssetsServiceApi assets_service_list_tag_domains GET /api/v3/assets/tags/categories ListTagDomains - Get Tag categories by request parameters .
AssetsServiceApi assets_service_list_tags GET /api/v3/assets/tags ListTags - Get Tags for Manage Tags listing screen .
AssetsServiceApi assets_service_merge_or_split_assets POST /api/v3/assets/configuration MergeOrSplitAssets - Merge or split the selected assets.
AssetsServiceApi assets_service_save_assigned_tags POST /api/v3/assets/tags/assign SaveAssignedTags - Save Assigned Tags to TAG_DSDEF_MAP table.
AssetsServiceApi assets_service_save_tag_concept_data POST /api/v3/assets/tags SaveTagConceptData - creates a custom tag
AssetsServiceApi assets_service_save_tag_domain_data POST /api/v3/assets/tags/categories SaveTagDomainData - creates a custom category to be assigned to a tag
AssetsServiceApi assets_service_save_update_filter_template_for_assets POST /api/v3/assets/filters/templates SaveUpdateFilterTemplateForAssets - Save/Update a filters query to use as template in manage assets along with reordering of template list.
AssetsServiceApi assets_service_set_banner_state PUT /api/v3/assets/banner SetBannerState - Set banner state for asset inventory page.
AssetsServiceApi assets_service_update_asset_name PUT /api/v3/assets/name UpdateAssetName - Udates the name of the asset as given by the user.
AssetsServiceApi assets_service_update_policy PUT /api/v3/assets/policies UpdatePolicy - Update existing Policy status.
AuditServiceApi audit_service_get_activity_records GET /api/v3/activity Summary: Get activity records Description: Return activity records that match the arguments passed in the request. Multiple values can be passed to the (UID, Context, ActionTaken, PerformedBy) fields by supplying a comma-separated list to the corresponding fields in the request. For instance to check for multiple Contexts set the field to "op1, op2, op3".
AuditServiceApi audit_service_put_download_activity_record POST /api/v3/activity Summary: Put download activity record Description: Create an activity log record with the arguments passed in the request.
AuthServerServiceApi auth_server_service_create_oauth_client POST /api/v3/oauth/clients Summary: Create Oauth client Description: Create/register new Oauth client.
AuthServerServiceApi auth_server_service_delete_oauth_client DELETE /api/v3/oauth/clients/{client_id} Summary: Delete Oauth client Description: Delete registered Oauth client by clientId.
AuthServerServiceApi auth_server_service_get_access_token GET /api/v3/oauth/token Summary: Get access token Description: Get access token from passed clientId and secret.
AuthServerServiceApi auth_server_service_get_oauth_client GET /api/v3/oauth/clients/{client_id} Summary: Get Oauth client Description: Get registered Oauth client by clientId.
AuthServerServiceApi auth_server_service_get_user GET /api/v3/auth/user Summary: Get user Description: Get user.
AuthServerServiceApi auth_server_service_list_oauth_client GET /api/v3/oauth/clients Summary: List Oauth client Description: List all registered Oauth client.
CloudAccountsApi add_analyzed_region POST /api/v1/dspm/cloudAccounts/cloudProviders/analyzedRegions Add a new region for data classification
CloudAccountsApi add_cloud_accounts POST /api/v1/dspm/cloudAccounts/cloudProviders Add cloud account connections to DSPM
CloudAccountsApi generate_atlassian_confluence_auth_url GET /api/v1/dspm/cloudAccounts/saasApps/atlassian-confluence/generateAuthUrl Generate a Confluence authentication URL
CloudAccountsApi generate_atlassian_jira_auth_url GET /api/v1/dspm/cloudAccounts/saasApps/atlassian-jira/generateAuthUrl Generate a JIRA authentication URL
CloudAccountsApi generate_azure_auth_url GET /api/v1/dspm/cloudAccounts/azure/generateAuthUrl Generate azure authorization url
CloudAccountsApi generate_office365_auth_url GET /api/v1/dspm/cloudAccounts/saasApps/office365/generateAuthUrl Generate a Microsoft 365 consent URL
CloudAccountsApi generate_slack_auth_url GET /api/v1/dspm/cloudAccounts/saasApps/slack/generateAuthUrl Generate a Slack authentication URL
CloudAccountsApi generate_snowflake_auth_url POST /api/v1/dspm/cloudAccounts/saasApps/snowflake/generateAuthUrl Validate and Generate a Snowflake OAuth URL
CloudAccountsApi get_analyzed_region_status GET /api/v1/dspm/cloudAccounts/cloudProviders/analyzedRegions/status Get the status of analyzer installation for a region
CloudAccountsApi get_azure_admin_consent_status GET /api/v1/dspm/cloudAccounts/azure/getAdminConsentStatus Get Azure admin consent status
CloudAccountsApi get_cloud_account_installation_status GET /api/v1/dspm/cloudAccounts/{cloudProvider}/{cloudAccountId}/installationStatus Get the installation status of a cloud account
CloudAccountsApi get_refresh_token_expiry GET /api/v1/dspm/cloudAccounts/saasApps/snowflake/getRefreshTokenExpiry/{providerId} Get Snowflake Refresh Token Expiry date
CloudAccountsApi list_linked_accounts GET /api/v1/dspm/cloudAccounts/linkedAccounts List cloud accounts connected to DSPM
CloudAccountsApi remove_accounts DELETE /api/v1/dspm/cloudAccounts/removeAccounts Post cloud account ID connections to be removed
CloudAccountsApi remove_accounts_instructions GET /api/v1/dspm/cloudAccounts/removeAccountsInstructions Post cloud account IDs and get instructions to remove the accounts
CloudAccountsApi retrieve_service_account_id GET /api/v1/dspm/cloudAccounts/saasApps/google/retrieveServiceAccountId Get Google Workspace authentication
CloudAccountsApi snowflake_integration_script GET /api/v1/dspm/cloudAccounts/saasApps/snowflake/snowflakeIntegrationScript Generate Snowflake Integration Script
CloudAccountsApi submit_google_workspace_admin_email POST /api/v1/dspm/cloudAccounts/saasApps/google/submitAdminEmail Submit email for service account authorization
CloudAccountsApi submit_office365_tenant_info POST /api/v1/dspm/cloudAccounts/saasApps/office365/submitTenantInfo Submit Microsoft 365 customer information
CloudAccountsApi submit_slack_auth_code POST /api/v1/dspm/cloudAccounts/saasApps/slack/submitAuthCode Submit a Slack authentication code
CloudAccountsApi submit_snowflake_auth_code POST /api/v1/dspm/cloudAccounts/saasApps/snowflake/submitAuthCode Submit Snowflake oAuth code
ComplianceAcceleratorApi compliance_accelerator_create_workspace POST /api/v3/compliance/workspace Summary: Create workspace Description: Create a workspace.
ComplianceAcceleratorApi compliance_accelerator_delete_compliance_workspaces DELETE /api/v3/compliance Summary: Delete compliance workspaces Description: Delete workspaces.
ComplianceAcceleratorApi compliance_accelerator_get_compliance_info GET /api/v3/compliance Summary: Get compliance info Description: Return stored compliance data.
ComplianceAcceleratorApi compliance_accelerator_hydrate_workspace POST /api/v3/compliance/workspace/hydrate HydrateWorkspace - Hydrates specified objects within a workspace
ComplianceAcceleratorApi compliance_accelerator_store_compliance_info POST /api/v3/compliance Summary: Store compliance info Description: Store compliance data.
ConnectionsServiceApi connections_service_create_connections_accounts POST /api/v3/connections/accounts Summary: Create Connections accounts Description: Create Connections acccounts.
ConnectionsServiceApi connections_service_create_connections_configs POST /api/v3/connections/configs Summary: Create connections configs Description: Create Connection config by connection type.
ConnectionsServiceApi connections_service_create_plugin POST /api/v3/connections/plugins Summary: Create plugin Description: Create UC generic plugin
ConnectionsServiceApi connections_service_create_settings POST /api/v3/connections/settings Summary: Create settings Description: Create Settings.
ConnectionsServiceApi connections_service_delete_connections_accounts DELETE /api/v3/connections/accounts/{account_id} Summary: Delete Connections accounts Description: Delete Connections acccounts.
ConnectionsServiceApi connections_service_delete_connections_configs DELETE /api/v3/connections/configs/{connection_id} Summary: Delete connections configs Description: Delete Connection config by connection id.
ConnectionsServiceApi connections_service_delete_connector DELETE /api/v3/connections/{connection_id} Summary: Delete connector Description: Delete a Connection.
ConnectionsServiceApi connections_service_delete_plugin DELETE /api/v3/connections/plugins/{id} Summary: Delete plugin. Description: Delete plugin.
ConnectionsServiceApi connections_service_generate_package PUT /api/v3/connections/plugins/{id}/package Summary: Generate package. Description: Generate package.
ConnectionsServiceApi connections_service_get_banner_state GET /api/v3/connections/banner Summary: Get banner state for object verb page. Description: Get banner state for object verb page.
ConnectionsServiceApi connections_service_get_connections_accounts GET /api/v3/connections/accounts Summary: Get Connections accounts Description: Get Connections acccounts.
ConnectionsServiceApi connections_service_get_connections_configs GET /api/v3/connections/configs Summary: Get connections configs Description: Get Connection config by connection type.
ConnectionsServiceApi connections_service_get_connections_with_filters POST /api/v3/connections Summary: Get connections with filters Description: Get connections with filters.
ConnectionsServiceApi connections_service_get_connectors_summary GET /api/v3/connections/summary Summary: Get connectors summary Description: Get a summary of Connectors.
ConnectionsServiceApi connections_service_get_data_sources GET /api/v3/connections/datasources Summary: Get data sources Description: Get a list of data sources.
ConnectionsServiceApi connections_service_get_guard_record_fields GET /api/v3/connections/fields Summary: Get list of guard record fields. Description: Get list of guard record fields.
ConnectionsServiceApi connections_service_get_headers GET /api/v3/connections/headers Summary: Get headers Description: Get a list of Headers.
ConnectionsServiceApi connections_service_get_plugins GET /api/v3/connections/plugins Summary: Get plugins Description: Get custom universal connector plugins
ConnectionsServiceApi connections_service_get_settings GET /api/v3/connections/settings Summary: Get settings Description: Get a list of Settings.
ConnectionsServiceApi connections_service_partial_update_connectors PATCH /api/v3/connections Summary: Partial update connectors Description: Partial update of Connectors.
ConnectionsServiceApi connections_service_post_stap_command POST /api/v3/stap/commands Summary: Post stap command Description: Send a STAP command down to kafka for snif-assist.
ConnectionsServiceApi connections_service_update_banner_state PUT /api/v3/connections/banner Summary: Update banner state for object verb page. Description: Update banner state for object verb page.
ConnectionsServiceApi connections_service_update_connections_accounts PUT /api/v3/connections/accounts Summary: Update Connections accounts Description: Update Connections acccounts.
ConnectionsServiceApi connections_service_update_connections_configs PATCH /api/v3/connections/configs Summary: Update connections configs Description: Update Connection config by connection id.
ConnectionsServiceApi connections_service_update_connectors PUT /api/v3/connections Summary: Update connectors Description: Update a list of Connectors.
ConnectionsServiceApi connections_service_update_plugin PUT /api/v3/connections/plugins/{id} Summary: Update plugin. Description: Update plugin.
ConnectionsServiceApi connections_service_update_settings PUT /api/v3/connections/settings Summary: Update settings Description: Update Settings.
ConnectionsServiceApi connections_service_validate_aws_connection POST /api/v3/connections/validate/aws Summary: Validate an AWS connection. Description: Validate an AWS connection.
DashboardsServiceApi dashboards_service_create_dashboard POST /api/v3/dashboards Summary: Create dashboard Description: Create a unique dashboard.
DashboardsServiceApi dashboards_service_delete_dashboard DELETE /api/v3/dashboards/{dashboard_id} Summary: Delete dashboard Description: Delete a unique dashboard.
DashboardsServiceApi dashboards_service_get_dashboards GET /api/v3/dashboards Summary: Get dashboards Description: Get a list of dashboards with all data.
DashboardsServiceApi dashboards_service_update_dashboard PUT /api/v3/dashboards/{dashboard_id} Summary: Update dashboard Description: Update a dashboard.
DataMovementsApi get_actual_flow GET /api/v1/dspm/dataMovements/actualFlows/{id} Get actual flow by providing its ID
DataMovementsApi get_actual_flows_summary GET /api/v1/dspm/dataMovements/actualFlows/summary Get summary of actual flows
DataMovementsApi get_potential_flow GET /api/v1/dspm/dataMovements/potentialFlows/{flowId} Get potential flow by providing its ID
DataMovementsApi get_potential_flow_path GET /api/v1/dspm/dataMovements/potentialFlows/paths/{flowPathId} Get potential flow path by providing its ID
DataMovementsApi get_potential_flows_summary GET /api/v1/dspm/dataMovements/potentialFlows/summary Get summary of potential flows according to the filter applied
DataMovementsApi list_actual_flow_paths GET /api/v1/dspm/dataMovements/actualFlowPaths Get summary of actual flows according to the filter applied
DataMovementsApi list_actual_flows GET /api/v1/dspm/dataMovements/actualFlows List actual flows
DataMovementsApi list_potential_flows GET /api/v1/dspm/dataMovements/potentialFlows List potential flows
DataMovementsApi list_potential_flows_paths GET /api/v1/dspm/dataMovements/potentialFlows/paths List potential flow paths
DataResourcesApi get_data_resource GET /api/v1/dspm/dataResources/{dataResourceId} Get a specific data resource by its ID
DataResourcesApi get_data_resources_summary GET /api/v1/dspm/dataResources/summary Data resources summary
DataResourcesApi list_data_resources GET /api/v1/dspm/dataResources List data resources that match a given filter
DataResourcesApi list_data_resources_names GET /api/v1/dspm/dataResources/names List names of data resources
DataResourcesApi remove_resource DELETE /api/v1/dspm/dataResources/{dataResourceId}/removeResource Remove resource from DSPM
DataResourcesApi update_resource_review_status PUT /api/v1/dspm/dataResources/{dataResourceId}/reviewed Set review status of a data resource
DataSensitivitiesApi get_sensitivities_summary GET /api/v1/dspm/sensitivities/summary Get the summary of sensitivities
DataSensitivitiesApi get_sensitivity GET /api/v1/dspm/sensitivities/{sensitivityId} Get sensitivity details by providing its ID
DataSensitivitiesApi list_sensitivities GET /api/v1/dspm/sensitivities List sensitivities
DataStoresApi get_data_store GET /api/v1/dspm/dataStores/{dataStoreId} Get a data store by its ID
DataStoresApi get_data_stores_summary GET /api/v1/dspm/dataStores/summary Get summary of data stores
DataStoresApi list_all_data_stores_labels GET /api/v1/dspm/dataStores/labels List labels of data stores.
DataStoresApi list_data_stores GET /api/v1/dspm/dataStores List data stores
DataStoresApi list_data_stores_cloud_tags_keys GET /api/v1/dspm/dataStores/cloudTags/keys List the cloud tag keys of data stores that can be filtered on the basis of prefixes.
DataStoresApi list_data_stores_cloud_tags_values GET /api/v1/dspm/dataStores/cloudTags/values List the cloud tag values of data stores that can be filtered on the basis of prefixes and cloud tag key names.
DataStoresApi list_data_stores_names GET /api/v1/dspm/dataStores/filters/name List name of filterable data stores
DataStoresApi rescan_data_store POST /api/v1/dspm/dataStores/rescan Post data store rescan request
DataStoresApi set_data_store_label PUT /api/v1/dspm/dataStores/{dataStoreId}/labels Label a data store with an existing or new label
DataStoresApi update_datastore_custodian POST /api/v1/dspm/dataStores/custodian Update the name of a Data store custodian
DataVulnerabilitiesApi add_vulnerability_status_comment POST /api/v1/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments Add vulnerability status comment
DataVulnerabilitiesApi get_vulnerabilities_summary GET /api/v1/dspm/vulnerabilities/summary Get vulnerabilities summary
DataVulnerabilitiesApi get_vulnerability GET /api/v1/dspm/vulnerabilities/{vulnerabilityId} Get vulnerability details by ID
DataVulnerabilitiesApi list_vulnerabilities GET /api/v1/dspm/vulnerabilities List vulnerabilities based on an applied filter
DataVulnerabilitiesApi list_vulnerabilities_by_data_store GET /api/v1/dspm/vulnerabilities/byDataStore List vulnerabilities of data stores
DataVulnerabilitiesApi remove_vulnerability_status_comment DELETE /api/v1/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Delete vulnerability status comment
DataVulnerabilitiesApi set_vulnerability_status POST /api/v1/dspm/vulnerabilities/{vulnerabilityId}/statuses Set status of a vulnerability
DataVulnerabilitiesApi update_vulnerability_status_comment PUT /api/v1/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Set vulnerability status
DatabootstrapperServiceApi databootstrapper_service_load_data POST /api/v3/databootstrapper/data Summary: Load data Description: Load data for a tenant.
DatamartProcessorServiceApi datamart_processor_service_get_datamart_info GET /api/v3/datamarts/info Summary: Get datamarts Description: Return a list of files inside a datamart to the caller.
DatamartProcessorServiceApi datamart_processor_service_get_datamarts GET /api/v3/datamarts Summary: Get datamarts Description: Return a list of datamarts for a time interval to the caller.
DatamartProcessorServiceApi datamart_processor_service_get_earliest_start_time GET /api/v3/datamarts/earliest_start_time Summary: Get rarliest start time Description: Return the earliest time period of data available in database.
DatamartProcessorServiceApi datamart_processor_service_send_all_complete_files_to_queue POST /api/v3/datamarts/repush_files
DatamartProcessorServiceApi datamart_processor_service_store_extraction_logs POST /api/v3/datamarts/{request_id}/dm_extraction_logs Summary: Store extraction logs Description: Store the datamart extraction logs inside GI.
DatamartProcessorServiceApi upload_datamart POST /api/v3/datamarts/upload Summary: Upload datamart Description: Upload datamart file for ingestion.
EcosystemServiceApi ecosystem_service_create_dataset POST /api/v3/integrations/datasets Summary: Create dataset Description: Save a definition in the database.
EcosystemServiceApi ecosystem_service_data_insert POST /api/v3/integrations/datasets/{dataset_name} Summary: Data insert Description: Process Data received from webhook API and insert.
EcosystemServiceApi ecosystem_service_delete_datasets DELETE /api/v3/integrations/datasets Summary: Delete datasets Description: Delete an array of datasets.
EcosystemServiceApi ecosystem_service_get_dataset_data GET /api/v3/integrations/datasets/{dataset_name}/data Summary: Get dataset data Description: Return data report for a given dataset.
EcosystemServiceApi ecosystem_service_get_dataset_detail GET /api/v3/integrations/datasets/{dataset_name}/details Summary: Get dataset detail Description: Return detail on a dataset definition.
EcosystemServiceApi ecosystem_service_get_datasets GET /api/v3/integrations/datasets Summary: Get datasets Description: Return dataset list that matches the specified filter.
EcosystemServiceApi ecosystem_service_get_purgable_rows POST /api/v3/integrations/purge Summary: Get purgable rows Description: Check the number of rows that can be purged.
EcosystemServiceApi ecosystem_service_purge_data DELETE /api/v3/integrations/datasets/data Summary: Purge data Description: Purge data.
EcosystemServiceApi ecosystem_service_test_integration POST /api/v3/integrations/setup/test Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible a test message is sent to the integration to ensure it is functional. Currently this API only supports API_IMPORT type integrations
FeatureFlagsServiceApi feature_flags_service_delete_feature_flag_overrides DELETE /api/v3/feature_flags/overrides Summary: Delete feature Flag overrides Description: Delete feature Flag overrides from database.
FeatureFlagsServiceApi feature_flags_service_get_feature_flag_overrides GET /api/v3/feature_flags/overrides Summary: Get feature Flag overrides Description: Get feature Flag overrides by Feature Flag Name.
FeatureFlagsServiceApi feature_flags_service_get_feature_flags GET /api/v3/feature_flags Summary: Get feature flags Description: Get feature flags by Feature Flag Name.
FeatureFlagsServiceApi feature_flags_service_update_feature_flag_overrides PUT /api/v3/feature_flags/overrides Summary: Update feature Flag overrides Description: Update feature Flag overrides in the database.
GroupBuilderApi group_builder_cancel_import_group DELETE /api/v3/groups_import Summary: Cancel import group Description: Cancel import refresh for selected groups.
GroupBuilderApi group_builder_create_group POST /api/v3/groups Summary: Create group Description: Create new groups.
GroupBuilderApi group_builder_delete_group DELETE /api/v3/groups Summary: Delete group Description: Delete specified groups if the group ID is not used for reports.
GroupBuilderApi group_builder_edit_group PATCH /api/v3/groups/{group_id} Summary: Edit group Description: Add or delete group members.
GroupBuilderApi group_builder_export_group POST /api/v3/groups_export Summary: Export group Description: Export group content to a file based on a group ID.
GroupBuilderApi group_builder_get_group_details GET /api/v3/groups/{group_id} Summary: Get group details Description: Get details of group specified by group ID.
GroupBuilderApi group_builder_get_group_members POST /api/v3/groups/search Summary: Get group members Description: Get members of all the group ids provided in the request. To be consumed by policy builder ms.
GroupBuilderApi group_builder_get_group_sync_mapping GET /api/v3/groups/mappings/sync Summary: Get GDP to gi group mapping Description: Get GDSC to GDP group sync mapping.
GroupBuilderApi group_builder_get_group_type_mapping GET /api/v3/groups-mappings Summary: Get group type mapping Description: Get GDSC to GDP group types mapping.
GroupBuilderApi group_builder_get_group_types GET /api/v3/group_types Summary: Get group types Description: Get a list of available group types.
GroupBuilderApi group_builder_get_groups GET /api/v3/groups Summary: Get groups Description: Get a list of imported group members.
GroupBuilderApi group_builder_get_import_groups GET /api/v3/groups_import Summary: Get import groups Description: Get unsynchronized groups from a central manager.
GroupBuilderApi group_builder_import_group POST /api/v3/groups_import Summary: Import group Description: Import selected groups from a central manager. (This API is called from GDP only)
GroupBuilderApi group_builder_refresh_groups POST /api/v3/groups/refresh Summary: Refresh groups Description: Refresh tenants selected imported groups.
GroupBuilderApi group_builder_reset_groups POST /api/v3/groups/reset Summary: Reset groups Description: Resets tenants selected predefined groups.
GroupBuilderApi group_builder_store_group_members_gdp POST /api/v3/central_managers/{central_manager_id}/groups/members Summary: Store group members Gdp Description: Store GDP groups. (This API is called from GDP only)
GroupBuilderApi group_builder_store_groups_gdp POST /api/v3/central_managers/{central_manager_id}/groups Summary: Store groups Gdp Description: Store GDP groups. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_add_cm POST /api/v3/central_managers Summary: Add CM Description: Add a Central Manager to the tenant database.
GuardiumConnectorApi guardium_connector_add_datamarts POST /api/v3/central_managers/{central_manager_id}/datamarts Description: stores datamarts details from GDP. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_add_dm_exclusion POST /api/v3/datamarts/exclusion_list Summary: Add DM exclusion Description: Add datamart to exclusion list.
GuardiumConnectorApi guardium_connector_add_task POST /api/v3/central_managers/{central_manager_id}/tasks Summary: Add task Description: Add a task to be executed on GDP. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_block_user POST /api/v3/block_user Summary: Block user Description: Block a database user on Guardium Data Protection or on a supported Database as a Service instance.
GuardiumConnectorApi guardium_connector_configure_aggregator_export PUT /api/v3/central_managers/{central_manager_id}/aggregator_config_export Summary: Configure aggregator export Description: Configure datamart export from the Aggregators to GI.
GuardiumConnectorApi guardium_connector_configure_collector_export PUT /api/v3/central_managers/{central_manager_id}/collector_config_export Summary: Configure collector export Description: Schedule export historical data for collectors.
GuardiumConnectorApi guardium_connector_configure_streaming POST /api/v3/central_managers/{central_manager_id}/streaming Summary: Configure streaming Description: Enable or disable streaming.
GuardiumConnectorApi guardium_connector_datamart_version_check POST /api/v3/central_managers/{central_manager_id}/datamart_version Description: validates if central manager has v5 datamart support. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_delete_cm DELETE /api/v3/central_managers/{central_manager_id} Summary: Delete CM Description: Delete a Central Manager by ID (Name, Hostname or IP).
GuardiumConnectorApi guardium_connector_delete_dm_exclusion DELETE /api/v3/datamarts/exclusion_list Summary: Delete DM exclusion Description: Delete a datamart from exclusion list.
GuardiumConnectorApi guardium_connector_delete_task DELETE /api/v3/central_managers/{central_manager_id}/tasks/{task_id} Summary: Delete task Description: Delete a task by central manager id and task id. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_delete_tasks DELETE /api/v3/central_managers/{central_manager_id}/tasks Summary: Delete tasks Description: Delete a central manager's tasks by central manager id. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_get_aggregators_config GET /api/v3/central_managers/{central_manager_id}/aggregators_config Summary: Get aggregators config Description: Return a list of managed units from the config collection in tenant database.
GuardiumConnectorApi guardium_connector_get_cms GET /api/v3/central_managers Summary: Get CMs Description: Return a list of Central Managers from the tenant database with additional processing.
GuardiumConnectorApi guardium_connector_get_cms_config GET /api/v3/central_managers_config Summary: Get CMs config Description: Return a list of Central Managers from the tenant database.
GuardiumConnectorApi guardium_connector_get_collectors_config GET /api/v3/central_managers/{central_manager_id}/collectors_config Summary: Get collectors config Description: Return the list of collectors configuration from the tenant database.
GuardiumConnectorApi guardium_connector_get_datamarts GET /api/v3/central_managers/{central_manager_id}/datamarts Description: returns full list of supported datamarts including type (historical or non-historical)
GuardiumConnectorApi guardium_connector_get_dm_exclusion GET /api/v3/datamarts/exclusion_list Summary: Get DM exclusion Description: Return datamarts in the exclusion list.
GuardiumConnectorApi guardium_connector_get_gdp_policy_info GET /api/v3/central_managers/{central_manager_id}/policies/info Summary: Get guardium policy definition Description: returns the policy definition on the cm
GuardiumConnectorApi guardium_connector_get_gdp_policy_summaries GET /api/v3/central_managers/{central_manager_id}/policies/summaries Summary: Get guardium policy summary Description: returns the summaries of all policies on that central manager
GuardiumConnectorApi guardium_connector_get_health_info GET /api/v3/central_managers/{central_manager_id}/health_info Summary: Get health info Description: Get health information from Guardium Data Protection central mamangers. (This API is for CMs registered in legacy pull mode. Supported on-premises only)
GuardiumConnectorApi guardium_connector_get_latest_dm_extraction_profile GET /api/v3/central_managers/{central_manager_id}/datamart_extraction_profile Summary: Get latest DM extraction profile Description: Return the Datamart Extraction Profile for GDSC.
GuardiumConnectorApi guardium_connector_get_streaming_status GET /api/v3/central_managers/{central_manager_id}/streaming Summary: Get streaming status Description: Return the streaming configuration.
GuardiumConnectorApi guardium_connector_get_sync_dms GET /api/v3/central_managers/{central_manager_id}/sync Summary: Get sync DMs Description: Return the list of tasks from a central manager. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_get_task_types GET /api/v3/central_managers/task_types Summary: Get task types Description: Return the list of supported task types.
GuardiumConnectorApi guardium_connector_get_tasks GET /api/v3/central_managers/{central_manager_id}/tasks Summary: Get tasks Description: Return the list of tasks from a central manager. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_run_gdp_report POST /api/v3/central_managers/{central_manager_id}/run_report Summary: Run GDP report Description: Run GDP report. (This API is for CMs registered in legacy pull mode. Supported on-premises only)
GuardiumConnectorApi guardium_connector_setup_cm POST /api/v3/central_managers/setup Summary: Setup CM Description: Set up the registration between a GDP Central manager and GDSC. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_setup_datamarts POST /api/v3/central_managers/{central_manager_id}/datamarts/setup Description: setup custom datamart execution mode
GuardiumConnectorApi guardium_connector_task_error POST /api/v3/central_managers/{central_manager_id}/tasks/error Summary: Task error Description: Log error messages from GDP task execution. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_test_database_connection POST /api/v3/test_database Summary: Test database connection Description: Return database connection results.
GuardiumConnectorApi guardium_connector_update_dm_exclusion PUT /api/v3/datamarts/exclusion_list Summary: Update DM exclusion Description: Update the atamart exclusion list.
GuardiumConnectorApi guardium_connector_update_streaming PUT /api/v3/central_managers/{central_manager_id}/streaming Summary: Update streaming Description: Update streaming status into GI. (This API is called from GDP only)
GuardiumConnectorApi guardium_connector_update_task PUT /api/v3/central_managers/{central_manager_id}/tasks/{task_id} Summary: Update task Description: Update a task that gets executed on GDP. (This API is called from GDP only)
HealthCollectorApi health_collector_get_data_warehouse_usage GET /api/v3/metrics/warehouse/{type} Summary: Get data warehouse usage info Description: Get information from data warehouse related to usage
HealthCollectorApi health_collector_get_gdp_health_info GET /api/v3/health Summary: Get GDP health info Description: Get information from MongoDB for Guardium central managers using health-connector service.
HealthCollectorApi health_collector_get_historical_health_info GET /api/v3/health/history Summary: Get historical health info Description: Retrieve historical s-tap related statistics from health-collector service.
HealthCollectorApi health_collector_get_object_storage_usage GET /api/v3/metrics/object_storage/{type} Summary: Get object storage usage info Description: Get information from object storage about tenant bucket usage
HealthCollectorApi health_collector_get_pod_restarts GET /api/v3/metrics/pods/{type} Summary: Get the pod restart information Description: Get information about the number of restarts by pod in OCP
HealthCollectorApi health_collector_get_pvc_usage GET /api/v3/metrics/pvc/{type} Summary: Get the PVC usage information Description: Get information about the PVC usage in the OCP cluster
HealthCollectorApi health_collector_get_streams_ingestion GET /api/v3/metrics/streams/{type} Summary: Get streams ingestion volume over a given time Description: Get information about streams ingestion volume
HealthCollectorApi health_collector_get_top_gdp_collectors GET /api/v3/metrics/collectors/{type} Summary: Get the top GDP collectors which send data to GI Description: Get information about the top GDP collectors
HealthCollectorApi health_collector_store_health_info POST /api/v3/health/central_managers/{central_manager_id}/health_info Summary: Store health info Description: Store health info from GDP into GI. (This API is called from GDP only)
JumpboxServiceApi jumpbox_service_authorize POST /api/v3/authorization Summary: Authorize Description: Authenticate a user and return a JWT.
JumpboxServiceApi jumpbox_service_delete_tenant DELETE /api/v3/tenants/{tenant_id} Summary: Delete tenant Description: Delete a tenant.
JumpboxServiceApi jumpbox_service_delete_user DELETE /api/v3/users/{user_id} Summary: Delete user Description: Delete the user.
JumpboxServiceApi jumpbox_service_get_tenant GET /api/v3/tenants/{tenant_id} Summary: Get tenant Description: Get a tenant.
JumpboxServiceApi jumpbox_service_get_tenants GET /api/v3/tenants Summary: Get tenants Description: Get all tenant base on UID.
JumpboxServiceApi jumpbox_service_get_users GET /api/v3/users Summary: Get users Description: Get all users base on a tenantID.
JumpboxServiceApi jumpbox_service_post_tenants POST /api/v3/tenants Summary: Post tenants Description: Create a tenant.
JumpboxServiceApi jumpbox_service_post_users POST /api/v3/users Summary: Post users Description: Create users.
JumpboxServiceApi jumpbox_service_search_users POST /api/v3/users/search Summary: Search users Description: Search for all users matching the provided string.
JumpboxServiceApi jumpbox_service_test_user POST /api/v3/users/test Summary: Test user Description: Test a user lookup to a given LDAP.
JumpboxServiceApi jumpbox_service_update_tenant PATCH /api/v3/tenants/{tenant_id} Summary: Update tenant Description: Update a tenant.
JumpboxServiceApi jumpbox_service_update_users PATCH /api/v3/users Summary: Update users Description: Update an array of users.
NotificationsServiceApi notifications_service_create_ticket POST /api/v3/integrations/ticket Summary: Create ticket Description: Create ticket based on information passed in.
NotificationsServiceApi notifications_service_get_folders POST /api/v3/integrations/folders Summary: Get folders Description: Get folder for the integration connection provided.
NotificationsServiceApi notifications_service_get_notification_filename GET /api/v3/notifications/filename Summary: Get notification filename Description: Return filename associated with the notifications record referenced in the associated context record. The notification id is required but may be set in the associated authentication token or explicitly in the request.
NotificationsServiceApi notifications_service_get_notification_record GET /api/v3/notifications/details/{notification_id} Summary: Get notification record Description: Return notifications record with the specified ID.
NotificationsServiceApi notifications_service_get_notification_records GET /api/v3/notifications Summary: Get notification records Description: Return notifications records that match the specified filter.
NotificationsServiceApi notifications_service_get_ticket_status GET /api/v3/integrations/ticket/status Summary: Get ticket status Description: Get the status of the given ticket
NotificationsServiceApi notifications_service_post_notification_record POST /api/v3/notifications Summary: For PostNotificationRecord notification only Description: Sends notification with recipients and returns a status
NotificationsServiceApi notifications_service_search_notification_records POST /api/v3/notifications/search Summary: Search notification records Description: Return notification records using pipeline of filters
NotificationsServiceApi notifications_service_test_integration POST /api/v3/integrations/test Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible a test message is sent to the integration to ensure it is functional.
NotificationsServiceApi notifications_service_update_notification_record PUT /api/v3/notifications Summary: Update notification record Description: Update a notification record with the specified values. The ID field is required and must match an existing notification. All fields other than the ID are optional. Creation timestamp, user and other administrative fields can not updated.
OutliersEngineApi outliers_engine_get_source_statistics GET /api/v3/outliers/source/statistics Summary: Get source statistics Description: Return statistics regarding the input source, including distribution of verbs, source program, working hours etc.
OutliersEngineApi outliers_engine_get_statistics GET /api/v3/outliers/statistics Summary: Get statistics Description: Return statistics regarding number of outliers, clusters and un/completed periods.
OutliersEngineApi outliers_engine_get_working_hours_periods GET /api/v3/outliers/working_hours_periods Summary: Get working hours periods Description: Get a list of the working hours periods.
OutliersEngineApi outliers_engine_run_simulator POST /api/v3/outliers/simulator Summary: Run simulator Description: Run outlier simulator.
OutliersEngineApi outliers_engine_update_working_hours_periods PUT /api/v3/outliers/working_hours_periods Summary: Update working hours periods Description: Update the working hours periods values.
OutliersEngineApi outliers_engine_upload_and_analyze_period POST /api/v3/outliers Summary: Upload and analyze period Description: Run outliers detection on ready periods.
OutliersEngineApi outliers_engine_user_clustering POST /api/v3/outliers/clusters Summary: User clustering Description: Run user-clustering on current sources.
PipelineconfigServiceApi pipelineconfig_service_delete_tenant_resources DELETE /api/v3/resources/{tenant_id}/{resource} Summary: Delete a tenant resource Description: Delete tenant specific resources such as data warehouse, mongo, postgres and s3.
PolicyBuilderApi policy_builder_clone_policy POST /api/v3/policies/clone/{policy_id} Summary: Clone policy Description: Clone a policy.
PolicyBuilderApi policy_builder_create_policy POST /api/v3/policies Summary: Create policy Description: Create Policy returns response code and message.
PolicyBuilderApi policy_builder_delete_gdp_sync_entry DELETE /api/v3/policies/sync_entry Summary: Delete GDP policy sync entry Description: Deletes GDP policy from sync collection
PolicyBuilderApi policy_builder_delete_policies DELETE /api/v3/policies Summary: Delete policies Description: Delete Policy returns response code and message.
PolicyBuilderApi policy_builder_get_gdp_policy_meta_data GET /api/v3/policies/metadata_list Summary: Get GDP policy summary information Description: Get GDP's CM's policy summary from mogodb
PolicyBuilderApi policy_builder_get_policies GET /api/v3/policies Summary: Get policies Description: Return a list of policies to the caller.
PolicyBuilderApi policy_builder_get_policy_details GET /api/v3/policies/{policy_id}/details Summary: Get policy details Description: Return a list of rules inside the policy.
PolicyBuilderApi policy_builder_get_policy_names_from_rule_ids POST /api/v3/policies/policy_names Summary: GetPolicy names from rule IDs Description: Return a map where the key is the rule ID and value is the policy name that has the rule ID.
PolicyBuilderApi policy_builder_get_policy_sync_list GET /api/v3/policies/sync_list Summary: Get list of synced polices Description: Returns the list and status of sync entries
PolicyBuilderApi policy_builder_get_receivers GET /api/v3/policies/receivers Summary: Get receivers Description: Get all the receivers associated with actions.
PolicyBuilderApi policy_builder_get_rule_metadata GET /api/v3/rules/metadata Summary: Get rule metadata Description: Return a list of rule parameters and actions to the caller.
PolicyBuilderApi policy_builder_insert_gdp_policy POST /api/v3/policies/sync_entry Summary: Insert GDP policy sync entry Description: Inserts GDP policy's name into sync collection
PolicyBuilderApi policy_builder_insert_gdp_policy_meta_data POST /api/v3/central_managers/{central_manager_id}/policies/policy_metadata Summary: Insert GDP policy summaries Description: Inserts GDP's CM's policy summary information into mogodb. (This API is called from GDP only)
PolicyBuilderApi policy_builder_install_policies PUT /api/v3/policies/install Summary: Install policies Description: Activate Policies request performs activations.
PolicyBuilderApi policy_builder_integration_check GET /api/v3/policies/integration_check/{integration_id} Summary: Integration check Description: Check if integration id is being used in policies.
PolicyBuilderApi policy_builder_policies_groups GET /api/v3/policies/groups Summary: Policies groups Description: Get policy groups.
PolicyBuilderApi policy_builder_rule_validation POST /api/v3/rules/validate Summary: Rule validation Description: Validate a rule parameters and actions.
PolicyBuilderApi policy_builder_store_policies_gdp POST /api/v3/policies/{central_manager_id} Summary: Store policies Gdp Description: Store policies. (This API is called from GDP only)
QSDataLoaderApi q_s_data_loader_q_sfile_validator POST /api/v3/data/validation QSfileValidator - validate the files before insert happend .
QSDataLoaderApi q_s_data_loader_upload_synthetic_data_loader POST /api/v3/data/synthetic UploadSyntheticDataLoader - Insert data into Db after read from .sql file .
QSDataManagerApi q_s_data_manager_get_master_data GET /api/v3/datamanager/master-data Summary: master data for all entities Description: Retrieves All Dimension and Fact tables data.
QSDataManagerApi q_s_data_manager_get_plugin_data GET /api/v3/datamanager/plugin Summary: Plugins Details Description: Retrieves All plugins information.
QSDataManagerApi q_s_data_manager_register_scan POST /api/v3/datamanager/scan Summary: Insert ScanDetails Description: Register new data into scan dimension table.
QSDataManagerApi q_s_data_manager_retrieve_scan GET /api/v3/datamanager/scan/{scan_id}/data Summary: Fetch ScanDetails Description: Fetch details from scan dimension table.
QSPluginManagerApi q_s_plugin_manager_invoke_app_prov POST /api/v3/plugins/{plugin_id}/application Summary: Invoke only application provisioning data plugin Description:Parses app input file and triggers dataload
QSPluginManagerApi q_s_plugin_manager_invoke_explorer_v1 POST /api/v3/plugins/{plugin_id}/explorer Summary: Invoke only explorer inventory data plugin Description:Parses explorer input file and triggers dataload
QSPluginManagerApi q_s_plugin_manager_invoke_explorer_v2 POST /api/v3/plugins/{plugin_id}/explorer/analytics Summary: Invoke only explorer analytics data plugin Description:Parses explorer input file and triggers dataload
QSPluginManagerApi q_s_plugin_manager_invoke_plugin POST /api/v3/plugins/{plugin_id}/network Summary: Invoke consolidated or only network data plugin Description:Parses input files and triggers dataload
QSPluginManagerApi q_s_plugin_manager_invoke_policy POST /api/v3/plugins/{plugin_id}/policy Summary: Invoke only policy data plugin Description:Parses policy input file and triggers dataload
QSPolicyManagerApi q_s_policy_manager_batch_status_update PUT /api/v3/policy_manager/tickets/status BatchStatusUpdate - trigger the batch to update the status of the Ticket .
QSPolicyManagerApi q_s_policy_manager_config_update PATCH /api/v3/policy_manager/configs ConfigUpdate - this function update Crypto Risk Factor Weight in Db2 as well as Mongodb.
QSPolicyManagerApi q_s_policy_manager_create_ticket POST /api/v3/policy_manager/ticket CreateTicket - Create a new Incident .
QSPolicyManagerApi q_s_policy_manager_fetch_filesfrom_buckets GET /api/v3/policy_manager/os-files FetchFilesfromBuckets - fetch the file(s) from bucket of the object storage
QSPolicyManagerApi q_s_policy_manager_process_policy_dimention_records POST /api/v3/policy_manager/policy/process ProcessPolicyDimentionRecords - fetch the records from Policy Dimention and update Policy Fact table
QSPolicyManagerApi q_s_policy_manager_update_ticket_status PUT /api/v3/policy_manager/ticket/status UpdateTicketStatus - Update the ticket status based on the IntegrationId and TicketId .
ReportsRunnerApi reports_runner_get_active_queries POST /api/v3/queries/search Summary: Get running queries Description: Get queries that are running more than certain time
ReportsRunnerApi reports_runner_get_audit_data_count POST /api/v3/reports/{report_id}/audit_count Summary: Get audit data count Description: Get audit data.
ReportsRunnerApi reports_runner_get_chart_data POST /api/v3/charts/run Summary: Get chart data Description: Get Chart data by chart ID or by specifying report definition and chart settings.
ReportsRunnerApi reports_runner_get_chart_datav2 POST /api/v3/flex-charts/run
ReportsRunnerApi reports_runner_get_report_column_facet POST /api/v3/reports/facet Summary: Get report column facet Description: Get counts that is group by values for the selected column.
ReportsRunnerApi reports_runner_get_report_data_count POST /api/v3/reports/count Summary: Get report data count Description: Get report data.
ReportsRunnerApi reports_runner_run_audit_report POST /api/v3/audit/{report_id}/run Summary: Run audit report Description: Run task report by SQL based ob report ID and filter definition.
ReportsRunnerApi reports_runner_run_report POST /api/v3/reports/run Summary: Run report Description: Run report by report ID or by specifying report definition.
ReportsRunnerApi reports_runner_stop_query POST /api/v3/queries/stop Summary: Stop query Description: Stop a query based on the id
ReportsServiceApi reports_service_create_category POST /api/v3/reports/categories Summary: Create a category Description: Create a report category
ReportsServiceApi reports_service_create_chart POST /api/v3/charts Summary: Create chart Description: Create custom chart based on provided properties.
ReportsServiceApi reports_service_create_chart_templatev2 POST /api/v3/flex-charts/templates Summary: Create chart template v2 Description: Create custom VEGA chart template.
ReportsServiceApi reports_service_create_chartv2 POST /api/v3/flex-charts Summary: Create chart v2 Description: Create custom VEGA chart based on provided properties.
ReportsServiceApi reports_service_create_fields_by_category POST /api/v3/reports/fields Summary - Create fields by category Description: Cteate category fields based on provided properties.
ReportsServiceApi reports_service_create_join POST /api/v3/reports/categories/joins Summary: Create a join Description: Create a custom report join
ReportsServiceApi reports_service_create_report POST /api/v3/reports Summary: Create report Description: Create custom report based on provided properties.
ReportsServiceApi reports_service_create_variant POST /api/v3/reports/variants Summary: Create a variant Description: Create a variant for reports
ReportsServiceApi reports_service_delete_category DELETE /api/v3/reports/categories Summary: Delete a category Description: Delete a report category
ReportsServiceApi reports_service_delete_chart DELETE /api/v3/charts/{chart_id} Summary: Delete chart Description: Delete a custom chart.
ReportsServiceApi reports_service_delete_chart_templatev2 DELETE /api/v3/flex-charts/templates/{template_id} Summary: Delete chart template v2 Description: Delete a custom VEGA chart template.
ReportsServiceApi reports_service_delete_chartv2 DELETE /api/v3/flex-charts/{chart_id} Summary: Delete chart v2 Description: Delete a custom VEGA chart.
ReportsServiceApi reports_service_delete_fields_by_category DELETE /api/v3/reports/fields Summary - Delete fields by category Description: Delete category fields based on provided properties.
ReportsServiceApi reports_service_delete_join DELETE /api/v3/reports/categories/joins/{join_id} Summary: Delete a join Description: Delete a custom join
ReportsServiceApi reports_service_delete_report DELETE /api/v3/reports/{report_id} Summary: Delete report Description: Delete a custom report.
ReportsServiceApi reports_service_delete_variant DELETE /api/v3/reports/variants/{variant_id} Summary: Delete a variant Description: Delete a variant
ReportsServiceApi reports_service_get_categories GET /api/v3/reports/categories Summary: Get all available report categories. Description: Get all category related fields or all possible fields.
ReportsServiceApi reports_service_get_chart_settings GET /api/v3/charts Summary: Get chart settings Description: Get a custom chart based on provided report id.
ReportsServiceApi reports_service_get_chart_settingsv2 GET /api/v3/flex-charts Summary: Get chart settings v2 Description: Get a custom VEGA chart based on provided report id.
ReportsServiceApi reports_service_get_chart_templatesv2 GET /api/v3/flex-charts/templates Summary: Get chart template v2 Description: Get all custom VEGA chart templates.
ReportsServiceApi reports_service_get_fields_by_categories GET /api/v3/reports/fields/categories Summary: Get fields by categories Description: Get all category related fields or all possible fields based on a list of categories.
ReportsServiceApi reports_service_get_fields_by_category GET /api/v3/reports/fields Summary: Get fields by category Description: Get all category related fields or all possible fields.
ReportsServiceApi reports_service_get_joins GET /api/v3/reports/categories/joins Summary: Get all joins Description: Get all custom joins.
ReportsServiceApi reports_service_get_query_by_report_definition POST /api/v3/reports/query/definition Summary: Get query by report definition Description: Get query by report definition.
ReportsServiceApi reports_service_get_query_by_report_id POST /api/v3/reports/query/id Summary: Get query by report ID Description: Get query by report ID.
ReportsServiceApi reports_service_get_report_definition GET /api/v3/reports/{report_id}/definition Summary: Get report definition Description: Get report definition.
ReportsServiceApi reports_service_get_report_groups GET /api/v3/reports_groups Summary: Get report groups Description: Get reports used by the provided groups.
ReportsServiceApi reports_service_get_report_synopsis GET /api/v3/reports/{report_id}/synopsis Summary: Get report synopsis Description: Return BriefReport.
ReportsServiceApi reports_service_get_report_timestamp_header GET /api/v3/reports/headers/timestamp/default Summary: Get report timestamp header Description: Get where to take a report timestamp given an entity.
ReportsServiceApi reports_service_get_reports GET /api/v3/reports Summary: Get reports Description: Get reports list.
ReportsServiceApi reports_service_get_reports_for_join GET /api/v3/reports/categories/joins/{join_id}/reports Summary: Get the reports that use a join Description: Get the reports that use a join and the headers that are imported by the reports using the join
ReportsServiceApi reports_service_get_reports_tags GET /api/v3/reports/tags Summary: Get reports tags Description: Get all report distinct tags.
ReportsServiceApi reports_service_get_variant GET /api/v3/reports/variants/{variant_id} Summary: Get a variant Description: Get a given variant
ReportsServiceApi reports_service_get_variants GET /api/v3/reports/variants Summary: Get all variants Description: Get all variants in reports
ReportsServiceApi reports_service_partial_chart_update PATCH /api/v3/charts/{chart_id} Summary: Partial chart update Description: Update a custom chart with partial information.
ReportsServiceApi reports_service_partial_report_update PATCH /api/v3/reports/{report_id} Summary: Partial report update Description: Update a custom report with partial information.
ReportsServiceApi reports_service_run_variant_operation POST /api/v3/reports/variants/run Summary: Run a variant Description: Run the operations in a variant
ReportsServiceApi reports_service_transpose POST /api/v3/reports/transpose Summary: Transpose Description: Return the corresponding full sql data.
ReportsServiceApi reports_service_update_chart PUT /api/v3/charts/{chart_id} Summary: Update chart Description: Update a custom chart.
ReportsServiceApi reports_service_update_chartv2 PUT /api/v3/flex-charts/{chart_id} Summary: Update chart v2 Description: Update a custom VEGA chart.
ReportsServiceApi reports_service_update_join PUT /api/v3/reports/categories/joins/{join_id} Summary: Update a join Description: Update a custom join
ReportsServiceApi reports_service_update_report PUT /api/v3/reports/{report_id} Summary: Update report Description: Update a custom report.
ReportsServiceApi reports_service_update_variant_override PUT /api/v3/reports/variants/{variant_id} Summary: Update a variant Description: Update a variant with a custom override
ResourceControllerK8ServiceApi resource_controller_k8_service_create_controller POST /api/v3/edge_manager/controllers CreateController - Add a new controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_create_heart_beat POST /api/v3/edge_manager/controllers/{controller_id}/heartbeat CreateHeartBeat - Create a heartbeat for the controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_create_heart_beat_ex POST /api/v3/edge_manager/controllers/{controller_id}/heartbeat_ex CreateHeartBeatEx - Create a heartbeat for the controller with extended information.
ResourceControllerK8ServiceApi resource_controller_k8_service_create_job POST /api/v3/edge_manager/jobs //////////////////////////////////////////////////////////////// Interface to the controllers and apps api in the App-Manager microservice CreateJob - Create a job definition. Files and secrets contained within will also be created.
ResourceControllerK8ServiceApi resource_controller_k8_service_create_job_execution POST /api/v3/edge_manager/job_executions CreateJobExecution - Create a job execution.
ResourceControllerK8ServiceApi resource_controller_k8_service_create_keypair POST /api/v3/edge_manager/controllers/{controller_id}/keypair CreateKeypair - Create a new keypair for the controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_delete_controller DELETE /api/v3/edge_manager/controllers/{controller_id} DeleteController - Delete a controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_delete_edge_tenant DELETE /api/v3/edge_manager/tenants/{tenant_id} DeleteEdgeTenant - deletes an edge tenant providing edge tenant id
ResourceControllerK8ServiceApi resource_controller_k8_service_delete_edge_tenant_request DELETE /api/v3/edges DeleteEdgeTenantRequest to deletes gi and tnt CR on edge
ResourceControllerK8ServiceApi resource_controller_k8_service_delete_job DELETE /api/v3/edge_manager/jobs/{job_id} DeleteJob - Delete a job.
ResourceControllerK8ServiceApi resource_controller_k8_service_download_controller_logs POST /api/v3/edge_manager/controllers/{controller_id}/logs DownloadControllerLogs - Download the controller logs for a running controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controller_apps GET /api/v3/edge_manager/controllers/{controller_id}/apps GetControllerApps - Get the apps for the given controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controller_commands GET /api/v3/edge_manager/controllers/{controller_id}/commands GetControllerCommands - Get the commands for the controller to execute.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controller_jobs GET /api/v3/edge_manager/controllers/{controller_id}/jobs GetControllerJobs - Get the jobs for the controller to execute.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controller_status GET /api/v3/edge_manager/controllers/{controller_id}/status GetControllerStatus - Get the status for the given controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controllers GET /api/v3/edge_manager/tenants/{tenant_id}/controllers GetControllers - Get the controllers for the given tenant.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_controllers_with_status GET /api/v3/edge_manager/tenants/{tenant_id}/controller_status GetControllersWithStatus - Get the controllers for the given tenant with computed status.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_job GET /api/v3/edge_manager/jobs/{job_id} GetJob - Get the job.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_job_execution GET /api/v3/edge_manager/job_executions/{jobexe_id} GetJobExecution - Get a job execution.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_job_executions GET /api/v3/edge_manager/jobs/{job_id}/executions GetJobExecutions - Get the job executions.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_job_status GET /api/v3/edge_manager/jobs/{job_id}/status GetJobStatus - Get the job's status.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_tenant_app GET /api/v3/edge_manager/tenants/{tenant_id}/apps/{app_name} GetTenantApp - Get a specific app for the given tenant.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_tenant_apps GET /api/v3/edge_manager/tenants/{tenant_id}/apps GetTenantApps - Get the apps for the given tenant.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_tenant_jobs GET /api/v3/edge_manager/tenants/{tenant_id}/jobs GetTenantJobs - Get jobs for the given tenant.
ResourceControllerK8ServiceApi resource_controller_k8_service_get_version GET /api/v3/edge_manager/system/version GetVersion - Get the system version information for the service.
ResourceControllerK8ServiceApi resource_controller_k8_service_install_edge_tenant_request POST /api/v3/edges InstallEdgeTenantRequest to Create gi and tnt CRs on edge
ResourceControllerK8ServiceApi resource_controller_k8_service_query_controller_logs POST /api/v3/edge_manager/controllers/{controller_id}/logs/query QueryControllerLogs - Query for the controller logs for a running controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_command PUT /api/v3/edge_manager/commands/{id} UpdateCommand - Update the command.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_controller PUT /api/v3/edge_manager/controllers/{id} UpdateController - Update an existing controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_controller_status PUT /api/v3/edge_manager/controllers/{id}/status UpdateControllerStatus - Updates the status for the given controller.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_edge_tenant_request PATCH /api/v3/edges/{edge_id} UpdateEdgeTenantRequest to update gi and tnt CRs on edge
ResourceControllerK8ServiceApi resource_controller_k8_service_update_job PUT /api/v3/edge_manager/jobs/{id} UpdateJob - Update a job.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_job_execution PUT /api/v3/edge_manager/job_executions/{id} UpdateJobExecution - Update a job execution.
ResourceControllerK8ServiceApi resource_controller_k8_service_update_job_status PUT /api/v3/edge_manager/jobs/{job_id}/status UpdateJobStatus - Updates the status for the given Job.
RiskAnalyticsControllerApi risk_analytics_controller_enable_disable_risk_event_feedback PUT /api/v3/risk_feedback/status Summary: Enable disable risk rvent feedback Description: Enable or disable the collect feedback process.
RiskAnalyticsControllerApi risk_analytics_controller_enable_disable_risk_event_process PUT /api/v3/risk_process/status Summary: Enable disable risk event process Description: Enable or disable the risk event process.
RiskAnalyticsControllerApi risk_analytics_controller_get_all_classifications_list GET /api/v3/risk_events/classifications Summary: Get all classifications Description: Get all possible classifications for a risk event.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_classifications_list GET /api/v3/risk_events/{risk_id}/feedback Summary: Get risk event classifications list Description: retrieves the ClassificationMatchDetails for a given risk id; classification that did not matched will be with class_value 0.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_data_for_summarization GET /api/v3/risk_events/{risk_id}/summarization/data Summary: Get risk event data needed for summarization task Description: Retrieve the full information about this risk event including all findings data
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_details GET /api/v3/risk_events/{risk_id}/details Summary: Get risk event details Description: Return the details of a risk event, including risk general info and a list of observations.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_process_status GET /api/v3/risk_process/status Summary: Get risk event process status Description: Get the risk event process status.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_row GET /api/v3/risk_events Summary: Get risk event row Description: Return a list of risk events.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_event_vulnerability_assessment_details PUT /api/v3/risk_events/{risk_id}/va Summary: Get vulnerability assessment details for a given risk event Description: Retrieve the information about failed VA tests for assets database and db user
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_feedback GET /api/v3/risk_events/feedback Summary: Get risk feedback Description: Get all feedbacks that are in status NEW/WIP and change them to status WIP.
RiskAnalyticsControllerApi risk_analytics_controller_get_risk_observation_details GET /api/v3/risk_events/observations Summary: Get risk observation details Description: Return details of a single risk observation.
RiskAnalyticsControllerApi risk_analytics_controller_get_user_ui_settings GET /api/v3/risk_events/user_ui_settings Summary: Get user UI settings Description: Get the user settings by user id to display the risk in the UI.
RiskAnalyticsControllerApi risk_analytics_controller_risk_event_tuning PUT /api/v3/risk_events/tuning Summary: Risk event tuning Description: Perform tuning risk event actions.
RiskAnalyticsControllerApi risk_analytics_controller_set_risk_event_status PUT /api/v3/risk_events/status Summary: Set risk event status Description: Update the risk status and justification.
RiskAnalyticsControllerApi risk_analytics_controller_set_user_ui_settings PUT /api/v3/risk_events/user_ui_settings Summary: Set user UI settings Description: Set the user settings by user id in the mongo collection. WARNING: this API should not be used manually or by a system external to GDSC. Using this API to change a user settings may prevent the user from using the Risk Event function within GDSC.
RiskAnalyticsControllerApi risk_analytics_controller_update_risk_feedback PUT /api/v3/risk_events/feedback Summary: Update risk feedback Description: Provide feedback for one or more risk events
RiskAnalyticsDataProcessorApi risk_analytics_data_processor_get_risk_context GET /api/v3/risk_events/{risk_id}/context Summary: Get Risk Event Context Description: Retrieve the context of the given risk ID. This context will be used for LLM interactions.
RiskAnalyticsDataProcessorApi risk_analytics_data_processor_get_risk_predefined_questions GET /api/v3/risk_events/{risk_id}/questions Summary: Get Risk Event Predefined Questions Description: Retrieve the Predefined Questions of the given risk ID. This Predefined Questions will be used quick actions recommendations.
RiskAnalyticsEngineApi risk_analytics_engine_get_lead_generator_config GET /api/v3/risk/lead_generator Summary: Get lead generator config Description: Retrieve the configuration of a lead generator.
RiskAnalyticsEngineApi risk_analytics_engine_update_lead_generator_config PUT /api/v3/risk/lead_generator Summary: Update lead generator config Description: Update the configuration of a leads generator.
RiskAnalyticsMlClassificationApi risk_analytics_ml_classification_reset_model_to_defaults POST /api/v3/classification/ml/models/reset Summary: Reset the model to its default weights. Description: Load the initial model instead of the existing model - this action is irreversible.
SchedulerServiceApi scheduler_service_create_scheduled_job POST /api/v3/schedules Summary: Create scheduled job Description: Create a new scheduled job with tasks.
SchedulerServiceApi scheduler_service_delete_scheduled_job DELETE /api/v3/schedules/{schedule_id} Summary: Delete scheduled job Description: Delete a single scheduled job.
SchedulerServiceApi scheduler_service_get_dependencies GET /api/v3/schedules/dependencies Summary: Get dependencies Description: returns IDs of distribution rules, response templates, or processing rules that are in use
SchedulerServiceApi scheduler_service_get_distribution_rules GET /api/v3/schedules/distribution_rules Summary: Get distribution rules Description: Return a list of distribution rule IDs that are used by the scheduler Distribution rules can't be edited if it is used by a scheduled job.
SchedulerServiceApi scheduler_service_get_scheduled_job_details GET /api/v3/schedules/{schedule_id}/details Summary: Get scheduled job Description: Return a single ScheduledJob in detail.
SchedulerServiceApi scheduler_service_get_scheduled_jobs GET /api/v3/schedules Summary: Get scheduled jobs Description: Return a list of scheduled jobs and the linked tasks.
SchedulerServiceApi scheduler_service_get_schedules_by_report POST /api/v3/schedules/searchByReport/{report_id} Summary: Get schedules by report Description: Return an array of scheduled job IDs that run the report_id. An empty array is returned if the report_id is not scheduled.
SchedulerServiceApi scheduler_service_get_tags GET /api/v3/schedules/tags Summary: Get tags Description: Return an array of all the unique tags from scheduled jobs.
SchedulerServiceApi scheduler_service_search_scheduled_jobs POST /api/v3/schedules/search Summary: Search scheduled jobs Description: Return a filtered list of scheduled jobs and the linked tasks.
SchedulerServiceApi scheduler_service_search_scheduled_task_runs POST /api/v3/schedules/runs/search Summary: Search scheduled task runs Description: Return a list of scheduled task run, start date, end date, status
SchedulerServiceApi scheduler_service_update_scheduled_job PATCH /api/v3/schedules/{schedule_id} Summary: Update scheduled job Description: Update a single schedule job.
SnifAssistServiceApi snif_assist_service_get_snif_config GET /api/v3/snif/config Summary: Get sniffer configuration parameters Description: Get edge sniffer configuration parameters from GI-mothership.
SnifAssistServiceApi snif_assist_service_get_snif_policy GET /api/v3/snif/policy Summary: Get sniffer policy Description: Get edge sniffer policy from GI-mothership.
SnifAssistServiceApi snif_assist_service_post_snif_feedback POST /api/v3/snif/feedback Summary: Post sniffer feedback Description: Post policy installation feedback to policy-builder service.
SnifAssistServiceApi snif_assist_service_test_regex POST /api/v3/snif/test_regex Summary: Test regex Description: Match a text string with a regular expression using the same sniffer code used in production to match a regex.
StreamsServiceApi streams_service_check_aws_credentials POST /api/v3/streams/credentials Summary: Check AWS credentials Description: Service to verify AWS credentials.
StreamsServiceApi streams_service_check_azure_event_hub POST /api/v3/streams/azure_eventhub Summary: Check Azure event hub Description: Service to check Azure event hub.
StreamsServiceApi streams_service_check_azure_storage_string POST /api/v3/streams/azure_storage Summary: Check Azure storage string Description: Service to verify Azure storage connection.
StreamsServiceApi streams_service_get_aws_regions GET /api/v3/streams/regions Summary: Get AWS regions Description: Service to get AWS regions.
StreamsServiceApi streams_service_list_aws_streams POST /api/v3/streams Summary: List AWS streams Description: Service to list AWS Kinesis streams.
TemplatesServiceApi templates_service_create_integration POST /api/v3/templates/integration Summary: Create integration Description: Create a set of new templates for a new integration.
TemplatesServiceApi templates_service_create_template POST /api/v3/templates Summary: Create template Description: Create a new template.
TemplatesServiceApi templates_service_delete_integration DELETE /api/v3/templates/integrations/{integration_id} Summary: Delete integration Description: Delete all templates associated with an integration.
TemplatesServiceApi templates_service_delete_template DELETE /api/v3/templates/{template_id} Summary: Delete template Description: Delete a specific template.
TemplatesServiceApi templates_service_get_origin_default_content GET /api/v3/templates/origins/{origin}/content Summary: Get origin default content Description: Return the default content for a template with a specified origin and MIME type.
TemplatesServiceApi templates_service_get_origin_fields GET /api/v3/templates/origins/{origin}/fields Summary: Get origin fields Description: Return the fields available with a specific origin.
TemplatesServiceApi templates_service_get_template GET /api/v3/templates/{template_id} Summary: Get template Description: Return a specific template by id.
TemplatesServiceApi templates_service_get_templates GET /api/v3/templates Summary: Get templates Description: Return all templates based on supplied filters.
TemplatesServiceApi templates_service_get_templates_for_edge GET /api/v3/templates/edge Summary: Get templates for edge Description: Return all templates based on supplied filters.
TemplatesServiceApi templates_service_test_template POST /api/v3/templates/test Summary: Test template Description: Analyze a specified template to ensure will function correctly when utilized.
TemplatesServiceApi templates_service_transform_template POST /api/v3/templates/transform Summary: Transform template Description: Process the specified template and returns the Title and Content based on supplied data.
TemplatesServiceApi templates_service_transform_template_json POST /api/v3/templates/transformjson Summary: Transform template JSON Description: Process the specified template and returns the Title and Content based on supplied json data string.
TemplatesServiceApi templates_service_update_template PATCH /api/v3/templates/{template_id} Summary: Update template Description: Update a single template.
TenantuserApi tenantuser_create_api_key POST /api/v3/apikeys Summary: Create API key Description: Create API Key.
TenantuserApi tenantuser_delete_api_key DELETE /api/v3/apikeys/{id} Summary: Delete API key Description: Delete APIKey Document based on the document id.
TenantuserApi tenantuser_delete_role DELETE /api/v3/roles/{role_id} Summary: Delete role Description: Delete a role.
TenantuserApi tenantuser_get_api_keys GET /api/v3/apikeys Summary: Get API keys Description: Get all APIKeys base on a tenant ID.
TenantuserApi tenantuser_get_current_user GET /api/v3/currentuser Summary: Get current user Description: Return the currently authenticated user.
TenantuserApi tenantuser_get_privilege GET /api/v3/privileges/{privilege.privilege_id} Summary: Get privilege Description: Return privilege.
TenantuserApi tenantuser_get_privileges GET /api/v3/privileges Summary: Get privileges Description: Return all available privileges (pages, restapi, reports, etc) if no roles are specified If roles are specified, returns cumulative privileges for the list of roles.
TenantuserApi tenantuser_get_role GET /api/v3/roles/{role_id} Summary: Get role Description: Return single role.
TenantuserApi tenantuser_get_roles GET /api/v3/roles Summary: Get roles Description: Return all roles without privileges.
TenantuserApi tenantuser_get_user GET /api/v3/users/user/{user_id} Summary: Get user Description: Return full user for specified user_id.
TenantuserApi tenantuser_get_user_names POST /api/v3/users/names Summary: Get user names Description: Get user names.
TenantuserApi tenantuser_get_user_tenant GET /api/v3/users/tenant/{user_id} Summary: Get user tenant Description: Return the user plus tenant information.
TenantuserApi tenantuser_post_privileges_bulk POST /api/v3/privileges Summary: Post privileges bulk Description: Perform bulk user add preivilege.
TenantuserApi tenantuser_post_role POST /api/v3/roles Summary: Post role Description: Create a new role.
TenantuserApi tenantuser_update_privilege PATCH /api/v3/privileges/{privilege_id} Summary: Update privilege Description: Update privilege.
TenantuserApi tenantuser_update_privileges_role_bulk PATCH /api/v3/privileges Summary: Update privileges role bulk Description: Perform bulk user update role.
TenantuserApi tenantuser_update_role PATCH /api/v3/roles/{role_id} Summary: Update role Description: Update single role.
TenantuserApi tenantuser_update_user_role_bulk PATCH /api/v3/users/role Summary: Update user role bulk Description: Perform bulk user add or remove role.
ThirdPartyVendorsApi get_linked_vendor GET /api/v1/dspm/linkedVendors/{vendorId}/cloudAccounts Get additional details of a specific third party vendor
ThirdPartyVendorsApi get_single_linked_vendor GET /api/v1/dspm/linkedVendors/{vendorId} Get the third party vendors list
ThirdPartyVendorsApi list_linked_vendor_data_stores GET /api/v1/dspm/linkedVendors/{vendorId}/dataStores Get the data stores associated with a third party vendor
ThirdPartyVendorsApi list_linked_vendors GET /api/v1/dspm/linkedVendors Get the summary of a third party vendor
ThirdPartyVendorsApi list_trusted_assets GET /api/v1/dspm/linkedVendors/trustedAssets Get a list of all the actual trusted assets
UniversalConnectorManagerApi universal_connector_manager_get_certificate GET /api/v3/certificates Summary: Get certificate Description: Get the certificate that allows secure communication between data sources and universal connections in GDSC.
UniversalConnectorManagerApi universal_connector_manager_get_connectors GET /api/v3/connectors Summary: Get connectors Description: Get all the connectors Universal Connector can support. Includes a list of event pipelines (input--filter pairs), along with the supported data source types and platforms.
UniversalConnectorManagerApi universal_connector_manager_get_uc_setup GET /api/v3/universal_connections/configurations/{plugin_id} Gets information to setup the new Universal connection.
UniversalConnectorManagerApi universal_connector_manager_list_connections_summary GET /api/v3/universal_connections Summary: List connections summary Description: List a summary of Universal Connector configured connections (AKA datasources).
UniversalConnectorManagerApi universal_connector_manager_plugins_list GET /api/v3/plugins Summary: Plugins list Description: List of all universal connector plugins.
UniversalConnectorManagerApi universal_connector_manager_upload_plugin POST /api/v3/plugins Summary: Upload plugin Description: Upload a plugin-package for Universal Connector.
WorkflowApi workflow_create_case POST /api/v3/cases Summary: Create case Description: Create single case.
WorkflowApi workflow_create_product_entity POST /api/v3/workflow/productentities Summary: Create product entity Description: Create single product entity.
WorkflowApi workflow_create_task POST /api/v3/cases/{case_id}/tasks Summary: Create task Description: Create single task within a parent case.
WorkflowApi workflow_create_workflow_event POST /api/v3/workflow/event Summary: Post event for processing by workflow rules Description: Find matching workflow rule and run it
WorkflowApi workflow_delete_product_entity DELETE /api/v3/workflow/productentities/{entity_id} Summary: Delete a product entity Description: Delete a single product entity.
WorkflowApi workflow_get_cases GET /api/v3/cases Summary: Get cases Description: Return all cases requested.
WorkflowApi workflow_get_cases_count POST /api/v3/cases/count Summary: Get cases count Description: Get case count.
WorkflowApi workflow_get_filename GET /api/v3/cases/{case_id}/tasks/{task_id}/filename Summary: Get filename Description: Return filename associated with the task referenced in the associated context record.
WorkflowApi workflow_get_jobs_count POST /api/v3/cases/{case_id}/jobs/count Summary: Get jobs count Description: Get jobs count.
WorkflowApi workflow_get_product_entities GET /api/v3/workflow/productentities Summary: Get products and their associated event entities Description: Return a list of integrated products and their associated event entities
WorkflowApi workflow_get_product_entity GET /api/v3/workflow/productentities/{entity_id} Summary: Get event entity field names, field labels, and field data types Description: Return a list of fields similar to report headers
WorkflowApi workflow_get_report_result GET /api/v3/cases/{case_id}/tasks/{task_id}/result Summary: Get report result Description: Return a page of results.
WorkflowApi workflow_get_tasks GET /api/v3/cases/{case_id}/tasks Summary: Get tasks Description: Return all tasks requested.
WorkflowApi workflow_get_tasks_count POST /api/v3/cases/{case_id}/tasks/count Summary: Get cases count Description: Get case count.
WorkflowApi workflow_search_cases POST /api/v3/cases/search Summary: Search cases Description: Return a subset of cases.
WorkflowApi workflow_search_reports POST /api/v3/cases/reports Summary: Get a list of report IDs Description: Returns a list of report IDs referenced in all cases and tasks
WorkflowApi workflow_search_tasks POST /api/v3/cases/{case_id}/tasks/search Summary: Search cases Description: Return a subset of cases.
WorkflowApi workflow_update_cases PUT /api/v3/cases Summary: Update cases Description: Update multiple cases in one request.
WorkflowApi workflow_update_product_entity PUT /api/v3/workflow/productentities/{entity_id} Summary: Update a product entity Description: Update a single product entity.
WorkflowApi workflow_update_tasks PUT /api/v3/cases/{case_id}/tasks Summary: Update tasks Description: Update multiple tasks for the same parent in one request.
EdgeSchedulerServiceApi edge_scheduler_service_get_edge_query_status GET /api/v3/edges/{edge_id}/query/status Summary: Get edge query status Description: Get the status of a queued edge query
EdgeSchedulerServiceApi edge_scheduler_service_monitoring_pending_request_for_edge_query GET /api/v3/edges/query Summary: Monitor for a pending edge query request Description: monitor edge query pending request
EdgeSchedulerServiceApi edge_scheduler_service_schedule_edge_query POST /api/v3/edges/{edge_id}/query/schedule Summary: Schedule an edge query Description: Schedule an edge query via data warehouse queue

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

BasicAuth

  • Type: HTTP basic authentication

Author