api

package

Go to main page

Versions in this module

v0

v0.0.6

Feb 3, 2026

v0.0.5

Jan 30, 2026

Changes in this version

+ func GetLast7Days(t time.Time) (days []string)

+ func GetToday() time.Time

type Client

+ func (c *Client) BulkGetDataDumpList(path string) (*DataDumpList, error)

+ func (c *Client) GetDataDumpList(path string) (*DataDumpList, error)

+ func (c *Client) SetDisableCompression(disable bool) *Client

+ type DataDumpFile struct

+ Path string

+ Size int64

+ Timestamp string

+ type DataDumpList struct

+ Files []DataDumpFile

+ Raw json.RawMessage

+ func (r *DataDumpList) PrettyJSON() string

+ func (r *DataDumpList) UnmarshalJSON(data []byte) error

type IteratorOption

+ func IteratorCollapse(collapse string) IteratorOption

v0.0.4

Sep 23, 2025

Changes in this version

+ type ChannelOption func(*ChannelOptions)

+ func WithChannelEmailAddresses(emailAddresses []string) ChannelOption

+ func WithChannelFrequency(frequency string) ChannelOption

+ func WithChannelIgnoreTime(ignoreTime bool) ChannelOption

+ func WithChannelIsActive(isActive bool) ChannelOption

+ func WithChannelIsDefault(isDefault bool) ChannelOption

+ func WithChannelName(name string) ChannelOption

+ func WithChannelPermissions(permissions []string) ChannelOption

+ func WithChannelType(channelType string) ChannelOption

+ func WithChannelUTCTime(utcTime string) ChannelOption

+ func WithChannelWebhookURL(webhookURL string) ChannelOption

+ func WithChannelWeekDays(weekDays []string) ChannelOption

+ type ChannelOptions struct

+ Channel struct{ ... }

type Client

+ func (c *Client) CreateChannel(opts ...ChannelOption) (*Response, error)

+ func (c *Client) UpdateChannel(id string, opts ...ChannelOption) (*Response, error)

v0.0.3

Sep 4, 2025

v0.0.2

Aug 27, 2025

v0.0.1

Aug 22, 2025

Changes in this version

+ const MaxTotal

+ func BatchResultToRaw(r mo.Result[*Response]) *json.RawMessage

+ func Batch[T any](c *Client, tasks []BatchTask[T], opts ...BatchOption) ([]mo.Result[T], error)

+ func PrefixedPath(path string) string

+ func SetHost(host string)

+ type BatchOption func(*BatchOptions)

+ func WithBatchMaxConcurrency(max int) BatchOption

+ func WithBatchTimeout(timeout int) BatchOption

+ type BatchOptions struct

+ MaxConcurrency int

+ Timeout int

+ type BatchTask func(c *Client, ctx context.Context) mo.Result[T]

+ type Client struct

+ APIKey string

+ Agent string

+ BaseURL *url.URL

+ Err error

+ func NewClient(APIKey string) *Client

+ func (c *Client) CreateIncident(opts ...IncidentOption) (*Response, error)

+ func (c *Client) CreateSavedSearch(opts ...SavedSearchOption) (*Response, error)

+ func (c *Client) CreateSubscription(opts ...SubscriptionOption) (*Response, error)

+ func (c *Client) Do(r *Request) (resp *Response, err error)

+ func (c *Client) Download(path, output string) (int64, error)

+ func (c *Client) GetResult(uuid string) (*Response, error)

+ func (c *Client) IterateHostname(hostname string, opts ...HostnameIteratorOption) (*HostnameIterator, error)

+ func (c *Client) NewBatchScanTask(url string, opts ...ScanOption) BatchTask[*Response]

+ func (c *Client) NewBatchScanWithWaitTask(url string, maxWait int, opts ...ScanOption) BatchTask[*Response]

+ func (c *Client) NewRequest() *Request

+ func (c *Client) NewScanRequest(url string, opts ...ScanOption) *Request

+ func (c *Client) Scan(url string, options ...ScanOption) (*ScanResult, error)

+ func (c *Client) Search(q string, options ...IteratorOption) (*Iterator, error)

+ func (c *Client) SetAPIKey(key string) *Client

+ func (c *Client) SetAgent(agent string) *Client

+ func (c *Client) SetBaseURL(url *url.URL) *Client

+ func (c *Client) SetRetryTransport() *Client

+ func (c *Client) SetTransport(transport http.RoundTripper) *Client

+ func (c *Client) StoreLiveScanResult(scannerId string, scanId string, opts ...LiveScanStoreOption) (*Response, error)

+ func (c *Client) StructureSearch(uuid string, options ...IteratorOption) (*Iterator, error)

+ func (c *Client) TriggerLiveScan(id string, opts ...LiveScanOption) (*Response, error)

