Skip to content

ExternalSourcesAPI.md

Latest commit

 

History

History
215 lines (139 loc) · 5.57 KB

ExternalSourcesAPI.md

File metadata and controls

215 lines (139 loc) · 5.57 KB

ExternalSourcesAPI

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

Method HTTP request Description
CreateExternalTaskVt Post /v2/analysis/{analysis_id}/external/vt Pulls data from VirusTotal
GetVtData Get /v2/analysis/{analysis_id}/external/vt Get VirusTotal data
GetVtTaskStatus Get /v2/analysis/{analysis_id}/external/vt/status Check the status of VirusTotal data retrieval

CreateExternalTaskVt

BaseResponseStr CreateExternalTaskVt(ctx, analysisId).Execute()

Pulls data from VirusTotal

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {
	analysisId := int32(56) // int32 | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.ExternalSourcesAPI.CreateExternalTaskVt(context.Background(), analysisId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ExternalSourcesAPI.CreateExternalTaskVt``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateExternalTaskVt`: BaseResponseStr
	fmt.Fprintf(os.Stdout, "Response from `ExternalSourcesAPI.CreateExternalTaskVt`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
analysisId int32

Other Parameters

Other parameters are passed through a pointer to a apiCreateExternalTaskVtRequest struct via the builder pattern

Name Type Description Notes

Return type

BaseResponseStr

Authorization

APIKey

HTTP request headers

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

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

GetVtData

BaseResponseExternalResponse GetVtData(ctx, analysisId).Execute()

Get VirusTotal data

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {
	analysisId := int32(56) // int32 | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.ExternalSourcesAPI.GetVtData(context.Background(), analysisId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ExternalSourcesAPI.GetVtData``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVtData`: BaseResponseExternalResponse
	fmt.Fprintf(os.Stdout, "Response from `ExternalSourcesAPI.GetVtData`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
analysisId int32

Other Parameters

Other parameters are passed through a pointer to a apiGetVtDataRequest struct via the builder pattern

Name Type Description Notes

Return type

BaseResponseExternalResponse

Authorization

APIKey

HTTP request headers

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

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

GetVtTaskStatus

BaseResponseTaskResponse GetVtTaskStatus(ctx, analysisId).Execute()

Check the status of VirusTotal data retrieval

Example

package main

import (
	"context"
	"fmt"
	"os"
	revengai "github.com/RevEngAI/sdk-go/v3"
)

func main() {
	analysisId := int32(56) // int32 | 

	configuration := revengai.NewConfiguration()
	apiClient := revengai.NewAPIClient(configuration)
	resp, r, err := apiClient.ExternalSourcesAPI.GetVtTaskStatus(context.Background(), analysisId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ExternalSourcesAPI.GetVtTaskStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetVtTaskStatus`: BaseResponseTaskResponse
	fmt.Fprintf(os.Stdout, "Response from `ExternalSourcesAPI.GetVtTaskStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
analysisId int32

Other Parameters

Other parameters are passed through a pointer to a apiGetVtTaskStatusRequest struct via the builder pattern

Name Type Description Notes

Return type

BaseResponseTaskResponse

Authorization

APIKey

HTTP request headers

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

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