Skip to content

README.md

Latest commit

 

History

History
1143 lines (1116 loc) · 95.8 KB

README.md

File metadata and controls

1143 lines (1116 loc) · 95.8 KB
Raw

RevEng.AI Java SDK

This is the Java SDK for the RevEng.AI API.

To use the SDK you will first need to obtain an API key from https://reveng.ai.

Installation

Once you have the API key you can install the SDK using Maven or Gradle:

Maven

Add this dependency to your project's POM:

<dependency>
    <groupId>ai.reveng</groupId>
    <artifactId>sdk</artifactId>
    <version>4.74.3</version>
    <scope>compile</scope>
</dependency>

Gradle

Add this dependency to your project's build file:

repositories {
    mavenCentral()
}

dependencies {
    implementation "ai.reveng:sdk:4.74.3"
}

Usage

The following is an example of how to use the SDK to get the logs of an analysis:

import ai.reveng.invoker.*;
import ai.reveng.invoker.auth.*;
import ai.reveng.model.*;
import ai.reveng.api.AnalysesCoreApi;

public class App {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: APIKey
        ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
        APIKey.setApiKey(System.getenv("API_KEY"));

        AnalysesCoreApi apiInstance = new AnalysesCoreApi(defaultClient);
        Integer analysisId = 715320; // Integer