+ func (c *Client) TriggerNonBlockingLiveScan(id string, opts ...LiveScanOption) (*Response, error)

+ func (c *Client) URL(path string) (*url.URL, error)

+ func (c *Client) UpdateIncident(id string, opts ...IncidentOption) (*Response, error)

+ func (c *Client) UpdateSavedSearch(opts ...SavedSearchOption) (*Response, error)

+ func (c *Client) UpdateSubscription(opts ...SubscriptionOption) (*Response, error)

+ func (c *Client) WaitAndGetResult(ctx context.Context, uuid string, maxWait int) (*Response, error)

+ type GetContentFn func() (io.ReadCloser, error)

+ type HostnameIterator struct

+ HasMore bool

+ PageState string

+ func (it *HostnameIterator) Iterate() iter.Seq2[*json.RawMessage, error]

+ type HostnameIteratorOption func(*HostnameIterator) error

+ func HostnameIteratorAll(all bool) HostnameIteratorOption

+ func HostnameIteratorLimit(limit int) HostnameIteratorOption

+ func HostnameIteratorPageState(pageState string) HostnameIteratorOption

+ func HostnameIteratorSize(size int) HostnameIteratorOption

+ type HostnameResults struct

+ Item string

+ PageState string

+ Raw json.RawMessage

+ Results []json.RawMessage

+ func (r *HostnameResults) UnmarshalJSON(data []byte) error

+ type IncidentOption func(*IncidentOptions)

+ func WithIncidentChannels(channels []string) IncidentOption

+ func WithIncidentCountries(countries []string) IncidentOption

+ func WithIncidentCountriesPerInterval(countriesPerInterval int) IncidentOption

+ func WithIncidentExpireAfter(expireAfter int) IncidentOption

+ func WithIncidentExpireAt(expireAt string) IncidentOption

+ func WithIncidentObservable(observable string) IncidentOption

+ func WithIncidentProfile(incidentProfile string) IncidentOption

+ func WithIncidentScanInterval(scanInterval int) IncidentOption

+ func WithIncidentScanIntervalAfterMalicious(scanIntervalAfterMalicious int) IncidentOption

+ func WithIncidentScanIntervalAfterSuspended(scanIntervalAfterSuspended int) IncidentOption

+ func WithIncidentScanIntervalMode(scanIntervalMode string) IncidentOption

+ func WithIncidentStopDelayInactive(stopDelayInactive int) IncidentOption

+ func WithIncidentStopDelayMalicious(stopDelayMalicious int) IncidentOption

+ func WithIncidentStopDelaySuspended(stopDelaySuspended int) IncidentOption

+ func WithIncidentUserAgents(userAgents []string) IncidentOption

+ func WithIncidentUserAgentsPerInterval(userAgentsPerInterval int) IncidentOption

+ func WithIncidentVisibility(visibility string) IncidentOption

+ func WithIncidentWatchedAttributes(watchedAttributes []string) IncidentOption

+ type IncidentOptions struct

+ Incident struct{ ... }

+ type Iterator struct

+ HasMore bool

+ Total int

+ func (it *Iterator) Iterate() iter.Seq2[*SearchResult, error]

+ type IteratorOption func(*Iterator) error

+ func IteratorAll(all bool) IteratorOption

+ func IteratorDatasource(datasource string) IteratorOption

+ func IteratorLimit(n int) IteratorOption

+ func IteratorQuery(q string) IteratorOption

+ func IteratorSearchAfter(searchAfter string) IteratorOption

+ func IteratorSize(n int) IteratorOption

+ type JSONError struct

+ Description string

+ Message string

+ Raw json.RawMessage

+ Status int

+ func (e JSONError) Error() string

+ func (r *JSONError) UnmarshalJSON(data []byte) error

+ type LiveScanOption func(*LiveScanOptions)

+ func WithLiveScanScannerCaptureDelay(delay int) LiveScanOption

+ func WithLiveScanScannerDisableFeatures(features []string) LiveScanOption

+ func WithLiveScanScannerEnableFeatures(features []string) LiveScanOption

+ func WithLiveScanScannerExtraHeaders(headers map[string]string) LiveScanOption

+ func WithLiveScanScannerPageTimeout(timeout int) LiveScanOption

+ func WithLiveScanTaskURL(url string) LiveScanOption

+ func WithLiveScanTaskVisibility(visibility string) LiveScanOption

+ type LiveScanOptions struct

+ Scanner struct{ ... }

+ Task struct{ ... }

+ type LiveScanStoreOption func(*LiveScanStoreOptions)

+ func WithLiveScanStoreTaskVisibility(visibility string) LiveScanStoreOption

+ type LiveScanStoreOptions struct

