Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.39.0

Jan 12, 2026

Changes in this version

type Config

+ UnixSocketProxy string

v0.38.1

Jun 2, 2025

v0.38.0

Mar 27, 2025

Changes in this version

type Client

+ func (c *Client) ScheduledSearchesV2() *ScheduledSearchesV2

+ type ScheduledSearchV2 struct

+ ActionNames []string

+ BackfillLimitV2 *int

+ Description *string

+ Enabled bool

+ ID string

+ Labels []string

+ MaxWaitTimeSeconds *int64

+ Name string

+ OwnershipRunAsID string

+ QueryOwnershipType string

+ QueryString string

+ QueryTimestampType string

+ Schedule string

+ SearchIntervalOffsetSeconds *int64

+ SearchIntervalSeconds int64

+ TimeZone string

+ type ScheduledSearchesV2 struct

+ func (a *ScheduledSearchesV2) Create(searchDomainName string, newScheduledSearch *ScheduledSearchV2) (*ScheduledSearchV2, error)

+ func (a *ScheduledSearchesV2) Delete(searchDomainName, scheduledSearchID string) error

+ func (a *ScheduledSearchesV2) List(searchDomainName string) ([]ScheduledSearchV2, error)

v0.37.1

Feb 13, 2025

v0.37.0

Dec 17, 2024

Changes in this version

+ const JSONContentType

+ const LogScaleVersionWithParserAPIv2

+ const ZIPContentType

+ func ActionNotFound(name string) error

+ func AggregateAlertNotFound(name string) error

+ func AlertNotFound(name string) error

+ func CloneHeader(in http.Header) http.Header

+ func CloneRequest(req *http.Request) *http.Request

+ func ClusterNodeNotFound(name string) error

+ func FilterAlertNotFound(name string) error

+ func IngestTokenNotFound(name string) error

+ func NewHttpTransport(config Config) *http.Transport

+ func ParserNotFound(name string) error

+ func RepositoryNotFound(name string) error

+ func ScheduledSearchNotFound(name string) error

+ func SearchDomainNotFound(name string) error

+ func UserNotFound(name string) error

+ func ViewNotFound(name string) error

+ type Action struct

+ EmailAction EmailAction

+ HumioRepoAction HumioRepoAction

+ ID string

+ Name string

+ OpsGenieAction OpsGenieAction

+ PagerDutyAction PagerDutyAction

+ SlackAction SlackAction

+ SlackPostMessageAction SlackPostMessageAction

+ Type string

+ UploadFileAction UploadFileAction

+ VictorOpsAction VictorOpsAction

+ WebhookAction WebhookAction

+ type Actions struct

+ func (n *Actions) Add(searchDomainName string, newAction *Action) (*Action, error)

+ func (n *Actions) Delete(searchDomainName, actionName string) error

+ func (n *Actions) Get(searchDomainName, actionName string) (*Action, error)

+ func (n *Actions) List(searchDomainName string) ([]Action, error)

+ type AggregateAlert struct

+ ActionNames []string

+ Description *string

+ Enabled bool

+ ID string

+ Labels []string

+ Name string

+ OwnershipRunAsID string

+ QueryOwnershipType string

+ QueryString string

+ QueryTimestampType string

+ SearchIntervalSeconds int64

+ ThrottleField *string

+ ThrottleTimeSeconds int64

+ TriggerMode string

+ type AggregateAlerts struct

+ func (a *AggregateAlerts) Create(searchDomainName string, newAggregateAlert *AggregateAlert) (*AggregateAlert, error)

+ func (a *AggregateAlerts) Delete(searchDomainName, aggregateAlertID string) error

+ func (a *AggregateAlerts) List(searchDomainName string) ([]AggregateAlert, error)

+ type Alert struct

+ Actions []string

+ Description *string

+ Enabled bool

+ ID string

+ IsStarred bool

+ Labels []string

+ LastError *string

+ Name string

+ QueryOwnershipType string

+ QueryStart string

+ QueryString string

+ RunAsUserID string

+ ThrottleField *string

+ ThrottleTimeMillis int64

+ TimeOfLastTrigger *int64

+ type Alerts struct

+ func (a *Alerts) Add(searchDomainName string, newAlert *Alert) (*Alert, error)

+ func (a *Alerts) Delete(searchDomainName, alertName string) error

+ func (a *Alerts) Get(viewName, alertName string) (*Alert, error)

+ func (a *Alerts) List(searchDomainName string) ([]Alert, error)

