Skip to content

AnalysesResultsMetadataApi.md

Latest commit

 

History

History
413 lines (250 loc) · 11.4 KB

AnalysesResultsMetadataApi.md

File metadata and controls

413 lines (250 loc) · 11.4 KB

.AnalysesResultsMetadataApi

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
getAnalysisFunctionsPaginated GET /v2/analyses/{analysis_id}/functions Get functions from analysis
getCapabilities GET /v2/analyses/{analysis_id}/capabilities Gets the capabilities from the analysis
getFunctionsList GET /v2/analyses/{analysis_id}/functions/list Gets functions from analysis
getPdf GET /v2/analyses/{analysis_id}/pdf Gets the PDF found in the analysis
getSbom GET /v2/analyses/{analysis_id}/sbom Gets the software-bill-of-materials (SBOM) found in the analysis
getTags GET /v2/analyses/{analysis_id}/tags Get function tags with maliciousness score
getVulnerabilities GET /v2/analyses/{analysis_id}/vulnerabilities Gets the vulnerabilities found in the analysis

getAnalysisFunctionsPaginated

BaseResponseAnalysisFunctionsList getAnalysisFunctionsPaginated()

Returns a paginated list of functions identified during analysis

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetAnalysisFunctionsPaginatedRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetAnalysisFunctionsPaginatedRequest = {
  
  analysisId: 1,
    // The page number to retrieve. (optional)
  page: 1,
    // Number of items per page. (optional)
  pageSize: 1000,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
page [number] The page number to retrieve. (optional) defaults to 1
pageSize [number] Number of items per page. (optional) defaults to 1000

Return type

BaseResponseAnalysisFunctionsList

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getCapabilities

BaseResponseCapabilities getCapabilities()

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetCapabilitiesRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetCapabilitiesRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseCapabilities

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getFunctionsList

BaseResponseAnalysisFunctions getFunctionsList()

Gets the functions identified during analysis

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetFunctionsListRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetFunctionsListRequest = {
  
  analysisId: 1,
  
  searchTerm: "search_term_example",
  
  minVAddr: 1,
  
  maxVAddr: 1,
  
  includeEmbeddings: true,
    // The page number to retrieve. (optional)
  page: 1,
    // Number of items per page. (optional)
  pageSize: 1000,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
searchTerm [string] (optional) defaults to undefined
minVAddr [number] (optional) defaults to undefined
maxVAddr [number] (optional) defaults to undefined
includeEmbeddings [boolean] (optional) defaults to true
page [number] The page number to retrieve. (optional) defaults to 1
pageSize [number] Number of items per page. (optional) defaults to 1000

Return type

BaseResponseAnalysisFunctions

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getPdf

any getPdf()

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetPdfRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetPdfRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

any

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getSbom

BaseResponseListSBOM getSbom()

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetSbomRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetSbomRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseListSBOM

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getTags

BaseResponseAnalysisTags getTags()

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetTagsRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetTagsRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseAnalysisTags

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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

getVulnerabilities

BaseResponseVulnerabilities getVulnerabilities()

Example

import { createConfiguration, AnalysesResultsMetadataApi } from '@revengai/sdk';
import type { AnalysesResultsMetadataApiGetVulnerabilitiesRequest } from '@revengai/sdk';

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

const request: AnalysesResultsMetadataApiGetVulnerabilitiesRequest = {
  
  analysisId: 1,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined

Return type

BaseResponseVulnerabilities

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

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