ExternalSourcesApi.md

ExternalSourcesApi

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

Method	HTTP request	Description
v3GetVirustotalScanOperation	GET /v3/operations/virustotal-scan/{binary_id}	Get a VirusTotal scan operation.
v3RunVirustotalScan	POST /v3/binaries/{binary_id}/virustotal-scan:run	Trigger a VirusTotal lookup for a binary.

v3GetVirustotalScanOperation

OperationVirusTotalScanMetadataVirusTotalScanResult v3GetVirustotalScanOperation(binaryId)

Get a VirusTotal scan operation.

Returns the current state of the most recently triggered VirusTotal lookup for this binary. Error codes: - `404` `NOT_FOUND` — Not Found - `403` `ACCESS_DENIED` — Access Denied

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.ExternalSourcesApi;

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");

    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ExternalSourcesApi apiInstance = new ExternalSourcesApi(defaultClient);
    Long binaryId = 56L; // Long | Binary ID
    try {
      OperationVirusTotalScanMetadataVirusTotalScanResult result = apiInstance.v3GetVirustotalScanOperation(binaryId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ExternalSourcesApi#v3GetVirustotalScanOperation");
      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
binaryId	Long	Binary ID

Return type

OperationVirusTotalScanMetadataVirusTotalScanResult

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
500	Internal Server Error	-

v3RunVirustotalScan

OperationVirusTotalScanMetadataVirusTotalScanResult v3RunVirustotalScan(binaryId)

Trigger a VirusTotal lookup for a binary.

Starts a lookup of the binary's content hash against VirusTotal, using the team's registered API key, and returns the operation to poll for its outcome. Returns 403 if the team has no valid key registered, and 409 while a lookup is already in progress for this binary. Error codes: - `404` `NOT_FOUND` — Not Found - `403` `ACCESS_DENIED` — Access Denied - `409` `CONFLICT` — Conflict - `403` `NO_VIRUSTOTAL_KEY` — No VirusTotal Key

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.ExternalSourcesApi;

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");

    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    ExternalSourcesApi apiInstance = new ExternalSourcesApi(defaultClient);
    Long binaryId = 56L; // Long | Binary ID
    try {
      OperationVirusTotalScanMetadataVirusTotalScanResult result = apiInstance.v3RunVirustotalScan(binaryId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ExternalSourcesApi#v3RunVirustotalScan");
      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
binaryId	Long	Binary ID

Return type

OperationVirusTotalScanMetadataVirusTotalScanResult

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
500	Internal Server Error	-