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(analysisId, page, pageSize)

Get functions from analysis

Returns a paginated list of functions identified during analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    Integer page = 1; // Integer | The page number to retrieve.
    Integer pageSize = 1000; // Integer | Number of items per page.
    try {
      BaseResponseAnalysisFunctionsList result = apiInstance.getAnalysisFunctionsPaginated(analysisId, page, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getAnalysisFunctionsPaginated");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer
page	Integer	The page number to retrieve.	[optional] [default to 1]
pageSize	Integer	Number of items per page.	[optional] [default 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	-

getCapabilities

BaseResponseCapabilities getCapabilities(analysisId)

Gets the capabilities from the analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseCapabilities result = apiInstance.getCapabilities(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getCapabilities");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer

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	-

getFunctionsList

BaseResponseAnalysisFunctions getFunctionsList(analysisId, searchTerm, minVAddr, maxVAddr, includeEmbeddings, page, pageSize)

Gets functions from analysis

Gets the functions identified during analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    String searchTerm = "searchTerm_example"; // String | 
    Integer minVAddr = 56; // Integer | 
    Integer maxVAddr = 56; // Integer | 
    Boolean includeEmbeddings = true; // Boolean | 
    Integer page = 1; // Integer | The page number to retrieve.
    Integer pageSize = 1000; // Integer | Number of items per page.
    try {
      BaseResponseAnalysisFunctions result = apiInstance.getFunctionsList(analysisId, searchTerm, minVAddr, maxVAddr, includeEmbeddings, page, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getFunctionsList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer
searchTerm	String		[optional]
minVAddr	Integer		[optional]
maxVAddr	Integer		[optional]
includeEmbeddings	Boolean		[optional] [default to true]
page	Integer	The page number to retrieve.	[optional] [default to 1]
pageSize	Integer	Number of items per page.	[optional] [default 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	-

getPdf

Object getPdf(analysisId)

Gets the PDF found in the analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      Object result = apiInstance.getPdf(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getPdf");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer

Return type

Object

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	-

getSbom

BaseResponseListSBOM getSbom(analysisId)

Gets the software-bill-of-materials (SBOM) found in the analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseListSBOM result = apiInstance.getSbom(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getSbom");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer

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	-

getTags

BaseResponseAnalysisTags getTags(analysisId)

Get function tags with maliciousness score

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseAnalysisTags result = apiInstance.getTags(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer

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	-

getVulnerabilities

BaseResponseVulnerabilities getVulnerabilities(analysisId)

Gets the vulnerabilities found in the analysis

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesResultsMetadataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.reveng.ai");
    
    // Configure API key authorization: APIKey
    ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
    APIKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //APIKey.setApiKeyPrefix("Token");

    AnalysesResultsMetadataApi apiInstance = new AnalysesResultsMetadataApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseVulnerabilities result = apiInstance.getVulnerabilities(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesResultsMetadataApi#getVulnerabilities");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
analysisId	Integer

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	-

FilesExpand file tree

AnalysesResultsMetadataApi.md

Latest commit

History

AnalysesResultsMetadataApi.md

File metadata and controls

AnalysesResultsMetadataApi

getAnalysisFunctionsPaginated

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCapabilities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getFunctionsList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getPdf

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSbom

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVulnerabilities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details