Skip to content

Latest commit

 

History

History
409 lines (255 loc) · 13.7 KB

VulnerabilityManagementServiceApi.md

File metadata and controls

409 lines (255 loc) · 13.7 KB

.VulnerabilityManagementServiceApi

All URIs are relative to http://localhost

Method HTTP request Description
vulnerabilityManagementServiceCreateVulnerability POST /api/v3/vulnerabilities/ingestion Summary: Create a vulnerability Description: Create a vulnerability based on request
vulnerabilityManagementServiceGetFiltersForVulnerabilities GET /api/v3/vulnerabilities/filters/metadata Summary: Get filters for vulnerabilities Description: Get a list of filters category and sub category with all data.
vulnerabilityManagementServiceGetVulnerabilities POST /api/v3/vulnerabilities/search Summary: Get vulnerabilities Description: Returns a list of vulnerabilities.
vulnerabilityManagementServiceGetVulnerabilitiesStats GET /api/v3/vulnerabilities/stats/data Summary: Get vulnerabilities stats Description: Get various vulnerabilities stats.
vulnerabilityManagementServiceGetVulnerability GET /api/v3/vulnerabilities/{vulnerability_id} Summary: Get vulnerability Description: Returns a vulnerability based on vulnerability.
vulnerabilityManagementServiceUpdateVulnerabilities PATCH /api/v3/vulnerabilities Updates comments, assignee, and status for vulnerabilities
vulnerabilityManagementServiceVulnerabilityIngestionManualTrigger POST /api/v3/vulnerabilities/ingestion/trigger Summary: Vulnerability ingest manual trigger Description: Manual trigger for Scheduled Vulnerability Ingestion.

vulnerabilityManagementServiceCreateVulnerability

Vulmanagementv3CreateVulnerabilityResponse vulnerabilityManagementServiceCreateVulnerability(vulmanagementv3CreateVulnerabilityRequest)

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';
import type { VulnerabilityManagementServiceApiVulnerabilityManagementServiceCreateVulnerabilityRequest } from '';

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

const request: VulnerabilityManagementServiceApiVulnerabilityManagementServiceCreateVulnerabilityRequest = {
  
  vulmanagementv3CreateVulnerabilityRequest: {
    description: "description_example",
    details: {},
    entityId: "entityId_example",
    name: "name_example",
    severity: "SEVERITY_UNKNOWN",
    sourceId: "sourceId_example",
    sourceType: "UNKNOWN",
  },
};

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

Parameters

Name Type Description Notes
vulmanagementv3CreateVulnerabilityRequest Vulmanagementv3CreateVulnerabilityRequest

Return type

Vulmanagementv3CreateVulnerabilityResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceGetFiltersForVulnerabilities

Vulmanagementv3GetFiltersDataResponse vulnerabilityManagementServiceGetFiltersForVulnerabilities()

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Vulmanagementv3GetFiltersDataResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceGetVulnerabilities

Vulmanagementv3GetVulnerabilitiesResponse vulnerabilityManagementServiceGetVulnerabilities(vulmanagementv3GetVulnerabilitiesRequest)

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';
import type { VulnerabilityManagementServiceApiVulnerabilityManagementServiceGetVulnerabilitiesRequest } from '';

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

const request: VulnerabilityManagementServiceApiVulnerabilityManagementServiceGetVulnerabilitiesRequest = {
  
  vulmanagementv3GetVulnerabilitiesRequest: {
    filter: [
      {
        categoryId: "categoryId_example",
        subCategoryIds: [
          "subCategoryIds_example",
        ],
        subCategoryValues: [
          "subCategoryValues_example",
        ],
      },
    ],
    limit: 1,
    offset: 1,
    searchKey: "searchKey_example",
    sortColumn: "sortColumn_example",
    sortOrder: "ASC",
  },
};

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

Parameters

Name Type Description Notes
vulmanagementv3GetVulnerabilitiesRequest Vulmanagementv3GetVulnerabilitiesRequest

Return type

Vulmanagementv3GetVulnerabilitiesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceGetVulnerabilitiesStats

Vulmanagementv3VulnerabilitiesStatsDataResponse vulnerabilityManagementServiceGetVulnerabilitiesStats()

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

Vulmanagementv3VulnerabilitiesStatsDataResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceGetVulnerability

Vulmanagementv3GetVulnerabilityResponse vulnerabilityManagementServiceGetVulnerability()

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';
import type { VulnerabilityManagementServiceApiVulnerabilityManagementServiceGetVulnerabilityRequest } from '';

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

const request: VulnerabilityManagementServiceApiVulnerabilityManagementServiceGetVulnerabilityRequest = {
    // ID for the record to return.
  vulnerabilityId: "vulnerability_id_example",
};

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

Parameters

Name Type Description Notes
vulnerabilityId [string] ID for the record to return. defaults to undefined

Return type

Vulmanagementv3GetVulnerabilityResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceUpdateVulnerabilities

Vulmanagementv3UpdateVulnerabilitiesResponse vulnerabilityManagementServiceUpdateVulnerabilities(vulmanagementv3UpdateVulnerabilitiesRequest)

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';
import type { VulnerabilityManagementServiceApiVulnerabilityManagementServiceUpdateVulnerabilitiesRequest } from '';

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

const request: VulnerabilityManagementServiceApiVulnerabilityManagementServiceUpdateVulnerabilitiesRequest = {
  
  vulmanagementv3UpdateVulnerabilitiesRequest: {
    updates: [
      {
        actionType: "ACTION_TYPE_UNKNOWN",
        assigneeUserid: "assigneeUserid_example",
        comment: "comment_example",
        severity: "SEVERITY_UNKNOWN",
        status: "STATUS_UNKNOWN",
        vulnerabilityId: "vulnerabilityId_example",
      },
    ],
  },
};

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

Parameters

Name Type Description Notes
vulmanagementv3UpdateVulnerabilitiesRequest Vulmanagementv3UpdateVulnerabilitiesRequest

Return type

Vulmanagementv3UpdateVulnerabilitiesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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

vulnerabilityManagementServiceVulnerabilityIngestionManualTrigger

Vulmanagementv3VulnerabilityIngestionResponse vulnerabilityManagementServiceVulnerabilityIngestionManualTrigger(body)

Example

import { createConfiguration, VulnerabilityManagementServiceApi } from '';
import type { VulnerabilityManagementServiceApiVulnerabilityManagementServiceVulnerabilityIngestionManualTriggerRequest } from '';

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

const request: VulnerabilityManagementServiceApiVulnerabilityManagementServiceVulnerabilityIngestionManualTriggerRequest = {
  
  body: {},
};

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

Parameters

Name Type Description Notes
body any

Return type

Vulmanagementv3VulnerabilityIngestionResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

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