+ type Client struct

+ func NewClient(config Config) *Client

+ func NewClientWithTransport(config Config, httpTransport *http.Transport) *Client

+ func (c *Client) Actions() *Actions

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

+ func (c *Client) AggregateAlerts() *AggregateAlerts

+ func (c *Client) Alerts() *Alerts

+ func (c *Client) CACertificate() string

+ func (c *Client) ClusterNodes() *ClusterNodes

+ func (c *Client) Clusters() *Clusters

+ func (c *Client) Config() Config

+ func (c *Client) FeatureFlags() *FeatureFlags

+ func (c *Client) Files() *Files

+ func (c *Client) FilterAlerts() *FilterAlerts

+ func (c *Client) Groups() *Groups

+ func (c *Client) HTTPRequest(httpMethod string, path string, body io.Reader) (*http.Response, error)

+ func (c *Client) HTTPRequestContext(ctx context.Context, httpMethod string, path string, body io.Reader, ...) (*http.Response, error)

+ func (c *Client) Health() (Health, error)

+ func (c *Client) IngestTokens() *IngestTokens

+ func (c *Client) Insecure() bool

+ func (c *Client) Licenses() *Licenses

+ func (c *Client) MakeRequest(ctx context.Context, req *graphql.Request, resp *graphql.Response) error

+ func (c *Client) Packages() *Packages

+ func (c *Client) Parsers() *Parsers

+ func (c *Client) QueryJobs() *QueryJobs

+ func (c *Client) Repositories() *Repositories

+ func (c *Client) Roles() *Roles

+ func (c *Client) ScheduledSearches() *ScheduledSearches

+ func (c *Client) Status() (*StatusResponse, error)

+ func (c *Client) Token() string

+ func (c *Client) Tokens() *Tokens

+ func (c *Client) Users() *Users

+ func (c *Client) Viewer() *Viewer

+ func (c *Client) Views() *Views

+ func (s *Client) SearchDomains() *SearchDomains

+ type Cluster struct

+ ClusterInfoAgeSeconds float64

+ IngestPartitions []IngestPartition

+ MissingSegmentSize float64

+ Nodes []ClusterNode

+ OverReplicatedSegmentSize float64

+ ProperlyReplicatedSegmentSize float64

+ TargetMissingSegmentSize float64

+ TargetOverReplicatedSegmentSize float64

+ TargetProperlyReplicatedSegmentSize float64

+ TargetUnderReplicatedSegmentSize float64

+ UnderReplicatedSegmentSize float64

+ type ClusterNode struct

+ CanBeSafelyUnregistered bool

+ ClusterInfoAgeSeconds float64

+ CurrentSize float64

+ FreeOnPrimary float64

+ FreeOnSecondary float64

+ Id int

+ InboundSegmentSize float64

+ IsAvailable bool

+ LastHeartbeat string

+ Name string

+ OutboundSegmentSize float64

+ PrimarySize float64

+ SecondarySize float64

+ SolitarySegmentSize float64

+ TargetSize float64

+ TotalSizeOfPrimary float64

+ TotalSizeOfSecondary float64

+ Uri string

+ Uuid string

+ WipSize float64

+ Zone *string

+ type ClusterNodes struct

+ func (n *ClusterNodes) Get(nodeID int) (ClusterNode, error)

+ func (n *ClusterNodes) List() ([]ClusterNode, error)

+ func (n *ClusterNodes) Unregister(nodeID int, force bool) error

+ type Clusters struct

+ func (c *Clusters) Get() (Cluster, error)

+ type Config struct

+ Address *url.URL

+ CACertificatePEM string

+ DialContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ Insecure bool

+ ProxyOrganization string

+ Token string

+ UserAgent string

+ func DefaultConfig() Config

+ type EmailAction struct

+ BodyTemplate *string

+ Recipients []string

+ SubjectTemplate *string

+ UseProxy bool

+ type EntityNotFound struct

+ func (e EntityNotFound) EntityType() EntityType

+ func (e EntityNotFound) Error() string

+ func (e EntityNotFound) Key() string

+ type EntityType string

+ const EntityTypeAction

+ const EntityTypeAggregateAlert

+ const EntityTypeAlert

+ const EntityTypeClusterNode

+ const EntityTypeFilterAlert

+ const EntityTypeIngestToken

+ const EntityTypeParser

+ const EntityTypeRepository

+ const EntityTypeScheduledSearch

+ const EntityTypeSearchDomain

+ const EntityTypeUser

