Skip to content

Latest commit

 

History

History
387 lines (248 loc) · 11.7 KB

DataResourcesApi.md

File metadata and controls

387 lines (248 loc) · 11.7 KB

.DataResourcesApi

All URIs are relative to http://localhost

Method HTTP request Description
getDataResource GET /api/v2/dspm/dataResources/{dataResourceId} Get a specific data resource by its ID
getDataResourcesSummary GET /api/v2/dspm/dataResources/summary Data resources summary
listDataResources GET /api/v2/dspm/dataResources List data resources that match a given filter
listDataResourcesNames GET /api/v2/dspm/dataResources/names List names of data resources
removeResource DELETE /api/v2/dspm/dataResources/{dataResourceId}/removeResource Remove resource from DSPM
updateResourceReviewStatus PUT /api/v2/dspm/dataResources/{dataResourceId}/reviewed Set review status of a data resource

getDataResource

DataResource getDataResource()

Get additional details on a specific data resource by providing its ID.

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiGetDataResourceRequest } from '';

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

const request: DataResourcesApiGetDataResourceRequest = {
    // Data resource ID
  dataResourceId: "arn:aws:s3::12345678910:polar-security-corplex.xlsx",
};

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

Parameters

Name Type Description Notes
dataResourceId [string] Data resource ID defaults to undefined

Return type

DataResource

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]

getDataResourcesSummary

DataResourcesSummary getDataResourcesSummary()

Get a summary of all the data resource, that is, number of data resources, types of data resources, and other information.

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiGetDataResourcesSummaryRequest } from '';

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

const request: DataResourcesApiGetDataResourcesSummaryRequest = {
    // Data store id (optional)
  dataStoreId: "arn:aws:s3::123456789101:mys3-prod",
  
  filter: {
    isReviewed: true,
    resourceOwners: ["Avi"],
    resourceNames: ["myFile.txt","myExcel.xlsx"],
    resourceTypes: ["File","Table"],
    sensitivityTags: ["BUSINESS_EMAIL_ADDRESS","CREDIT_CARD"],
    sensitivityCategories: [
      "SECRETS",
    ],
    resourcePartialName: "resourcePartialName_example",
  },
};

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

Parameters

Name Type Description Notes
dataStoreId [string] Data store id (optional) defaults to undefined
filter ListDataResourcesFilterParameter (optional) defaults to undefined

Return type

DataResourcesSummary

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]

listDataResources

ListDataResources200Response listDataResources()

Get a list of data resources based on the filter applied. You can filter by data store ID, data resource ID, data resource name, and more.
Note: Filter needs to be HTML encoded.

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiListDataResourcesRequest } from '';

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

const request: DataResourcesApiListDataResourcesRequest = {
  
  dataStoreId: "arn:aws:s3::123456789101:mys3-prod",
  
  filter: {
    isReviewed: true,
    resourceOwners: ["Avi"],
    resourceNames: ["myFile.txt","myExcel.xlsx"],
    resourceTypes: ["File","Table"],
    sensitivityTags: ["BUSINESS_EMAIL_ADDRESS","CREDIT_CARD"],
    sensitivityCategories: [
      "SECRETS",
    ],
    resourcePartialName: "resourcePartialName_example",
  },
  
  sort: {
    sortBy: "creationTime",
    sortOrder: 1,
  },
  
  pageSize: 3.14,
  
  nextToken: "nextToken_example",
};

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

Parameters

Name Type Description Notes
dataStoreId [string] (optional) defaults to undefined
filter ListDataResourcesFilterParameter (optional) defaults to undefined
sort ListDataResourcesSortParameter (optional) defaults to undefined
pageSize [number] (optional) defaults to undefined
nextToken [string] (optional) defaults to undefined

Return type

ListDataResources200Response

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]

listDataResourcesNames

Array listDataResourcesNames()

List and filter data resources by their names

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiListDataResourcesNamesRequest } from '';

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

const request: DataResourcesApiListDataResourcesNamesRequest = {
    // Prefix of data resource name
  prefix: "check",
  
  dataStoreId: "arn:aws:s3::123456789101:mys3-prod",
};

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

Parameters

Name Type Description Notes
prefix [string] Prefix of data resource name defaults to undefined
dataStoreId [string] (optional) defaults to undefined

Return type

Array

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]

removeResource

RemoveResource200Response removeResource()

Removes a resource, with all its sensitivities, from Guardium DSPM dashboard. This action does not remove the resource from the resource's source environment.

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiRemoveResourceRequest } from '';

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

const request: DataResourcesApiRemoveResourceRequest = {
    // Data resource ID
  dataResourceId: "arn:aws:s3::12345678910:polar-security-corplex.xlsx",
    // Data store ID
  dataStoreId: "arn:aws:s3::123456789101:mys3-prod",
};

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

Parameters

Name Type Description Notes
dataResourceId [string] Data resource ID defaults to undefined
dataStoreId [string] Data store ID defaults to undefined

Return type

RemoveResource200Response

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]

updateResourceReviewStatus

UpdateResourceReviewStatus200Response updateResourceReviewStatus(updateResourceReviewBody)

Set the review status of a specific data resource in a specific data store.

Example

import { createConfiguration, DataResourcesApi } from '';
import type { DataResourcesApiUpdateResourceReviewStatusRequest } from '';

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

const request: DataResourcesApiUpdateResourceReviewStatusRequest = {
    // Data resource id
  dataResourceId: "dataResourceId_example",
  
  updateResourceReviewBody: {
    isReviewed: true,
  },
};

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

Parameters

Name Type Description Notes
updateResourceReviewBody UpdateResourceReviewBody
dataResourceId [string] Data resource id defaults to undefined

Return type

UpdateResourceReviewStatus200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 success -

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