        try {
            BaseResponseLogs result = apiInstance.getAnalysisLogs(analysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysesCommentsApi#createAnalysisComment");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AgentApi checkCapabilitiesTaskStatusV2AnalysesAnalysisIdAgentCapabilitiesStatusGet GET /v2/analyses/{analysis_id}/agent/capabilities/status Check the status of a capabilities analysis workflow
AgentApi checkProtocolsTaskStatusV2AnalysesAnalysisIdAgentProtocolsStatusGet GET /v2/analyses/{analysis_id}/agent/protocols/status Check the status of a protocols discovery workflow
AgentApi checkRemediationTaskStatusV2AnalysesAnalysisIdAgentRemediationStatusGet GET /v2/analyses/{analysis_id}/agent/remediation/status Check the status of a remediation analysis workflow
AgentApi checkReportAnalysisTaskStatusV2AnalysesAnalysisIdAgentReportAnalysisStatusGet GET /v2/analyses/{analysis_id}/agent/report-analysis/status Check the status of a report analysis workflow
AgentApi checkSecretsTaskStatusV2AnalysesAnalysisIdAgentSecretsStatusGet GET /v2/analyses/{analysis_id}/agent/secrets/status Check the status of a secrets discovery workflow
AgentApi checkTriageTaskStatusV2AnalysesAnalysisIdAgentTriageStatusGet GET /v2/analyses/{analysis_id}/agent/triage/status Check the status of a triage analysis workflow
AgentApi createCapabilitiesTaskV2AnalysesAnalysisIdAgentCapabilitiesPost POST /v2/analyses/{analysis_id}/agent/capabilities Queues a capabilities analysis workflow process
AgentApi createProtocolsTaskV2AnalysesAnalysisIdAgentProtocolsPost POST /v2/analyses/{analysis_id}/agent/protocols Queues a protocols discovery workflow process
AgentApi createRemediationTaskV2AnalysesAnalysisIdAgentRemediationPost POST /v2/analyses/{analysis_id}/agent/remediation Queues a remediation analysis workflow process
AgentApi createReportAnalysisTaskV2AnalysesAnalysisIdAgentReportAnalysisPost POST /v2/analyses/{analysis_id}/agent/report-analysis Queues a combined report analysis workflow process
AgentApi createSecretsTaskV2AnalysesAnalysisIdAgentSecretsPost POST /v2/analyses/{analysis_id}/agent/secrets Queues a secrets discovery workflow process
AgentApi createTriageTaskV2AnalysesAnalysisIdAgentTriagePost POST /v2/analyses/{analysis_id}/agent/triage Queues a triage analysis workflow process
AgentApi getCapabilitiesResultV2AnalysesAnalysisIdAgentCapabilitiesGet GET /v2/analyses/{analysis_id}/agent/capabilities Get Capabilities Result
AgentApi getProtocolsResultV2AnalysesAnalysisIdAgentProtocolsGet GET /v2/analyses/{analysis_id}/agent/protocols Get Protocols Result
AgentApi getRemediationResultV2AnalysesAnalysisIdAgentRemediationGet GET /v2/analyses/{analysis_id}/agent/remediation Get Remediation Result
AgentApi getReportAnalysisResultV2AnalysesAnalysisIdAgentReportAnalysisGet GET /v2/analyses/{analysis_id}/agent/report-analysis Get Report Analysis Result
AgentApi getSecretsResultV2AnalysesAnalysisIdAgentSecretsGet GET /v2/analyses/{analysis_id}/agent/secrets Get Secrets Result
AgentApi getTriageResultV2AnalysesAnalysisIdAgentTriageGet GET /v2/analyses/{analysis_id}/agent/triage Get Triage Result
AgentApi v3CancelRenameUnnamedFunctions POST /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/cancel Cancel the rename-unnamed-functions agent.
AgentApi v3CancelSecurityScanOperation POST /v3/operations/security-scan/{analysis_id}:cancel Cancel a security-scan operation.
AgentApi v3GetBinaryAgentFeedback GET /v3/analyses/{analysis_id}/agents/{agent}/feedback Get the caller's feedback on an agent's output.
AgentApi v3GetCapabilitiesOperation GET /v3/operations/capabilities/{analysis_id} Get a capabilities operation.
AgentApi v3GetCryptoExplainOperation GET /v3/operations/crypto-explain/{function_id} Get a crypto-explain operation.
AgentApi v3GetCryptoScanOperation GET /v3/operations/crypto-scan/{analysis_id} Get a crypto-scan operation.
AgentApi v3GetCryptographyOperation GET /v3/operations/cryptography/{analysis_id} Get a cryptography operation.
AgentApi v3GetExecutionExplainOperation GET /v3/operations/execution-explain/{function_id} Get an execution-explain operation.
AgentApi v3GetExecutionScanOperation GET /v3/operations/execution-scan/{analysis_id} Get an execution-scan operation.
AgentApi v3GetFilesystemAnalyseOperation GET /v3/operations/filesystem-analyse/{function_id} Get a filesystem-analyse operation.
AgentApi v3GetFilesystemScanOperation GET /v3/operations/filesystem-scan/{analysis_id} Get a filesystem-scan operation.
AgentApi v3GetNetworkingExplainOperation GET /v3/operations/networking-explain/{function_id} Get a networking-explain operation.
AgentApi v3GetNetworkingScanOperation GET /v3/operations/networking-scan/{analysis_id} Get a networking-scan operation.
AgentApi v3GetProtocolsOperation GET /v3/operations/protocols/{analysis_id} Get a protocols operation.
AgentApi v3GetRemediationOperation GET /v3/operations/remediation/{analysis_id} Get a remediation operation.
AgentApi v3GetRenameUnnamedFunctionsOperation GET /v3/operations/rename-unnamed-functions/{analysis_id} Get a rename-unnamed-functions operation.
AgentApi v3GetRenameUnnamedFunctionsResult GET /v3/analyses/{analysis_id}/agents/rename-unnamed-functions Get rename-unnamed-functions agent result.
AgentApi v3GetRenameUnnamedFunctionsStatus GET /v3/analyses/{analysis_id}/agents/rename-unnamed-functions/status Get rename-unnamed-functions agent status.
AgentApi v3GetReportAnalysisOperation GET /v3/operations/report-analysis/{analysis_id} Get a report-analysis operation.
AgentApi v3GetSecretsOperation GET /v3/operations/secrets/{analysis_id} Get a secrets operation.
AgentApi v3GetSecurityScanOperation GET /v3/operations/security-scan/{analysis_id} Get a security-scan operation.
AgentApi v3GetTriageOperation GET /v3/operations/triage/{analysis_id} Get a triage operation.
AgentApi v3ListOperationPrerequisites GET /v3/operation-prerequisites List operation prerequisites.
AgentApi v3RunCapabilities POST /v3/analyses/{analysis_id}/capabilities:run Run the capabilities agent.
AgentApi v3RunCryptoExplain POST /v3/functions/{function_id}/crypto-explain:run Run the crypto-explain agent.
AgentApi v3RunCryptoScan POST /v3/analyses/{analysis_id}/crypto-scan:run Run the crypto-scan agent.
AgentApi v3RunCryptography POST /v3/analyses/{analysis_id}/cryptography:run Run the cryptography agent.
AgentApi v3RunExecutionExplain POST /v3/functions/{function_id}/execution-explain:run Run the execution-explain agent.
AgentApi v3RunExecutionScan POST /v3/analyses/{analysis_id}/execution-scan:run Run the execution-scan agent.
AgentApi v3RunFilesystemAnalyse POST /v3/functions/{function_id}/filesystem-analyse:run Run the filesystem-analyse agent.
AgentApi v3RunFilesystemScan POST /v3/analyses/{analysis_id}/filesystem-scan:run Run the filesystem-scan agent.
AgentApi v3RunNetworkingExplain POST /v3/functions/{function_id}/networking-explain:run Run the networking-explain agent.
AgentApi v3RunNetworkingScan POST /v3/analyses/{analysis_id}/networking-scan:run Run the networking-scan agent.
AgentApi v3RunProtocols POST /v3/analyses/{analysis_id}/protocols:run Run the protocols agent.
AgentApi v3RunRemediation POST /v3/analyses/{analysis_id}/remediation:run Run the remediation agent.
AgentApi v3RunReportAnalysis POST /v3/analyses/{analysis_id}/report-analysis:run Run the report-analysis agent.
AgentApi v3RunSecrets POST /v3/analyses/{analysis_id}/secrets:run Run the secrets agent.
AgentApi v3RunSecurityScan POST /v3/analyses/{analysis_id}/security-scan:run Run the security-scan agent.
AgentApi v3RunTriage POST /v3/analyses/{analysis_id}/triage:run Run the triage agent.
AgentApi v3TriggerRenameUnnamedFunctions POST /v3/analyses/{analysis_id}/agents/rename-unnamed-functions Run the rename-unnamed-functions agent.
AgentApi v3UpsertBinaryAgentFeedback PUT /v3/analyses/{analysis_id}/agents/{agent}/feedback Record feedback on an agent's output.
AnalysesBulkActionsApi bulkAddAnalysisTags PATCH /v2/analyses/tags/add Bulk Add Analysis Tags
AnalysesBulkActionsApi bulkDeleteAnalyses PATCH /v2/analyses/delete Bulk Delete Analyses
AnalysesBulkActionsApi v3BatchAddAnalysisTags POST /v3/analyses:batchAddTags Add tags to multiple analyses.
AnalysesBulkActionsApi v3BatchDeleteAnalyses POST /v3/analyses:batchDelete Delete multiple analyses.
AnalysesCommentsApi createAnalysisComment POST /v2/analyses/{analysis_id}/comments Create a comment for this analysis
AnalysesCommentsApi deleteAnalysisComment DELETE /v2/analyses/{analysis_id}/comments/{comment_id} Delete a comment
AnalysesCommentsApi getAnalysisComments GET /v2/analyses/{analysis_id}/comments Get comments for this analysis
AnalysesCommentsApi updateAnalysisComment PATCH /v2/analyses/{analysis_id}/comments/{comment_id} Update a comment
AnalysesCoreApi addUserStringToAnalysis POST /v3/analyses/{analysis_id}/user-provided-strings Add a user-provided string to an analysis.
AnalysesCoreApi createAnalysis POST /v2/analyses Create Analysis
AnalysesCoreApi deleteAnalysis DELETE /v2/analyses/{analysis_id} Delete Analysis
AnalysesCoreApi getAnalysisBasicInfo GET /v2/analyses/{analysis_id}/basic Gets basic analysis information
AnalysesCoreApi getAnalysisBasicInfo_0 GET /v3/analyses/{analysis_id}/basic Get basic analysis information
AnalysesCoreApi getAnalysisBytes GET /v3/analyses/{analysis_id}/bytes Get the bytes of a binary
AnalysesCoreApi getAnalysisFunctionMap GET /v2/analyses/{analysis_id}/func_maps Get Analysis Function Map
AnalysesCoreApi getAnalysisFunctionMatches GET /v3/analyses/{analysis_id}/functions/matches Get function-matching results for an analysis
AnalysesCoreApi getAnalysisFunctionMatchingStatus GET /v3/analyses/{analysis_id}/functions/matches/status Get function-matching status for an analysis
AnalysesCoreApi getAnalysisLogs GET /v2/analyses/{analysis_id}/logs Gets the logs of an analysis
AnalysesCoreApi getAnalysisParams GET /v2/analyses/{analysis_id}/params Gets analysis param information
AnalysesCoreApi getAnalysisStatus GET /v2/analyses/{analysis_id}/status Gets the status of an analysis
AnalysesCoreApi getDynamicExecutionReport GET /v2/analyses/{analysis_id}/dynamic-execution/report Get dynamic execution report
AnalysesCoreApi getDynamicExecutionStatus GET /v2/analyses/{analysis_id}/dynamic-execution/status Get dynamic execution status
AnalysesCoreApi insertAnalysisLog POST /v2/analyses/{analysis_id}/logs Insert a log entry for an analysis
AnalysesCoreApi listAnalyses GET /v2/analyses/list Gets the most recent analyses
AnalysesCoreApi lookupBinaryId GET /v2/analyses/lookup/{binary_id} Gets the analysis ID from binary ID
AnalysesCoreApi putAnalysisStrings PUT /v2/analyses/{analysis_id}/strings Add strings to the analysis
AnalysesCoreApi requeueAnalysis POST /v2/analyses/{analysis_id}/requeue Requeue Analysis
AnalysesCoreApi startAnalysisFunctionMatching POST /v3/analyses/{analysis_id}/functions/matches Start function matching for an analysis
AnalysesCoreApi updateAnalysis PATCH /v2/analyses/{analysis_id} Update Analysis
AnalysesCoreApi updateAnalysisTags PATCH /v2/analyses/{analysis_id}/tags Update Analysis Tags
AnalysesCoreApi uploadFile POST /v2/upload Upload File
AnalysesCoreApi v3DeleteAnalysis DELETE /v3/analyses/{analysis_id} Delete an analysis.
AnalysesCoreApi v3DownloadBinaryExport GET /v3/analyses/{analysis_id}/binary-export Download a binary export
AnalysesCoreApi v3GetAnalysis GET /v3/analyses/{analysis_id} Get an analysis.
AnalysesCoreApi v3GetAnalysisAutoUnstripStatus GET /v3/analyses/{analysis_id}/auto-unstrip/status Get the auto-unstrip status for an analysis.
AnalysesCoreApi v3GetAnalysisFunctionsProgress GET /v3/analyses/{analysis_id}/progress/functions Get function embedding progress for an analysis.
AnalysesCoreApi v3GetAnalysisGlobal GET /v3/analyses/{analysis_id}/globals/{vaddr} Get one global variable.
AnalysesCoreApi v3GetAnalysisGlobalHistory GET /v3/analyses/{analysis_id}/globals/{vaddr}/history List a global variable's replaced values.
AnalysesCoreApi v3GetAnalysisLogs GET /v3/analyses/{analysis_id}/logs Get the Analysis log
AnalysesCoreApi v3GetAnalysisOperation GET /v3/operations/analyses/{analysis_id} Get an Analysis-creation operation
AnalysesCoreApi v3GetAnalysisStrings GET /v3/analyses/{analysis_id}/functions/strings List strings for an analysis.
AnalysesCoreApi v3GetAnalysisStringsStatus GET /v3/analyses/{analysis_id}/functions/strings/status Get the string-extraction status for an analysis.
AnalysesCoreApi v3GetBinaryExportOperation GET /v3/operations/binary-export/{task_id} Get a binary export operation
AnalysesCoreApi v3GetDynamicExecutionArtifact GET /v3/analyses/{analysis_id}/dynamic-execution/artifacts/{sha256} Download an artifact.
AnalysesCoreApi v3GetDynamicExecutionLogsDownload GET /v3/analyses/{analysis_id}/dynamic-execution/logs/download Download the execution logs archive.
AnalysesCoreApi v3GetDynamicExecutionMemdump GET /v3/analyses/{analysis_id}/dynamic-execution/memdumps/{sha256} Download a memory dump.
AnalysesCoreApi v3GetDynamicExecutionOperation GET /v3/operations/dynamic-execution/{analysis_id} Get a dynamic execution operation.
AnalysesCoreApi v3GetDynamicExecutionPcap GET /v3/analyses/{analysis_id}/dynamic-execution/pcap Download the network capture.
AnalysesCoreApi v3GetDynamicExecutionReport GET /v3/analyses/{analysis_id}/dynamic-execution/report Get the dynamic execution report.
AnalysesCoreApi v3GetDynamicExecutionScreenshot GET /v3/analyses/{analysis_id}/dynamic-execution/screenshots/{index} Download a screenshot.
AnalysesCoreApi v3GetDynamicExecutionSummary GET /v3/analyses/{analysis_id}/dynamic-execution/summary Get the dynamic execution summary.
AnalysesCoreApi v3GetDynamicExecutionSummaryOperation GET /v3/operations/dynamic-execution-summary/{analysis_id} Get a dynamic execution summary operation.
AnalysesCoreApi v3GetDynamicExecutionWiresharkKeys GET /v3/analyses/{analysis_id}/dynamic-execution/wireshark-keys Download Wireshark TLS session keys.
AnalysesCoreApi v3ListAnalyses GET /v3/analyses List analyses
AnalysesCoreApi v3ListAnalysisGlobals GET /v3/analyses/{analysis_id}/globals List the global variables in an analysis.
AnalysesCoreApi v3ListAnalysisOperations GET /v3/analyses/{analysis_id}/operations List the operations run on an analysis.
AnalysesCoreApi v3ListDynamicExecutionScreenshots GET /v3/analyses/{analysis_id}/dynamic-execution/screenshots List the screenshots captured during execution.
AnalysesCoreApi v3ListExampleAnalyses GET /v3/analyses/examples List example analyses
AnalysesCoreApi v3ListGlobalFunctions GET /v3/analyses/{analysis_id}/globals/{vaddr}/functions List the functions referencing a global variable.
AnalysesCoreApi v3LookupAnalysisByBinaryId GET /v3/analyses/lookup/{binary_id} Look up the most recent analysis for a binary.
AnalysesCoreApi v3QueueBinaryExport POST /v3/analyses/{analysis_id}/binary-export Queue a binary export
AnalysesCoreApi v3RequeueAnalysis POST /v3/analyses/{analysis_id}/requeue Requeue an analysis
AnalysesCoreApi v3RunDynamicExecution POST /v3/analyses/{analysis_id}/dynamic-execution:run Trigger a dynamic execution run.
AnalysesCoreApi v3RunDynamicExecutionSummary POST /v3/analyses/{analysis_id}/dynamic-execution/summary:run Regenerate the dynamic execution summary.
AnalysesCoreApi v3SearchTags GET /v3/tags Search tags
AnalysesCoreApi v3UpdateAnalysis PATCH /v3/analyses/{analysis_id} Update an analysis.
AnalysesCoreApi v3UpdateAnalysisGlobal PATCH /v3/analyses/{analysis_id}/globals/{vaddr} Edit a global variable.
AnalysesCoreApi v3UpdateAnalysisTags PATCH /v3/analyses/{analysis_id}/tags Replace an analysis' tags.
AnalysesCoreApi v3UpgradeAnalysisModel POST /v3/analyses/{analysis_id}/upgrade-model Re-analyse on the latest model
AnalysesResultsMetadataApi getAnalysisFunctionsPaginated GET /v2/analyses/{analysis_id}/functions Get functions from analysis
AnalysesResultsMetadataApi getCapabilities GET /v2/analyses/{analysis_id}/capabilities Gets the capabilities from the analysis
AnalysesResultsMetadataApi getFunctionsList GET /v2/analyses/{analysis_id}/functions/list Gets functions from analysis
AnalysesResultsMetadataApi getTags GET /v2/analyses/{analysis_id}/tags Get function tags with maliciousness score
AnalysesResultsMetadataApi v3GetAnalysisXref GET /v3/analyses/{analysis_id}/xrefs/{vaddr} Look up xrefs by virtual address.
AnalysesResultsMetadataApi v3ListAnalysisCapabilities GET /v3/analyses/{analysis_id}/capabilities List the capabilities found in an analysis.
AnalysesResultsMetadataApi v3ListAnalysisTags GET /v3/analyses/{analysis_id}/tags List the tags on an analysis.
AnalysesXRefsApi getXrefByVaddr GET /v2/analyses/{analysis_id}/xrefs/{vaddr} [Beta] Look up xrefs by virtual address
AuthenticationUsersApi getUser GET /v2/users/{user_id} Get a user's public information
AuthenticationUsersApi getUserActivity GET /v2/users/activity Get auth user activity
AuthenticationUsersApi submitUserFeedback POST /v2/users/feedback Submit feedback about the application
AuthenticationUsersApi v3GetUser GET /v3/users/{user_id} Get a user's public information
AuthenticationUsersApi v3GetUserActivity GET /v3/users/activity Get the caller's activity feed
AuthenticationUsersApi v3ListUsers GET /v3/users Search users
AuthenticationUsersApi v3SubmitUserFeedback POST /v3/users/feedback Submit feedback
BinariesApi downloadZippedBinary GET /v2/binaries/{binary_id}/download-zipped Downloads a zipped binary with password protection
BinariesApi getBinaryAdditionalDetails GET /v2/binaries/{binary_id}/additional-details Gets the additional details of a binary
BinariesApi getBinaryAdditionalDetailsStatus GET /v2/binaries/{binary_id}/additional-details/status Gets the status of the additional details task for a binary
BinariesApi getBinaryAdditionalDetailsStatus_0 GET /v3/binaries/{binary_id}/additional-details/status Get the additional-details extraction status for a binary.
BinariesApi getBinaryAdditionalDetails_0 GET /v3/binaries/{binary_id}/additional-details Get additional details for a binary.
BinariesApi getBinaryDetails GET /v2/binaries/{binary_id}/details Gets the details of a binary
BinariesApi getBinaryDieInfo GET /v2/binaries/{binary_id}/die-info Gets the die info of a binary
BinariesApi getBinaryExternals GET /v2/binaries/{binary_id}/externals Gets the external details of a binary
BinariesApi getBinaryRelatedStatus GET /v2/binaries/{binary_id}/related/status Gets the status of the unpack binary task for a binary
BinariesApi getRelatedBinaries GET /v2/binaries/{binary_id}/related Gets the related binaries of a binary.
BinariesApi v3DownloadBinaryZipped GET /v3/binaries/{binary_id}/download-zipped Download a binary as a password-protected zip.
BinariesApi v3GetBinaryDieInfo GET /v3/binaries/{binary_id}/die-info Get Detect It Easy matches for a binary.
BinariesApi v3GetBinaryExternals GET /v3/binaries/{binary_id}/externals Get third-party threat-intel lookups for a binary.
BinariesApi v3GetBinaryRelated GET /v3/binaries/{binary_id}/related Get the binaries related to this one by unpacking.
BinariesApi v3GetBinaryRelatedStatus GET /v3/binaries/{binary_id}/related/status Get the archive-unpacking status for a binary.
BinariesApi v3SearchBinaries GET /v3/binaries Search binaries
BinariesApi v3UploadFile POST /v3/upload Upload a file.
CollectionsApi createCollection POST /v2/collections Creates new collection information
CollectionsApi deleteCollection DELETE /v2/collections/{collection_id} Deletes a collection
CollectionsApi getCollection GET /v2/collections/{collection_id} Returns a collection
CollectionsApi listCollections GET /v2/collections Gets basic collections information
CollectionsApi updateCollection PATCH /v2/collections/{collection_id} Updates a collection
CollectionsApi updateCollectionBinaries PATCH /v2/collections/{collection_id}/binaries Updates a collection binaries
CollectionsApi updateCollectionTags PATCH /v2/collections/{collection_id}/tags Updates a collection tags
CollectionsApi v3AddCollectionBinaries POST /v3/collections/{collection_id}/binaries Add binaries to a collection.
CollectionsApi v3CreateCollection POST /v3/collections Create a collection.
CollectionsApi v3DeleteCollection DELETE /v3/collections/{collection_id} Delete a collection.
CollectionsApi v3GetCollection GET /v3/collections/{collection_id} Get a collection.
CollectionsApi v3ListCollections GET /v3/collections List collections.
CollectionsApi v3PatchCollection PATCH /v3/collections/{collection_id} Update a collection.
CollectionsApi v3PatchCollectionBinaries PATCH /v3/collections/{collection_id}/binaries Replace the binaries in a collection.
CollectionsApi v3PatchCollectionTags PATCH /v3/collections/{collection_id}/tags Replace the tags on a collection.
CollectionsApi v3RemoveCollectionBinaries DELETE /v3/collections/{collection_id}/binaries Remove binaries from a collection.
ConfigApi getConfig GET /v2/config Get Config
ConfigApi v3GetConfig GET /v3/config Get client configuration.
ConfigApi v3GetModels GET /v3/models Get the models available for analysis.
ConversationsApi cancelRun POST /v2/conversations/{id}/cancel Cancel an active run
ConversationsApi confirmTool POST /v2/conversations/{id}/confirm Approve or reject a pending tool confirmation
ConversationsApi createConversation POST /v2/conversations Create a new conversation
ConversationsApi getConversation GET /v2/conversations/{id} Get a conversation with its events
ConversationsApi listConversations GET /v2/conversations List conversations for the authenticated user
ConversationsApi sendMessage POST /v2/conversations/{id}/messages Send a message and start an agentic run
ConversationsApi streamEvents GET /v2/conversations/{id}/events Stream conversation events (SSE)
DataTypesApi v3CopyFunctionSignatures POST /v3/analyses/{analysis_id}/signatures/copy Copy function signatures
DataTypesApi v3CreateAnalysisDataTypes POST /v3/analyses/{analysis_id}/data-types Create an analysis's data types
DataTypesApi v3GetAnalysisDataType GET /v3/analyses/{analysis_id}/data-types/{data_type_id} Get one of an analysis's data types
DataTypesApi v3GetAnalysisDataTypeHistory GET /v3/analyses/{analysis_id}/data-types/{data_type_id}/history Get a data type's edit history
DataTypesApi v3GetFunctionSignature GET /v3/analyses/{analysis_id}/functions/{function_id}/signature Get a function's signature
DataTypesApi v3GetFunctionSignatureHistory GET /v3/analyses/{analysis_id}/functions/{function_id}/signature/history Get a function signature's edit history
DataTypesApi v3ListAnalysisDataTypes GET /v3/analyses/{analysis_id}/data-types List an analysis's data types
DataTypesApi v3ListDataTypeFunctions GET /v3/analyses/{analysis_id}/data-types/{data_type_id}/functions List the functions using a data type
DataTypesApi v3ListFunctionSignatures GET /v3/functions/signatures Get signatures for many functions
DataTypesApi v3UpdateAnalysisDataTypes PUT /v3/analyses/{analysis_id}/data-types Update an analysis's data types
DataTypesApi v3UpdateFunctionSignature PUT /v3/analyses/{analysis_id}/functions/{function_id}/signature Update a function's signature
ExternalSourcesApi createExternalTaskVt POST /v2/analysis/{analysis_id}/external/vt Pulls data from VirusTotal
ExternalSourcesApi getVtData GET /v2/analysis/{analysis_id}/external/vt Get VirusTotal data
ExternalSourcesApi getVtTaskStatus GET /v2/analysis/{analysis_id}/external/vt/status Check the status of VirusTotal data retrieval
ExternalSourcesApi v3GetVirustotalScanOperation GET /v3/operations/virustotal-scan/{binary_id} Get a VirusTotal scan operation.
ExternalSourcesApi v3RunVirustotalScan POST /v3/binaries/{binary_id}/virustotal-scan:run Trigger a VirusTotal lookup for a binary.
FunctionsAiDecompilationApi createAiDecompilation POST /v3/functions/{function_id}/ai-decompilation Start AI decompilation
FunctionsAiDecompilationApi deleteAiDecompilationInlineComment DELETE /v3/functions/{function_id}/ai-decompilation/inline-comments/{line} Delete a single inline comment
FunctionsAiDecompilationApi getAiDecompilation GET /v3/functions/{function_id}/ai-decompilation Get AI decompilation result
FunctionsAiDecompilationApi getAiDecompilationInlineComments GET /v3/functions/{function_id}/ai-decompilation/inline-comments Get AI decompilation inline comments
FunctionsAiDecompilationApi getAiDecompilationInlineCommentsStatus GET /v3/functions/{function_id}/ai-decompilation/inline-comments/status Get inline comments generation workflow status
FunctionsAiDecompilationApi getAiDecompilationRating GET /v2/functions/{function_id}/ai-decompilation/rating Get rating for AI decompilation
FunctionsAiDecompilationApi getAiDecompilationStatus GET /v3/functions/{function_id}/ai-decompilation/status Get AI decompilation workflow status
FunctionsAiDecompilationApi getAiDecompilationSummary GET /v3/functions/{function_id}/ai-decompilation/summary Get AI decompilation summary
FunctionsAiDecompilationApi getAiDecompilationSummaryStatus GET /v3/functions/{function_id}/ai-decompilation/summary/status Get summary generation workflow status
FunctionsAiDecompilationApi patchAiDecompilationInlineComment PATCH /v3/functions/{function_id}/ai-decompilation/inline-comments Update a single inline comment
FunctionsAiDecompilationApi regenerateAiDecompilationInlineComments POST /v3/functions/{function_id}/ai-decompilation/inline-comments Regenerate AI decompilation inline comments
FunctionsAiDecompilationApi regenerateAiDecompilationSummary POST /v3/functions/{function_id}/ai-decompilation/summary Regenerate AI decompilation summary
FunctionsAiDecompilationApi streamAiDecompilation GET /v3/functions/{function_id}/ai-decompilation/events Stream live AI decompilation output (SSE)
FunctionsAiDecompilationApi upsertAiDecompilationRating PATCH /v2/functions/{function_id}/ai-decompilation/rating Upsert rating for AI decompilation
FunctionsAiDecompilationApi v3AcceptAiDecompilationTypeSuggestions POST /v3/functions/{function_id}/ai-decompilation/type-suggestions/accept Accept AI decompilation type suggestions
FunctionsAiDecompilationApi v3GetAiDecompilationLineAttributions GET /v3/functions/{function_id}/ai-decompilation/line-attributions Get AI decompilation line attributions
FunctionsAiDecompilationApi v3GetAiDecompilationRating GET /v3/functions/{function_id}/ai-decompilation/rating Get AI decompilation rating
FunctionsAiDecompilationApi v3GetAiDecompilationTokens GET /v3/functions/{function_id}/ai-decompilation/tokens Get AI decompilation tokens and user overrides
FunctionsAiDecompilationApi v3GetAiDecompilationTypeSuggestions GET /v3/functions/{function_id}/ai-decompilation/type-suggestions Get AI decompilation type suggestions
FunctionsAiDecompilationApi v3GetAiDecompilationTypeSuggestionsStatus GET /v3/functions/{function_id}/ai-decompilation/type-suggestions/status Get type suggestion workflow status
FunctionsAiDecompilationApi v3RegenerateAiDecompilationTypeSuggestions POST /v3/functions/{function_id}/ai-decompilation/type-suggestions Regenerate AI decompilation type suggestions
FunctionsAiDecompilationApi v3UpsertAiDecompilationOverrides PATCH /v3/functions/{function_id}/ai-decompilation/overrides Upsert variable/function name overrides
FunctionsAiDecompilationApi v3UpsertAiDecompilationRating PATCH /v3/functions/{function_id}/ai-decompilation/rating Upsert AI decompilation rating
FunctionsCoreApi addFunctionCallee POST /v3/functions/{function_id}/callees Add a callee to a function
FunctionsCoreApi addUserStringToFunction POST /v3/functions/{function_id}/user-provided-strings Add a user-provided string to a function.
FunctionsCoreApi getAnalysisStrings GET /v2/analyses/{analysis_id}/functions/strings Get string information found in the Analysis
FunctionsCoreApi getAnalysisStringsStatus GET /v2/analyses/{analysis_id}/functions/strings/status Get string processing state for the Analysis
FunctionsCoreApi getFunctionBlocks GET /v2/functions/{function_id}/blocks Get disassembly blocks related to the function
FunctionsCoreApi getFunctionBlocks_0 GET /v3/functions/{function_id}/blocks Get function disassembly
FunctionsCoreApi getFunctionCalleesCallers GET /v2/functions/{function_id}/callees_callers Get list of functions that call or are called by the specified function
FunctionsCoreApi getFunctionCalleesCallersBulk GET /v2/functions/callees_callers Get list of functions that call or are called for a list of functions
FunctionsCoreApi getFunctionCalleesCallers_0 GET /v3/functions/{function_id}/callees-callers Get callees and callers for a function
FunctionsCoreApi getFunctionCapabilities GET /v2/functions/{function_id}/capabilities Retrieve a functions capabilities
FunctionsCoreApi getFunctionCapabilities_0 GET /v3/functions/{function_id}/capabilities Get capabilities for a function
FunctionsCoreApi getFunctionDetails GET /v2/functions/{function_id} Get function details
FunctionsCoreApi getFunctionDetails_0 GET /v3/functions/{function_id} Get function details
FunctionsCoreApi getFunctionIndirectCallSites GET /v3/functions/{function_id}/indirect-call-sites Get indirect call sites for a function
FunctionsCoreApi getFunctionStrings GET /v2/functions/{function_id}/strings Get string information found in the function
FunctionsCoreApi getFunctionStrings_0 GET /v3/functions/{function_id}/strings List strings for a function.
FunctionsCoreApi getFunctionsCalleesCallers GET /v3/functions/callees-callers Get callees and callers for many functions
FunctionsCoreApi getFunctionsMatches GET /v3/functions/matches Get function-matching results for an explicit set of functions
FunctionsCoreApi getFunctionsMatchingStatus GET /v3/functions/matches/status Get function-matching status for an explicit set of functions
FunctionsCoreApi getImportedFunction GET /v3/analyses/{analysis_id}/imported-functions/{imported_function_id} Get an imported function with its callers
FunctionsCoreApi listAnalysisFunctions GET /v3/analyses/{analysis_id}/functions List functions in an analysis
FunctionsCoreApi listImportedFunctions GET /v3/analyses/{analysis_id}/imported-functions List imported functions in an analysis
FunctionsCoreApi startFunctionsMatching POST /v3/functions/matches Start function matching for an explicit set of functions
FunctionsCoreApi v3CanonicalizeFunctionNames POST /v3/functions/canonical-names Canonicalize a batch of function names
FunctionsCoreApi v3GetAnalysisFuncMaps GET /v3/analyses/{analysis_id}/func-maps Get function ID/address maps for an analysis
FunctionsCoreApi v3ListFunctionGlobals GET /v3/functions/{function_id}/globals List the global variables a function references.
FunctionsCoreApi v3SearchFunctions GET /v3/functions Search functions
FunctionsRenamingHistoryApi batchRenameFunction POST /v2/functions/rename/batch Batch Rename Functions
FunctionsRenamingHistoryApi batchRenameFunctions POST /v3/functions/rename Batch rename functions
FunctionsRenamingHistoryApi getFunctionHistory GET /v3/functions/{function_id}/history Get function name history
FunctionsRenamingHistoryApi getFunctionNameHistory GET /v2/functions/history/{function_id} Get Function Name History
FunctionsRenamingHistoryApi renameFunction POST /v3/functions/{function_id}/rename Rename a function
FunctionsRenamingHistoryApi renameFunctionId POST /v2/functions/rename/{function_id} Rename Function
FunctionsRenamingHistoryApi revertFunctionName POST /v2/functions/history/{function_id}/{history_id} Revert the function name
FunctionsRenamingHistoryApi revertFunctionName_0 POST /v3/functions/{function_id}/history/{history_id}/revert Revert function name
IamUsersApi getMe GET /v2/iam/me Get current user
IamUsersApi getMyPermissions GET /v2/iam/me/permissions Get current user permissions
ModelsApi getModels GET /v2/models Gets models
ReportsApi createPdfReport POST /v3/analyses/{analysis_id}/pdf Start PDF report generation
ReportsApi downloadPdfReport GET /v3/analyses/{analysis_id}/pdf Download generated PDF report
ReportsApi getPdfReportStatus GET /v3/analyses/{analysis_id}/pdf/status Get PDF report workflow status
SearchApi searchBinaries GET /v2/search/binaries Binaries search
SearchApi searchCollections GET /v2/search/collections Collections search
SearchApi searchFunctions GET /v2/search/functions Functions search
SearchApi searchTags GET /v2/search/tags Tags search

Documentation for Models

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.