+ const EntityTypeView

+ func (e EntityType) String() string

+ type ErrorList []*GraphqlError

+ func (errs ErrorList) Error() string

+ type FeatureFlag struct

+ Description string

+ Experimental bool

+ Flag FeatureFlagName

+ type FeatureFlagName string

+ type FeatureFlags struct

+ func (f *FeatureFlags) DisableForOrganization(organizationID string, flag FeatureFlagName) error

+ func (f *FeatureFlags) DisableForUser(userID string, flag FeatureFlagName) error

+ func (f *FeatureFlags) DisableGlobally(flag FeatureFlagName) error

+ func (f *FeatureFlags) EnableForOrganization(organizationID string, flag FeatureFlagName) error

+ func (f *FeatureFlags) EnableForUser(userID string, flag FeatureFlagName) error

+ func (f *FeatureFlags) EnableGlobally(flag FeatureFlagName) error

+ func (f *FeatureFlags) SupportedFlags() ([]FeatureFlag, error)

+ type File struct

+ ContentHash string

+ Name string

+ type Files struct

+ func (f *Files) Delete(searchDomainName string, fileName string) error

+ func (f *Files) Download(viewName string, fileName string) (io.Reader, error)

+ func (f *Files) List(searchDomainName string) ([]File, error)

+ func (f *Files) Upload(viewName string, fileName string, reader io.Reader) error

+ type FilterAlert struct

+ ActionNames []string

+ Description *string

+ Enabled bool

+ ID string

+ Labels []string

+ Name string

+ OwnershipRunAsID string

+ QueryOwnershipType string

+ QueryString string

+ ThrottleField *string

+ ThrottleTimeSeconds *int64

+ type FilterAlerts struct

+ func (fa *FilterAlerts) Create(searchDomainName string, newFilterAlert *FilterAlert) (*FilterAlert, error)

+ func (fa *FilterAlerts) Delete(searchDomainName, filterAlertID string) error

+ func (fa *FilterAlerts) List(searchDomainName string) ([]FilterAlert, error)

+ type GraphqlError struct

+ Err error

+ Extensions map[string]interface{}

+ Locations []gqlerror.Location

+ Message string

+ Path ast.Path

+ Rule string

+ State map[string]string

+ func (err *GraphqlError) Error() string

+ type Group struct

+ DisplayName string

+ ID string

+ type Groups struct

+ func (g *Groups) AddUserToGroup(groupID string, userID string) error

+ func (g *Groups) List() ([]Group, error)

+ func (g *Groups) RemoveUserFromGroup(groupID string, userID string) error

+ type Health struct

+ Down []HealthCheck

+ OK []HealthCheck

+ Status StatusValue

+ StatusMessage string

+ Uptime string

+ Version string

+ Warn []HealthCheck

+ func (h *Health) ChecksMap() map[string]HealthCheck

+ type HealthCheck struct

+ Fields map[string]interface{}

+ Name string

+ Status StatusValue

+ StatusMessage string

+ type HttpHeader struct

+ Header string

+ Value string

+ type HumioRepoAction struct

+ IngestToken string

+ type IngestPartition struct

+ Id int

+ NodeIds []int

+ type IngestToken struct

+ AssignedParser string

+ Name string

+ Token string

+ type IngestTokens struct

+ func (i *IngestTokens) Add(repositoryName string, tokenName string, parserName string) (*IngestToken, error)

+ func (i *IngestTokens) Get(repoName, tokenName string) (*IngestToken, error)

+ func (i *IngestTokens) List(repositoryName string) ([]IngestToken, error)

+ func (i *IngestTokens) Remove(repositoryName string, tokenName string) error

+ func (i *IngestTokens) Update(repositoryName string, tokenName string, parserName string) (*IngestToken, error)

+ type InstallationErrors struct

+ InstallationErrors []string

+ ParseErrors []string

+ ResponseType string

+ type InstalledPackage struct

+ AvailableUpdate *string

+ ID string

+ InstalledBy struct{ ... }

+ Source string

+ UpdatedBy struct{ ... }

+ type License interface

+ ExpiresAt func() string

+ IssuedAt func() string

+ type Licenses struct

+ func (l *Licenses) Get() (License, error)

+ func (l *Licenses) Install(license string) error

+ type OnPremLicense struct

+ ExpiresAtVal string

+ ID string

+ IssuedAtVal string

+ IssuedTo string

+ NumberOfSeats *int

+ func (l OnPremLicense) ExpiresAt() string

