Skip to content

Latest commit

 

History

History
540 lines (327 loc) · 15.6 KB

DataMovementsApi.md

File metadata and controls

540 lines (327 loc) · 15.6 KB

.DataMovementsApi

All URIs are relative to http://localhost

Method HTTP request Description
getActualFlow GET /api/v2/dspm/dataMovements/actualFlows/{id} Get actual flow by providing its ID
getActualFlowsSummary GET /api/v2/dspm/dataMovements/actualFlows/summary Get summary of actual flows
getPotentialFlow GET /api/v2/dspm/dataMovements/potentialFlows/{flowId} Get potential flow by providing its ID
getPotentialFlowPath GET /api/v2/dspm/dataMovements/potentialFlows/paths/{flowPathId} Get potential flow path by providing its ID
getPotentialFlowsSummary GET /api/v2/dspm/dataMovements/potentialFlows/summary Get summary of potential flows according to the filter applied
listActualFlowPaths GET /api/v2/dspm/dataMovements/actualFlowPaths Get summary of actual flows according to the filter applied
listActualFlows GET /api/v2/dspm/dataMovements/actualFlows List actual flows
listPotentialFlows GET /api/v2/dspm/dataMovements/potentialFlows List potential flows
listPotentialFlowsPaths GET /api/v2/dspm/dataMovements/potentialFlows/paths List potential flow paths

getActualFlow

ActualFlow getActualFlow()

Get a detailed information about an actual flow by providing its ID.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiGetActualFlowRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiGetActualFlowRequest = {
  
  id: "id_example",
};

const data = await apiInstance.getActualFlow(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
id [string] defaults to undefined

Return type

ActualFlow

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getActualFlowsSummary

ActualFlowsSummary getActualFlowsSummary()

Get a summary of all the actual flows discovered by Guardium DSPM, that is, details about source and destination, and other information.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiGetActualFlowsSummaryRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiGetActualFlowsSummaryRequest = {
  
  filter: null,
};

const data = await apiInstance.getActualFlowsSummary(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
filter ListActualFlowsFilterParameter (optional) defaults to undefined

Return type

ActualFlowsSummary

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPotentialFlow

PotentialFlow getPotentialFlow()

Get a detailed information about a potential flow by providing the flow ID.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiGetPotentialFlowRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiGetPotentialFlowRequest = {
  
  flowId: "ff2b4abe-89f4-62b8-061e-1232456789",
};

const data = await apiInstance.getPotentialFlow(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
flowId [string] defaults to undefined

Return type

PotentialFlow

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
404 potential flow not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPotentialFlowPath

PotentialFlowPath getPotentialFlowPath()

Get details of a specific potential flow of data by providing its ID.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiGetPotentialFlowPathRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiGetPotentialFlowPathRequest = {
  
  flowPathId: "ff2b4abe-89f4-62b8-061e-12345678910",
};

const data = await apiInstance.getPotentialFlowPath(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
flowPathId [string] defaults to undefined

Return type

PotentialFlowPath

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
404 potential flow path not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPotentialFlowsSummary

PotentialFlowsSummary getPotentialFlowsSummary()

Get a summary of all the potential flows based on a filter applied.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiGetPotentialFlowsSummaryRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiGetPotentialFlowsSummaryRequest = {
  
  filter: null,
};

const data = await apiInstance.getPotentialFlowsSummary(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
filter PotentialFlowsFilterOptions (optional) defaults to undefined

Return type

PotentialFlowsSummary

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listActualFlowPaths

ListActualFlowPaths200Response listActualFlowPaths()

Get detailed information about the actual flows according to the filter applied.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiListActualFlowPathsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiListActualFlowPathsRequest = {
  
  sort: {
    sortBy: "lastSeen",
    sortOrder: 1,
  },
  
  filter: null,
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

const data = await apiInstance.listActualFlowPaths(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
sort ListActualFlowPathsSortParameter (optional) defaults to undefined
filter ListActualFlowPathsFilterParameter (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListActualFlowPaths200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listActualFlows

ListActualFlows200Response listActualFlows()

List all the actual flows (based on logs) of users and services across your entire cloud accounts and SasS applications.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiListActualFlowsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiListActualFlowsRequest = {
  
  sort: {
    sortBy: "lastSeen",
    sortOrder: 1,
  },
  
  filter: null,
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

const data = await apiInstance.listActualFlows(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
sort ListActualFlowsSortParameter (optional) defaults to undefined
filter ListActualFlowsFilterParameter (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListActualFlows200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listPotentialFlows

ListPotentialFlows200Response listPotentialFlows()

List all the potential flows of users and services across your entire cloud accounts and SaaS applications.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiListPotentialFlowsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiListPotentialFlowsRequest = {
  
  filter: null,
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

const data = await apiInstance.listPotentialFlows(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
filter PotentialFlowsFilterOptions (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListPotentialFlows200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listPotentialFlowsPaths

ListPotentialFlowsPaths200Response listPotentialFlowsPaths()

List all the potential flow paths based on an applied filter.

Example

import { createConfiguration, DataMovementsApi } from '';
import type { DataMovementsApiListPotentialFlowsPathsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new DataMovementsApi(configuration);

const request: DataMovementsApiListPotentialFlowsPathsRequest = {
  
  filter: null,
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

const data = await apiInstance.listPotentialFlowsPaths(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
filter PotentialFlowsPathsFilterOptions (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListPotentialFlowsPaths200Response

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 success -
400 Bad Request * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]