Versions in this module Expand all Collapse all v0 v0.1.1 Aug 14, 2026 Changes in this version type CreateTaskRequest + ObjExtElevatePrompt bool type ReportIncidentEvent + Return string v0.1.0 Aug 6, 2026 Changes in this version + const APIKeyPrefix + const DefaultBaseURL + const DefaultTimeout + type Client struct + func NewClient(authKey string, opts ...Option) *Client + func (c *Client) AddTime(taskUUID string) (*TaskMessageResponse, error) + func (c *Client) DeleteTask(taskUUID string) (*TaskMessageResponse, error) + func (c *Client) DownloadYaraResults(queryID, format string) (*YaraLookupResultsStix, error) + func (c *Client) GetEnvironments() ([]TaskEnvironment, error) + func (c *Client) GetHistory(team bool, skip, limit int) (*TasksHistoryResponse, error) + func (c *Client) GetIOCs(taskUUID string) ([]IOC, error) + func (c *Client) GetReport(taskUUID string) (*ReportResponse, error) + func (c *Client) GetUserLimits() (*UserLimits, error) + func (c *Client) GetUserPresets() ([]UserPreset, error) + func (c *Client) GetYaraResults(queryID string, offset, limit int, sort string) (*YaraSearchResults, error) + func (c *Client) GetYaraResultsCount(queryID string) (*YaraSearchResultsCount, error) + func (c *Client) MonitorTask(taskUUID string, onEvent func(MonitorEvent) error) error + func (c *Client) MonitorTaskStream(taskUUID string) (io.ReadCloser, error) + func (c *Client) SearchThreatIntelligence(req SearchRequest) (*SearchResponse, error) + func (c *Client) StartYaraSearch(rule string) (*YaraJobInfo, error) + func (c *Client) StopTask(taskUUID string) (*TaskMessageResponse, error) + func (c *Client) StopYaraSearch(queryID string) (*YaraJobInfo, error) + func (c *Client) SubmitTask(req *CreateTaskRequest) (*TaskSubmission, error) + func (c *Client) TaxiiDiscovery() (*TaxiiDiscovery, error) + func (c *Client) TaxiiGetAPIRoot() (*TaxiiAPIRoot, error) + func (c *Client) TaxiiGetCollection(collectionID string) (*TaxiiCollection, error) + func (c *Client) TaxiiGetCollections() (*TaxiiCollections, error) + func (c *Client) TaxiiGetManifest(collectionID string, params TaxiiManifestParams) (*TaxiiManifest, *TaxiiPageInfo, error) + func (c *Client) TaxiiGetObject(collectionID, objectID string) (*TaxiiEnvelope, *TaxiiPageInfo, error) + func (c *Client) TaxiiGetObjects(collectionID string, params TaxiiObjectsParams) (*TaxiiEnvelope, *TaxiiPageInfo, error) + type CountryCount struct + Count float64 + CountryName string + type CreateTaskRequest struct + AutoConfirmUAC *bool + EnvBitness int + EnvLocale string + EnvOS string + EnvType string + EnvVersion string + File io.Reader + FileName string + ObjExtBrowser string + ObjExtCmd string + ObjExtExtension bool + ObjExtStartFolder string + ObjExtUseragent string + ObjForceElevation bool + ObjType string + ObjURL string + OptAutoDeleteAfter string + OptAutomatedInteractivity *bool + OptNetworkConnect *bool + OptNetworkFakenet bool + OptNetworkGeo string + OptNetworkMitm bool + OptNetworkResidentialProxy bool + OptNetworkResidentialProxyGeo string + OptNetworkTor bool + OptPrivacyHideSource bool + OptPrivacyType string + OptTimeout int + RunAsRoot bool + TaskRerunUUID string + UserTags string + func NewCreateTaskRequest() *CreateTaskRequest + type DestinationIP struct + Date string + DestinationIP string + IsMalconf bool + ThreatLevel float64 + ThreatName []string + type DestinationIPASN struct + ASN string + Date string + type Event struct + CommandLine string + DestinationIP string + DestinationIPASN []string + DestinationIPGeo []string + DestinationPort []string + DomainName []string + FileName string + HTTPRequestContentFile string + HTTPRequestContentType string + HTTPResponseContentFile string + HTTPResponseContentType string + ImagePath string + InjectedFlag bool + ModuleImagePath string + PID float64 + RegistryKey string + RegistryName []string + RegistryValue []string + RuleName string + RuleThreatLevel string + SHA256 string + Title []string + URL string + type EventsCounters struct + Raw EventsCountersRaw + type EventsCountersRaw struct + Files float64 + Modules float64 + Objects float64 + RPC float64 + Registry float64 + type GetYaraResultsParams struct + Limit int + Offset int + Sort string + type HTTPError struct + Body string + StatusCode int + func (e *HTTPError) Error() string + type Hashes struct + MD5 string + SHA1 string + SHA256 string + SSDeep string + type HistoryParams struct + Limit int + Skip int + Team bool + type IOC struct + Category string + DiscoveringEntryID string + IOC string + Name string + Reputation int + Type string + type Industry struct + Confidence float64 + IndustryName string + type MainObject struct + Hashes Hashes + Name string + Type string + type MatchedSample struct + DiscoveringEntryID string + Download string + FileExt string + FileFullName string + FilePartName string + FileSize int64 + FirstSeen string + Hashes MatchedSampleHashes + LastSeen string + Process *YaraProcessInfo + RelatedTags []string + Task string + TaskUUID string + Tasks []string + type MatchedSampleHashes struct + MD5 string + SHA1 string + SHA256 string + SSDeep string + type MonitorEvent struct + Completed bool + Error bool + Message string + Task *TaskStatus + type ObjectTrid struct + Extension string + Filetype string + Procent float64 + type Option func(*Client) + func WithBaseURL(baseURL string) Option + func WithHTTPClient(c *http.Client) Option + type ParallelsLimit struct + Available int + Total int + type Process struct + CommandLine string + EventsCounters EventsCounters + ImagePath string + MITRE []string + PID float64 + Scores ProcessScores + ThreatLevel float64 + ThreatName string + type ProcessDump struct + Address string + FileNumber int + PID int + PermanentURL string + ProcessName string + Size int + TaskUUID string + Timestamp int64 + type ProcessScores struct + Specs ProcessScoresSpecs + type ProcessScoresSpecs struct + Autostart bool + CrashedApps bool + DebugOutput bool + ExecutableDropped bool + Exploitable bool + Injects bool + KnownThreat bool + LowAccess bool + MalwareConfig bool + Multiprocessing bool + Network bool + NetworkLoader bool + ProcessDump bool + ServiceLuncher bool + Spam bool + StaticDetections bool + Stealing bool + SuspStruct bool + Tor bool + UACRequest bool + type RelatedDNS struct + Date string + DomainName string + IsMalconf bool + ThreatLevel float64 + ThreatName []string + type RelatedFile struct + FileExtension string + FileLink string + FileName string + Hashes Hashes + Process Process + Task string + Time string + Title string + type RelatedIncident struct + Event Event + MITRE []string + Process Process + Task string + ThreatName []string + Time string + type RelatedNetworkThreat struct + ImagePath string + MITRE []string + SuricataClass string + SuricataID string + SuricataMessage string + SuricataThreatLevel string + Tags []string + Task string + type RelatedSynchronizationObject struct + Process Process + SyncObjectName string + SyncObjectOperation string + SyncObjectTime string + SyncObjectType string + Task string + type RelatedURL struct + Date string + IsMalconf bool + ThreatLevel float64 + ThreatName []string + URL string + type ReportArtifact struct + PermanentURL string + Present bool + type ReportAutomatization struct + Interactivity bool + UAC bool + type ReportConnection struct + ASN string + Country string + IP string + Port int + Process string + Protocol string + Reputation string + TLSFingerprint ReportTLSFingerprint + Time string + type ReportContent struct + Dumps []ProcessDump + MainObject ReportMainObject + PCAP ReportArtifact + SSLKeys ReportArtifact + Screenshots []Screenshot + Video ReportArtifact + type ReportCounterFiles struct + Malicious int + Suspicious int + Text int + Unknown int + type ReportCounterNetwork struct + Connections int + DNS int + HTTP int + Threats int + type ReportCounterProcesses struct + Malicious int + Monitored int + Suspicious int + Total int + type ReportCounterRegistry struct + Delete int + Read int + Total int + Write int + type ReportCounterSync struct + Operation ReportCounterSyncOp + Total int + Type ReportCounterSyncType + type ReportCounterSyncOp struct + Create int + Open int + type ReportCounterSyncType struct + Event int + Mutex int + type ReportCounters struct + Files ReportCounterFiles + Network ReportCounterNetwork + Processes ReportCounterProcesses + Registry ReportCounterRegistry + Synchronization ReportCounterSync + type ReportDNSRequest struct + Domain string + IPs []string + Reputation string + ReputationNumber int + Time int64 + type ReportDebugString struct + Message string + Process string + Time int64 + type ReportEnvironment struct + Hotfixes []ReportHotfix + InternetExplorer ReportEnvironmentIE + OS ReportEnvironmentOS + Software []ReportSoftware + type ReportEnvironmentIE struct + Kbnum string + Version string + type ReportEnvironmentOS struct + Bitness int + Build int + Major string + Product string + ProductType string + ServicePack string + SoftSet string + Title string + Variant string + type ReportEnvironments []ReportEnvironment + func (re *ReportEnvironments) UnmarshalJSON(b []byte) error + type ReportHTTPBody struct + Request ReportHTTPMessage + Response ReportHTTPMessage + type ReportHTTPMessage struct + Hashes Hashes + PermanentURL string + Size int64 + ThreatLevel string + Type string + type ReportHTTPRequest struct + Body ReportHTTPBody + Country string + HTTPCode int + Host string + IP string + Method string + Port int + Process string + ProxyDetected bool + Reputation string + Status string + Time int64 + URL string + UserAgent string + type ReportHotfix struct + Title string + type ReportIncident struct + Count int + Desc string + Events []ReportIncidentEvent + FirstSeen int64 + Mitre []ReportIncidentMitre + Process string + Source string + ThreatLevel int + Title string + type ReportIncidentEvent struct + Access string + Address string + CmdChild string + CmdParent string + Cmdline string + ContentType string + Created string + Device string + EventID string + Filename string + Host string + ID string + IP string + IPDst string + IPDstPacket string + IPSrc string + IPSrcPacket string + Image string + IsWhiteListed bool + Key string + MD5 string + Method string + Name string + Newname string + Object string + Operation string + Port any + PortDst any + PortSrc any + Process string + Protect string + Protocol string + Proxy bool + Request string + SHA1 string + SHA256 string + SID string + Size string + Status string + Time any + TotalBytes string + Transport string + Type string + TypeValue string + URL string + Value string + type ReportIncidentMitre struct + SID int + TID int + V int + type ReportLinks struct + Graph string + HTML string + IOC string + MISP string + STIX string + type ReportMainObject struct + Basename string + Filename string + Hashes Hashes + Info ReportMainObjectInfo + PermanentURL string + Type string + URL string + type ReportMainObjectInfo struct + Exif map[string]map[string]any + Ext string + File string + Mime string + Trid []ObjectTrid + type ReportMalconf struct + Config ReportMalconfConfig + Family string + ProcessPID int + ProcessTime int64 + type ReportMalconfConfig struct + C2 string + Keys map[string]any + Options map[string]any + Strings []string + type ReportMitre struct + ID string + Name string + Phases []string + type ReportModified struct + Files []ReportModifiedFile + Registry []ReportModifiedRegistry + type ReportModifiedFile struct + Filename string + Hashes Hashes + Info ReportModifiedFileInfo + PermanentURL string + Process string + Size int64 + ThreatLevel string + Time int64 + Type string + type ReportModifiedFileInfo struct + File string + Mime string + type ReportModifiedRegistry struct + Key string + Name string + Operation string + Process string + Time int64 + Value string + type ReportNetwork struct + Connections []ReportConnection + DNSRequests []ReportDNSRequest + HTTPRequests []ReportHTTPRequest + Threats []ReportThreat + type ReportOptions struct + AdditionalTime int + Automatization ReportAutomatization + FakeNet bool + HeavyEvasion bool + HideSource bool + MITM bool + Network bool + Presentation bool + Privacy string + PrivateSample bool + Timeout int + Tor ReportTor + Video bool + type ReportProcess struct + Cert ReportProcessCert + CommandLine string + Context ReportProcessContext + ExitCode int64 + FileName string + FileType string + HasMalwareConfig bool + Image string + Important bool + MainProcess bool + Modules []ReportProcessModule + PID int + PPID int + ParentUUID string + ResolvedCOM ReportProcessResolvedCOM + Scores ReportProcessScores + Status string + Synchronization []ReportProcessSyncObject + ThreatName string + Times ReportProcessTimes + UUID string + VersionInfo ReportProcessVersionInfo + type ReportProcessCert struct + ContentHash string + SN string + Status int + Thumbprint string + type ReportProcessContext struct + IntegrityLevel string + RebootNumber int + UserName string + type ReportProcessModule struct + Image string + Time int64 + type ReportProcessResolvedCOM struct + Module ReportProcessResolvedCOMModule + Title string + type ReportProcessResolvedCOMModule struct + FileName string + FullPath string + type ReportProcessScores struct + Dropped bool + Injected bool + LoadsSusp bool + MonitoringReason string + Specs ReportProcessSpecs + Verdict ReportVerdict + type ReportProcessSpecs struct + AutoStart bool + CrashedApps bool + DebugOutput bool + ExecutableDropped bool + Exploitable bool + Injects bool + KnownThreat bool + LowAccess bool + MalwareConfig bool + Network bool + NetworkLoader bool + PrivEscalation bool + Stealing bool + type ReportProcessSyncObject struct + Name string + Operation string + Time int64 + Type string + type ReportProcessTimes struct + MonitoringSince int64 + Start int64 + Terminate int64 + type ReportProcessVersionInfo struct + Company string + Description string + Version string + type ReportResponse struct + Data TaskReport + Error bool + type ReportSandbox struct + Name string + Plan ReportSandboxPlan + type ReportSandboxPlan struct + Name string + type ReportScores struct + Specs ReportSpecs + Verdict ReportVerdict + type ReportSoftware struct + Title string + Version string + type ReportSpecs struct + AutoStart bool + CPUOverrun bool + CrashedApps bool + CrashedTask bool + DebugOutput bool + ExecutableDropped bool + Exploitable bool + Injects bool + KnownThreat bool + LowAccess bool + MalwareConfig bool + MemOverrun bool + Multiprocessing bool + NetworkLoader bool + NetworkThreats bool + NotStarted bool + PrivEscalation bool + Rebooted bool + ServiceLauncher bool + Spam bool + StaticDetections bool + Stealing bool + SuspStruct bool + TorUsed bool + type ReportTLSFingerprint struct + JA3 string + JA3Fullstring string + JA3S string + JA3SFullstring string + JARM string + type ReportThreat struct + Class string + DstIP string + DstPort int + Msg string + Priority int + Pro int + Process string + SID int + SrcIP string + SrcPort int + Time string + type ReportTor struct + Geo string + Used bool + type ReportVerdict struct + Score float64 + ThreatLevel float64 + ThreatLevelText string + type Screenshot struct + PermanentURL string + ThumbnailURL string + Time int + UUID string + type SearchRequest struct + EndDate string + Query string + StartDate string + type SearchResponse struct + DestinationIP []DestinationIP + DestinationIPASN []DestinationIPASN + DestinationIPGeo []string + DestinationPort []float64 + Industries []Industry + RelatedDNS []RelatedDNS + RelatedFiles []RelatedFile + RelatedIncidents []RelatedIncident + RelatedNetworkThreats []RelatedNetworkThreat + RelatedSynchronizationObjects []RelatedSynchronizationObject + RelatedTasks []string + RelatedURLs []RelatedURL + SourceTasks []SourceTask + SubmissionCountries []CountryCount + Summary Summary + ThreatName []ThreatNameCount + TotalDestinationIP float64 + TotalDestinationIPASN float64 + TotalDestinationIPGeo float64 + TotalDestinationPort float64 + TotalNetworkThreats float64 + TotalRelatedDNSs float64 + TotalRelatedFiles float64 + TotalRelatedIncidents float64 + TotalRelatedSynchronizationObjects float64 + TotalRelatedURLs float64 + TotalTasks float64 + type SourceTask struct + Date string + MainObject MainObject + Related string + Tags []string + ThreatLevel float64 + UUID string + type Summary struct + Details []SummaryDetails + DetectedType string + IsTrial bool + LastSeen string + Tags []string + ThreatLevel float64 + type SummaryDetails struct + Count float64 + LastSeen string + ThreatLevel float64 + Type string + type Tag struct + Users bool + Value string + func (t *Tag) UnmarshalJSON(b []byte) error + type Tags []Tag + type TaskEnvSoftware struct + Name string + Version string + type TaskEnvironment struct + Bitness int + Build int + OS string + Software TaskEnvironmentSoft + Type string + Variant string + Version string + type TaskEnvironmentIE struct + Version string + type TaskEnvironmentSoft struct + Apps []TaskEnvSoftware + IE TaskEnvironmentIE + Upps []string + type TaskHistory struct + Date string + File string + Hashes Hashes + JSON string + MISP string + Name string + PCAP string + Related string + Tags Tags + UUID string + Verdict string + type TaskMessageResponse struct + Error bool + Message string + type TaskReport struct + Analysis TaskReportAnalysis + Counters ReportCounters + DebugStrings []ReportDebugString + Environments ReportEnvironments + Incidents []ReportIncident + Malconf []ReportMalconf + Mitre []ReportMitre + Modified ReportModified + Network ReportNetwork + Processes []ReportProcess + Status string + type TaskReportAnalysis struct + Content ReportContent + Creation int64 + CreationText string + Duration int + Options ReportOptions + PermanentURL string + Reports ReportLinks + Sandbox ReportSandbox + Scores ReportScores + StopExec int64 + StopExecText string + Tags Tags + UUID string + type TaskStatus struct + Actions TaskStatusActions + ID string + Public TaskStatusPublic + Remaining int + Scores TaskStatusScores + Status int + Tags Tags + Threats []string + Times TaskStatusTimes + UUID string + UsersTags Tags + type TaskStatusActions struct + ManualClosed bool + type TaskStatusEnvironment struct + OS TaskStatusEnvironmentOS + type TaskStatusEnvironmentOS struct + Bitness string + Build int + ElPrompt bool + Full string + Major string + Product string + ProductType string + SP string + Type string + Variant string + type TaskStatusMainObject struct + Hashes Hashes + Names TaskStatusMainObjectNames + type TaskStatusMainObjectNames struct + Basename string + Location string + NeedRename bool + Real string + URL string + type TaskStatusObjects struct + MainObject TaskStatusMainObject + RunType string + type TaskStatusOptions struct + Autoclicker bool + AutoclickerDebugMode bool + ChatGPT bool + Fakenet bool + Locale string + Logger string + MITM bool + NetConnected bool + Netviator bool + Network string + Onlyimportant bool + OpenVPN string + Presentation bool + Private string + Reboots bool + ResidentialProxy bool + ResidentialProxyGeo string + Teamwork bool + TorGeo string + Video bool + Whitelist []string + type TaskStatusPublic struct + Environment TaskStatusEnvironment + MaxAddedTimeReached bool + Objects TaskStatusObjects + Options TaskStatusOptions + type TaskStatusScores struct + Specs TaskStatusSpecs + Verdict TaskStatusVerdict + type TaskStatusSpecs struct + Autostart bool + BadModuleCert bool + BadProcessCert bool + CPUOverrun bool + CrashedApps bool + CrashedTask bool + DebugOutput bool + ExecutableDropped bool + Exploitable bool + HasTrace bool + Injects bool + KnownThreat bool + LowAccess bool + MalwareConfig bool + MemOverrun bool + Multiprocessing bool + NetworkLoader bool + NetworkThreats bool + NotStarted bool + ProcessDump bool + Reboot bool + ServiceLuncher bool + Spam bool + StaticDetections bool + Stealing bool + SuspStruct bool + Tor bool + UACRequest bool + type TaskStatusTimes struct + StartExec string + Timeout int + type TaskStatusVerdict struct + Text string + ThreatLevel float64 + type TaskSubmission struct + Error bool + Message string + QueueTaskID string + TaskID string + func (s *TaskSubmission) Queued() bool + func (s *TaskSubmission) UnmarshalJSON(b []byte) error + type TasksHistoryResponse struct + Data struct{ ... } + Error bool + type TaxiiAPIRoot struct + Description string + MaxContentLength int64 + Title string + Versions []string + type TaxiiCollection struct + CanRead bool + CanWrite bool + Description string + ID string + MediaTypes []string + Title string + type TaxiiCollections struct + Collections []TaxiiCollection + type TaxiiDiscovery struct + APIRoots []string + Contact string + Default string + Description string + Title string + type TaxiiEnvelope struct + ID string + More bool + Next string + Objects []json.RawMessage + SpecVersion string + Type string + type TaxiiManifest struct + ID string + More bool + Next string + Objects []TaxiiManifestEntry + SpecVersion string + Type string + type TaxiiManifestEntry struct + DateAdded string + ID string + MediaType string + Version string + type TaxiiManifestParams struct + AddedAfter string + Limit int + MatchID string + MatchVersion string + ModifiedAfter string + Next string + type TaxiiObjectsParams struct + AddedAfter string + Limit int + MatchID string + MatchSpecVersion string + MatchType string + MatchVersion string + ModifiedAfter string + Next string + type TaxiiPageInfo struct + DateAddedFirst string + DateAddedLast string + DateModifiedFirst string + DateModifiedLast string + type ThreatNameCount struct + Count float64 + ThreatName string + type UserLimitWindow struct + Day int + Hour int + Minute int + Month int + type UserLimits struct + API UserLimitWindow + Parallels ParallelsLimit + Web UserLimitWindow + type UserPreset struct + Autoclicker bool + Bitness int + Browser string + ChatGPT bool + CreateTime string + EL bool + ExpirationTime string + ExpirationTimeSelected bool + Extension bool + Fakenet bool + HideSource bool + ID string + Is64Bit bool + Locale string + Location string + MITM bool + Name string + NetConnected bool + Netviator bool + Network string + NoControls bool + OS string + OpenVPN string + Privacy string + ResidentialProxy bool + ResidentialProxyGeo string + Timeout int + TorGeo string + Type string + UserID string + UserPlanName string + VPN bool + Version string + type YaraJobInfo struct + Created string + NormalizedQueryHash string + Progress float64 + Query string + QueryID string + RuleName string + Status string + TimesLeft float64 + type YaraLookupResultsStix struct + Data YaraStixBundle + Status string + type YaraProcessInfo struct + Cmd string + EventsCounters EventsCounters + Image string + PID int + ProcessOID string + ProcessScoresSpecs ProcessScoresSpecs + ThreatName string + ThreatScore float64 + type YaraSearchRequest struct + Query string + type YaraSearchResults struct + Matches []MatchedSample + SearchInfo YaraJobInfo + type YaraSearchResultsCount struct + FoundMatches int64 + SearchInfo YaraJobInfo + type YaraStixBundle struct + ID string + Objects []YaraStixFile + Type string + type YaraStixFile struct + ExternalReferences []YaraStixReference + Hashes map[string]string + ID string + Type string + type YaraStixReference struct + SourceName string + URL string
Go to main page