+ func (l OnPremLicense) IssuedAt() string

+ type OpsGenieAction struct

+ ApiUrl string

+ GenieKey string

+ UseProxy bool

+ type Packages struct

+ func (p *Packages) CreateArchive(packageDirPath string, targetFileName string) error

+ func (p *Packages) InstallArchive(viewName string, pathToZip string, queryOwnership string) (*ValidationResponse, error)

+ func (p *Packages) InstallFromDirectory(packageDirPath string, targetRepoOrView string, queryOwnership string) (*ValidationResponse, error)

+ func (p *Packages) ListInstalled(searchDomainName string) ([]InstalledPackage, error)

+ func (p *Packages) UninstallPackage(searchDomainName string, packageID string) error

+ func (p *Packages) Validate(viewName string, absPath string) (*ValidationResponse, error)

+ type PagerDutyAction struct

+ RoutingKey string

+ Severity string

+ UseProxy bool

+ type Parser struct

+ FieldsToBeRemovedBeforeParsing []string

+ FieldsToTag []string

+ ID string

+ Name string

+ Script string

+ TestCases []ParserTestCase

+ type ParserListItem struct

+ ID string

+ IsBuiltIn bool

+ Name string

+ type ParserTestCase struct

+ Assertions []ParserTestCaseAssertions

+ Event ParserTestEvent

+ type ParserTestCaseAssertions struct

+ FieldsHaveValues map[string]string

+ FieldsNotPresent []string

+ OutputEventIndex int

+ type ParserTestEvent struct

+ RawString string

+ type Parsers struct

+ func (p *Parsers) Add(repositoryName string, newParser *Parser, allowOverwritingExistingParser bool) (*Parser, error)

+ func (p *Parsers) Delete(repositoryName string, parserName string) error

+ func (p *Parsers) Export(repositoryName string, parserName string) (string, error)

+ func (p *Parsers) Get(repositoryName string, parserName string) (*Parser, error)

+ func (p *Parsers) List(repositoryName string) ([]ParserListItem, error)

+ type Query struct

+ Arguments map[string]string

+ End string

+ Live bool

+ QueryString string

+ ShowQueryEventDistribution bool

+ Start string

+ TimezoneOffset *int

+ type QueryError struct

+ func (e QueryError) Error() string

+ type QueryJobs struct

+ func (q *QueryJobs) Delete(repository string, id string) error

+ func (q *QueryJobs) PollContext(ctx context.Context, repository string, id string) (QueryResult, error)

+ func (q QueryJobs) Create(repository string, query Query) (string, error)

+ type QueryResult struct

+ Cancelled bool

+ Done bool

+ Events []map[string]interface{}

+ Metadata QueryResultMetadata

+ type QueryResultMetadata struct

+ EventCount uint64

+ ExtraData map[string]interface{}

+ FieldOrder []string

+ IsAggregate bool

+ PollAfter int

+ ProcessedBytes uint64

+ ProcessedEvents uint64

+ QueryEnd uint64

+ QueryStart uint64

+ ResultBufferSize uint64

+ TimeMillis uint64

+ TotalWork uint64

+ WorkDone uint64

+ type RepoListItem struct

+ ID string

+ Name string

+ SpaceUsed int64

+ type Repositories struct

+ func (r *Repositories) Create(name string) error

+ func (r *Repositories) Delete(name, reason string, allowDataDeletion bool) error

+ func (r *Repositories) DisableS3Archiving(name string) error

+ func (r *Repositories) EnableS3Archiving(name string) error

+ func (r *Repositories) Get(name string) (Repository, error)

+ func (r *Repositories) List() ([]RepoListItem, error)

+ func (r *Repositories) UpdateAutomaticSearch(name string, automaticSearch bool) error

+ func (r *Repositories) UpdateDescription(name, description string) error

+ func (r *Repositories) UpdateIngestBasedRetention(name string, ingestInGB *float64, allowDataDeletion bool) error

+ func (r *Repositories) UpdateS3ArchivingConfiguration(name string, bucket string, region string, format string) error

+ func (r *Repositories) UpdateStorageBasedRetention(name string, storageInGB *float64, allowDataDeletion bool) error

+ func (r *Repositories) UpdateTimeBasedRetention(name string, retentionInDays *float64, allowDataDeletion bool) error

+ type Repository struct

+ AutomaticSearch bool

+ Description *string

+ ID string

+ IngestRetentionSizeGB *float64

+ Name string

+ RetentionDays *float64

