Skip to content
RevEngAI
sdk-go
Public

About

RevEng.AI Go SDK

Resources

Readme
MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository
BranchesTags

Latest commit

 

History

218 Commits

Folders and files

Repository files navigation

RevEng.AI Go SDK

This is the Go 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:

go get github.com/RevEngAI/sdk-go

Usage

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

package main

import (
	"context"
	"fmt"
	"os"

	sdk "github.com/RevEngAI/sdk-go"
)

func main() {
	// Create a new configuration with default settings
	cfg := sdk.NewConfiguration()

	// Create a new API client
	client := sdk.NewAPIClient(cfg)

	// Configure API key authorization via context
	ctx := context.WithValue(context.Background(), sdk.ContextAPIKeys, map[string]sdk.APIKey{
		"APIKey": {Key: os.Getenv("API_KEY")},
	})

	analysisId := int32(715320)

	// Call GetAnalysisLogs on the AnalysesCoreAPI service
	result, httpResp, err := client.AnalysesCoreAPI.GetAnalysisLogs(ctx, analysisId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Exception when calling AnalysesCoreAPI#GetAnalysisLogs\n")
		fmt.Fprintf(os.Stderr, "Status code: %d\n", httpResp.StatusCode)

		// Check if the error is a GenericOpenAPIError for more details
		if apiErr, ok := err.(*sdk.GenericOpenAPIError); ok {
			fmt.Fprintf(os.Stderr, "Reason: %s\n", string(apiErr.Body()))
		}

		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
		os.Exit(1)
	}

	// Unwrap the response: BaseResponseLogs -> Logs (Data) -> string
	if result.HasData() {
		data := result.GetData()
		fmt.Println(data.GetLogs())
	} else {
		fmt.Println("No logs available")
	}
}

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

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

About

RevEng.AI Go SDK

Resources

Readme
MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages