Skip to content

Latest commit

 

History

History
503 lines (308 loc) · 15.5 KB

DataVulnerabilitiesApi.md

File metadata and controls

503 lines (308 loc) · 15.5 KB

.DataVulnerabilitiesApi

All URIs are relative to http://localhost

Method HTTP request Description
addVulnerabilityStatusComment POST /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments Add vulnerability status comment
getVulnerabilitiesSummary GET /api/v2/dspm/vulnerabilities/summary Get vulnerabilities summary
getVulnerability GET /api/v2/dspm/vulnerabilities/{vulnerabilityId} Get vulnerability details by ID
listVulnerabilities GET /api/v2/dspm/vulnerabilities List vulnerabilities based on an applied filter
listVulnerabilitiesByDataStore GET /api/v2/dspm/vulnerabilities/byDataStore List vulnerabilities of data stores
removeVulnerabilityStatusComment DELETE /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Delete vulnerability status comment
setVulnerabilityStatus POST /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses Set status of a vulnerability
updateVulnerabilityStatusComment PUT /api/v2/dspm/vulnerabilities/{vulnerabilityId}/statuses/{statusId}/comments/{commentId} Set vulnerability status

addVulnerabilityStatusComment

VulnerabilityStatus addVulnerabilityStatusComment(addCommentBody)

Add or update the status comment of a vulnerability status to keep track of the workflow progress.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiAddVulnerabilityStatusCommentRequest } from '';

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

const request: DataVulnerabilitiesApiAddVulnerabilityStatusCommentRequest = {
  
  vulnerabilityId: "384cd426-b187-438a-affc-e12b323f5890",
  
  statusId: "statusId_example",
  
  addCommentBody: {
    comment: "comment_example",
  },
};

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

Parameters

Name Type Description Notes
addCommentBody AddCommentBody
vulnerabilityId [string] defaults to undefined
statusId [string] defaults to undefined

Return type

VulnerabilityStatus

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • 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]

getVulnerabilitiesSummary

VulnerabilitiesSummary getVulnerabilitiesSummary()

Get a summary of all the vulnerabilities. You can also filter the results of the vulnerabilities based on the vulnerebility's type, threat, status, and so on.
Note: Filter needs to be HTML Encoded.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiGetVulnerabilitiesSummaryRequest } from '';

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

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

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

Parameters

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

Return type

VulnerabilitiesSummary

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]

getVulnerability

Vulnerability getVulnerability()

Get vulnerability details by providing its ID.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiGetVulnerabilityRequest } from '';

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

const request: DataVulnerabilitiesApiGetVulnerabilityRequest = {
  
  vulnerabilityId: "384cd426-b187-438a-affc-e12b323f5890",
};

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

Parameters

Name Type Description Notes
vulnerabilityId [string] defaults to undefined

Return type

Vulnerability

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]

listVulnerabilities

ListVulnerabilities200Response listVulnerabilities()

Get a list of data vulnerabilities based on a filter applied. You can filter by ID of the vulnerability, type of the vulnerability, and so on.
Note: Filter needs to be HTML encoded.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiListVulnerabilitiesRequest } from '';

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

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

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

Parameters

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

Return type

ListVulnerabilities200Response

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]

listVulnerabilitiesByDataStore

ListVulnerabilitiesByDataStore200Response listVulnerabilitiesByDataStore()

Get a list of all the vulnerabilities of data stores.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiListVulnerabilitiesByDataStoreRequest } from '';

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

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

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

Parameters

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

Return type

ListVulnerabilitiesByDataStore200Response

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]

removeVulnerabilityStatusComment

void removeVulnerabilityStatusComment()

Delete a status comment of a vulnerability status.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiRemoveVulnerabilityStatusCommentRequest } from '';

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

const request: DataVulnerabilitiesApiRemoveVulnerabilityStatusCommentRequest = {
  
  vulnerabilityId: "384cd426-b187-438a-affc-e12b323f5890",
  
  statusId: "statusId_example",
  
  commentId: "commentId_example",
};

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

Parameters

Name Type Description Notes
vulnerabilityId [string] defaults to undefined
statusId [string] defaults to undefined
commentId [string] defaults to undefined

Return type

void

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]

setVulnerabilityStatus

VulnerabilityStatus setVulnerabilityStatus(setVulnerabilityStatusRequest)

Add or update the status of a vulnerability to track its progress.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiSetVulnerabilityStatusRequest } from '';

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

const request: DataVulnerabilitiesApiSetVulnerabilityStatusRequest = {
  
  vulnerabilityId: "vulnerabilityId_example",
  
  setVulnerabilityStatusRequest: {
    status: "review",
  },
};

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

Parameters

Name Type Description Notes
setVulnerabilityStatusRequest SetVulnerabilityStatusRequest
vulnerabilityId [string] defaults to undefined

Return type

VulnerabilityStatus

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • 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]

updateVulnerabilityStatusComment

VulnerabilityStatusComment updateVulnerabilityStatusComment(updateCommentBody)

Set a vulnerability status of a vulnerability.

Example

import { createConfiguration, DataVulnerabilitiesApi } from '';
import type { DataVulnerabilitiesApiUpdateVulnerabilityStatusCommentRequest } from '';

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

const request: DataVulnerabilitiesApiUpdateVulnerabilityStatusCommentRequest = {
  
  vulnerabilityId: "384cd426-b187-438a-affc-e12b323f5890",
  
  statusId: "statusId_example",
  
  commentId: "commentId_example",
  
  updateCommentBody: {
    comment: "comment_example",
  },
};

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

Parameters

Name Type Description Notes
updateCommentBody UpdateCommentBody
vulnerabilityId [string] defaults to undefined
statusId [string] defaults to undefined
commentId [string] defaults to undefined

Return type

VulnerabilityStatusComment

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • 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]