+ S3ArchivingConfiguration S3Configuration

+ SpaceUsed int64

+ StorageRetentionSizeGB *float64

+ type Response struct

+ Data interface{}

+ Errors ErrorList

+ Extensions map[string]interface{}

+ type Role struct

+ DisplayName string

+ ID string

+ OrgPermissions []string

+ SystemPermissions []string

+ ViewPermissions []string

+ type Roles struct

+ func (r *Roles) Get(rolename string) (*Role, error)

+ func (r *Roles) GetRoleID(rolename string) (string, error)

+ func (r *Roles) List() ([]Role, error)

+ type S3Configuration struct

+ Bucket string

+ Disabled bool

+ Format string

+ Region string

+ func (s *S3Configuration) IsConfigured() bool

+ func (s *S3Configuration) IsEnabled() bool

+ type ScheduledSearch struct

+ ActionNames []string

+ BackfillLimit int

+ Description *string

+ Enabled bool

+ ID string

+ Labels []string

+ Name string

+ OwnershipRunAsID string

+ QueryEnd string

+ QueryOwnershipType string

+ QueryStart string

+ QueryString string

+ Schedule string

+ TimeZone string

+ type ScheduledSearches struct

+ func (a *ScheduledSearches) Create(searchDomainName string, newScheduledSearch *ScheduledSearch) (*ScheduledSearch, error)

+ func (a *ScheduledSearches) Delete(searchDomainName, scheduledSearchID string) error

+ func (a *ScheduledSearches) List(searchDomainName string) ([]ScheduledSearch, error)

+ type SearchDomain struct

+ AutomaticSearch bool

+ Description *string

+ Name string

+ type SearchDomains struct

+ func (s *SearchDomains) Get(name string) (*SearchDomain, error)

+ type SlackAction struct

+ Fields []SlackField

+ Url string

+ UseProxy bool

+ type SlackField struct

+ FieldName string

+ Value string

+ type SlackPostMessageAction struct

+ ApiToken string

+ Channels []string

+ Fields []SlackField

+ UseProxy bool

+ type StatusResponse struct

+ Status string

+ Version string

+ func (s StatusResponse) AtLeast(ver string) (bool, error)

+ func (s StatusResponse) IsDown() bool

+ type StatusValue string

+ const StatusDown

+ const StatusOK

+ const StatusWarn

+ type Tokens struct

+ func (t *Tokens) Rotate(tokenID string) (string, error)

+ type UnversionedPackageSpecifier string

+ type UploadFileAction struct

+ FileName string

+ type User struct

+ Company *string

+ CountryCode *string

+ CreatedAt string

+ Email *string

+ FullName *string

+ ID string

+ IsRoot bool

+ Picture *string

+ Username string

+ type Users struct

+ func (u *Users) Add(username string, isRoot *bool, ...) (User, error)

+ func (u *Users) Get(username string) (User, error)

+ func (u *Users) List() ([]User, error)

+ func (u *Users) Remove(username string) (User, error)

+ func (u *Users) Update(username string, isRoot *bool, ...) (User, error)

+ type ValidationResponse struct

+ InstallationErrors []string

+ ParseErrors []string

+ func (resp *ValidationResponse) IsValid() bool

+ type VersionedPackageSpecifier string

+ type VictorOpsAction struct

+ MessageType string

+ NotifyUrl string

+ UseProxy bool

+ type View struct

+ AutomaticSearch bool

+ Connections []ViewConnection

+ Description string

+ Name string

+ type ViewConnection struct

+ Filter string

+ RepoName string

+ type ViewConnectionInput struct

+ Filter string

+ RepositoryName string

+ type ViewListItem struct

+ AutomaticSearch bool

+ Name string

+ Typename string

+ type Viewer struct

+ func (c *Viewer) Username() (string, error)

+ type Views struct

+ func (c *Views) Create(name, description string, connections []ViewConnectionInput) error

+ func (c *Views) Delete(name, reason string) error

+ func (c *Views) Get(name string) (*View, error)

+ func (c *Views) List() ([]ViewListItem, error)

+ func (c *Views) UpdateAutomaticSearch(name string, automaticSearch bool) error

+ func (c *Views) UpdateConnections(name string, connections []ViewConnectionInput) error

+ func (c *Views) UpdateDescription(name string, description string) error

+ type WebhookAction struct

+ BodyTemplate string

+ Headers []HttpHeader

+ IgnoreSSL bool

+ Method string

+ Url string

+ UseProxy bool