+ Task struct{ ... }

+ type Request struct

+ Body []byte

+ GetBody GetContentFn

+ Headers http.Header

+ Method string

+ Path string

+ QueryParams map[string]string

+ RawRequest *http.Request

+ func (r *Request) Delete(path string) (*Response, error)

+ func (r *Request) Do() (resp *Response, err error)

+ func (r *Request) Get(path string) (*Response, error)

+ func (r *Request) Post(path string) (*Response, error)

+ func (r *Request) Put(path string) (*Response, error)

+ func (r *Request) Send(method, path string) (*Response, error)

+ func (r *Request) SetBodyBytes(body []byte) *Request

+ func (r *Request) SetBodyJSONBytes(body []byte) *Request

+ func (r *Request) SetBodyString(body string) *Request

+ func (r *Request) SetContentType(contentType string) *Request

+ func (r *Request) SetContext(ctx context.Context) *Request

+ func (r *Request) SetHeader(key, value string) *Request

+ func (r *Request) SetHeaders(headers map[string]string) *Request

+ func (r *Request) SetMethod(method string) *Request

+ func (r *Request) SetPath(path string) *Request

+ func (r *Request) SetQueryParam(key, value string) *Request

+ func (r *Request) SetQueryParams(params map[string]string) *Request

+ type Response struct

+ Request *Request

+ func (r *Response) Error() error

+ func (r *Response) GetContentType() string

+ func (r *Response) IsError() bool

+ func (r *Response) IsSuccess() bool

+ func (r *Response) PrettyJSON() string

+ func (r *Response) ToBytes() (body []byte, err error)

+ func (r *Response) ToJSON() (*json.RawMessage, error)

+ func (r *Response) ToString() (string, error)

+ func (r *Response) Unmarshal(v any) error

+ type RetryTransport struct

+ Transport http.RoundTripper

+ func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type SavedSearchOption func(*SavedSearchOptions)

+ func WithSavedSearchDatasource(datasource string) SavedSearchOption

+ func WithSavedSearchDescription(description string) SavedSearchOption

+ func WithSavedSearchID(id string) SavedSearchOption

+ func WithSavedSearchLongDescription(longDescription string) SavedSearchOption

+ func WithSavedSearchName(name string) SavedSearchOption

+ func WithSavedSearchOwnerDescription(ownerDescription string) SavedSearchOption

+ func WithSavedSearchPass(pass int) SavedSearchOption

+ func WithSavedSearchPermissions(permissions []string) SavedSearchOption

+ func WithSavedSearchQuery(query string) SavedSearchOption

+ func WithSavedSearchTLP(tlp string) SavedSearchOption

+ func WithSavedSearchTags(tags []string) SavedSearchOption

+ func WithSavedSearchUserTags(userTags []string) SavedSearchOption

+ type SavedSearchOptions struct

+ Search struct{ ... }

+ type ScanOption func(*ScanOptions)

+ func WithScanCountry(country string) ScanOption

+ func WithScanCustomAgent(customAgent string) ScanOption

+ func WithScanOverrideSafety(overrideSafety string) ScanOption

+ func WithScanReferer(referer string) ScanOption

+ func WithScanTags(tags []string) ScanOption

+ func WithScanVisibility(visibility string) ScanOption

+ type ScanOptions struct

+ Country *string

+ CustomAgent *string

+ OverrideSafety *string

+ Referer *string

+ Tags *[]string

+ URL string

+ Visibility *string

+ type ScanResult struct

+ Raw json.RawMessage

+ UUID string

+ func (r *ScanResult) PrettyJSON() string

+ func (r *ScanResult) UnmarshalJSON(data []byte) error

+ type SearchResult struct

+ Raw json.RawMessage

+ Sort []any

+ func (r *SearchResult) UnmarshalJSON(data []byte) error

+ type SearchResults struct

+ HasMore bool

+ Raw json.RawMessage

+ Results []SearchResult

+ Total int

+ func (r *SearchResults) UnmarshalJSON(data []byte) error

+ type SubscriptionOption func(*SubscriptionOptions)

+ func WithSubscriptionDescription(description string) SubscriptionOption

+ func WithSubscriptionEmailAddresses(emailAddresses []string) SubscriptionOption

+ func WithSubscriptionFrequency(frequency string) SubscriptionOption

+ func WithSubscriptionID(id string) SubscriptionOption

+ func WithSubscriptionIgnoreTime(ignoreTime bool) SubscriptionOption

+ func WithSubscriptionIsActive(isActive bool) SubscriptionOption

+ func WithSubscriptionName(name string) SubscriptionOption

+ func WithSubscriptionSearchIds(searchIds []string) SubscriptionOption

+ type SubscriptionOptions struct

+ Subscription struct{ ... }

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL