Help us shape the future of Go! Take the 2026 Go Developer Survey

models

package
v1.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2026 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ACLEntry

type ACLEntry struct {
	Name    string    `json:"name"`
	Content ACLObject `json:"acl"`
}

type ACLObject

type ACLObject struct {
	App            string      `json:"app,omitempty" url:"app,omitempty"`
	CanChangePerms bool        `json:"can_change_perms,omitempty" url:"can_change_perms,omitempty"`
	CanList        bool        `json:"can_list,omitempty" url:"can_list,omitempty"`
	CanShareApp    bool        `json:"can_share_app,omitempty" url:"can_share_app,omitempty"`
	CanShareGlobal bool        `json:"can_share_global,omitempty" url:"can_share_global,omitempty"`
	CanShareUser   bool        `json:"can_share_user,omitempty" url:"can_share_user,omitempty"`
	CanWrite       bool        `json:"can_write,omitempty" url:"can_write,omitempty"`
	Owner          string      `json:"owner,omitempty" url:"owner,omitempty"`
	Removable      bool        `json:"removable,omitempty" url:"removable,omitempty"`
	Sharing        string      `json:"sharing,omitempty" url:"sharing,omitempty"`
	Perms          Permissions `json:"perms,omitempty" url:"perms,omitempty"`
}

https://docs.splunk.com/Documentation/Splunk/8.0.4/RESTUM/RESTusing#Access_Control_List

type ACLResponse

type ACLResponse struct {
	Entry    []ACLEntry     `json:"entry"`
	Messages []ErrorMessage `json:"messages"`
}

type AdminProxyssoGroupsEntry added in v1.6.0

type AdminProxyssoGroupsEntry struct {
	Name    string                    `json:"name"`
	ACL     ACLObject                 `json:"acl"`
	Content AdminProxyssoGroupsObject `json:"content"`
}

AdminProxyssoGroupsEntry is one Proxy SSO group mapping.

type AdminProxyssoGroupsObject added in v1.6.0

type AdminProxyssoGroupsObject struct {
	Name  string   `json:"name,omitempty" url:"name,omitempty"`
	Roles []string `json:"roles,omitempty" url:"roles,omitempty"`
}

AdminProxyssoGroupsObject is the group name and the Splunk roles it maps to.

type AdminProxyssoGroupsResponse added in v1.6.0

type AdminProxyssoGroupsResponse struct {
	Entry    []AdminProxyssoGroupsEntry `json:"entry"`
	Messages []ErrorMessage             `json:"messages"`
}

AdminProxyssoGroupsResponse is the JSON body from admin/ProxySSO-groups.

type AdminSAMLGroupsEntry

type AdminSAMLGroupsEntry struct {
	Name    string                `json:"name"`
	ACL     ACLObject             `json:"acl"`
	Content AdminSAMLGroupsObject `json:"content"`
}

type AdminSAMLGroupsObject

type AdminSAMLGroupsObject struct {
	Name  string   `json:"name,omitempty" url:"name,omitempty"`
	Roles []string `json:"roles,omitempty" url:"roles,omitempty"`
}

type AdminSAMLGroupsResponse

type AdminSAMLGroupsResponse struct {
	Entry    []AdminSAMLGroupsEntry `json:"entry"`
	Messages []ErrorMessage         `json:"messages"`
}

Scripted Input Response Schema

type AppsLocalEntry

type AppsLocalEntry struct {
	Name    string          `json:"name"`
	ACL     ACLObject       `json:"acl"`
	Content AppsLocalObject `json:"content"`
}

type AppsLocalObject

type AppsLocalObject struct {
	Auth            string `json:"auth,omitempty" url:"auth,omitempty"`
	Author          string `json:"author,omitempty" url:"author,omitempty"`
	Configured      bool   `json:"configured,omitempty" url:"configured"`
	Description     string `json:"description,omitempty" url:"description,omitempty"`
	ExplicitAppName string `json:"explicit_appname,omitempty" url:"explicit_appname,omitempty"`
	Filename        bool   `json:"filename,omitempty" url:"filename"`
	Label           string `json:"label,omitempty" url:"label,omitempty"`
	Name            string `json:"name,omitempty" url:"name,omitempty"`
	Session         string `json:"session,omitempty" url:"session,omitempty"`
	Version         string `json:"version,omitempty" url:"version,omitempty"`
	Visible         bool   `json:"visible,omitempty" url:"visible"`
	Update          bool   `json:"update,omitempty" url:"update"`
}

type AppsLocalResponse

type AppsLocalResponse struct {
	Entry    []AppsLocalEntry `json:"entry"`
	Messages []ErrorMessage   `json:"messages"`
}

Local App Schema

type AuthenticationUserEntry

type AuthenticationUserEntry struct {
	Name    string                   `json:"name"`
	ACL     ACLObject                `json:"acl"`
	Content AuthenticationUserObject `json:"content"`
}

type AuthenticationUserObject

type AuthenticationUserObject struct {
	DefaultApp            string   `json:"defaultApp,omitempty" url:"defaultApp,omitempty"`
	Email                 string   `json:"email,omitempty" url:"email,omitempty"`
	ForceChangePass       bool     `json:"force-change-pass,omitempty" url:"force-change-pass"`
	Name                  string   `json:"name,omitempty" url:"name,omitempty"`
	Password              string   `json:"password,omitempty" url:"password,omitempty"`
	RealName              string   `json:"realname,omitempty" url:"realname,omitempty"`
	RestartBackgroundJobs bool     `json:"restart_background_jobs,omitempty" url:"restart_background_jobs"`
	Roles                 []string `json:"roles,omitempty" url:"roles,omitempty"`
	TZ                    string   `json:"tz,omitempty" url:"tz,omitempty"`
}

type AuthenticationUserResponse

type AuthenticationUserResponse struct {
	Entry    []AuthenticationUserEntry `json:"entry"`
	Messages []ErrorMessage            `json:"messages"`
}

Scripted Input Response Schema

type AuthorizationRolesEntry

type AuthorizationRolesEntry struct {
	Name    string                   `json:"name"`
	ACL     ACLObject                `json:"acl"`
	Content AuthorizationRolesObject `json:"content"`
}

type AuthorizationRolesObject

type AuthorizationRolesObject struct {
	Capabilities              []string `json:"capabilities,omitempty" url:"capabilities,omitempty"`
	CumulativeRTSrchJobsQuota int      `json:"cumulativeRTSrchJobsQuota" url:"cumulativeRTSrchJobsQuota"`
	CumulativeSrchJobsQuota   int      `json:"cumulativeSrchJobsQuota" url:"cumulativeSrchJobsQuota"`
	DefaultApp                string   `json:"defaultApp,omitempty" url:"defaultApp,omitempty"`
	ImportedRoles             []string `json:"imported_roles,omitempty" url:"imported_roles,omitempty"`
	Name                      string   `json:"name,omitempty" url:"name,omitempty"`
	RtSrchJobsQuota           int      `json:"rtSrchJobsQuota" url:"rtSrchJobsQuota"`
	SrchDiskQuota             int      `json:"srchDiskQuota" url:"srchDiskQuota"`
	SrchFilter                string   `json:"srchFilter,omitempty" url:"srchFilter,omitempty"`
	SrchIndexesAllowed        []string `json:"srchIndexesAllowed,omitempty" url:"srchIndexesAllowed,omitempty"`
	SrchIndexesDefault        []string `json:"srchIndexesDefault,omitempty" url:"srchIndexesDefault,omitempty"`
	SrchJobsQuota             int      `json:"srchJobsQuota" url:"srchJobsQuota"`
	SrchTimeWin               int      `json:"srchTimeWin" url:"srchTimeWin"`
}

type AuthorizationRolesResponse

type AuthorizationRolesResponse struct {
	Entry    []AuthorizationRolesEntry `json:"entry"`
	Messages []ErrorMessage            `json:"messages"`
}

Scripted Input Response Schema

type ConfStanzaEntry

type ConfStanzaEntry struct {
	Name    string           `json:"name"`
	ACL     ACLObject        `json:"acl"`
	Content ConfStanzaObject `json:"content"`
}

type ConfStanzaObject

type ConfStanzaObject struct {
	Variables map[string]string `json:"variables,omitempty" url:"variables,omitempty"`
}

type ConfStanzaResponse

type ConfStanzaResponse struct {
	Entry    []ConfStanzaEntry `json:"entry"`
	Messages []ErrorMessage    `json:"messages"`
}

type ConfigsConfEntry

type ConfigsConfEntry struct {
	Name    string            `json:"name"`
	ACL     ACLObject         `json:"acl"`
	Content ConfigsConfObject `json:"content"`
}

type ConfigsConfObject

type ConfigsConfObject struct {
	Variables map[string]string `json:"-"`
}

type ConfigsConfResponse

type ConfigsConfResponse struct {
	Entry    []ConfigsConfEntry `json:"entry"`
	Messages []ErrorMessage     `json:"messages"`
}

type DashboardEntry added in v1.3.9

type DashboardEntry struct {
	Name    string                 `json:"name"`
	ACL     ACLObject              `json:"acl"`
	Content SplunkDashboardsObject `json:"content"`
}

type DashboardResponse added in v1.3.9

type DashboardResponse struct {
	Entry    []DashboardEntry `json:"entry"`
	Messages []ErrorMessage   `json:"messages"`
}

DashboardResponse HTTP Input Response Schema

type ErrorMessage

type ErrorMessage struct {
	Type string `json:"type"`
	Text string `json:"text"`
}

type FederatedIndexEntry added in v1.5.6

type FederatedIndexEntry struct {
	Name    string               `json:"name"`
	Content FederatedIndexObject `json:"content"`
}

FederatedIndexEntry represents one federated index definition.

type FederatedIndexObject added in v1.5.6

type FederatedIndexObject struct {
	FederatedProvider string `json:"federated.provider,omitempty" url:"federated.provider,omitempty"`
	FederatedDataset  string `json:"federated.dataset,omitempty" url:"federated.dataset,omitempty"`
}

FederatedIndexObject maps a local federated index to a provider dataset.

type FederatedIndexResponse added in v1.5.6

type FederatedIndexResponse struct {
	Entry    []FederatedIndexEntry `json:"entry"`
	Messages []ErrorMessage        `json:"messages"`
}

FederatedIndexResponse is the JSON response returned by the federated index REST endpoint.

type FederatedProviderEntry added in v1.5.6

type FederatedProviderEntry struct {
	Name    string                  `json:"name"`
	Content FederatedProviderObject `json:"content"`
}

FederatedProviderEntry represents one federated provider definition.

type FederatedProviderObject added in v1.5.6

type FederatedProviderObject struct {
	Type           string `json:"type,omitempty" url:"type,omitempty"`
	Mode           string `json:"mode,omitempty" url:"mode,omitempty"`
	AppContext     string `json:"appContext,omitempty" url:"appContext,omitempty"`
	HostPort       string `json:"hostPort,omitempty" url:"hostPort,omitempty"`
	ServiceAccount string `json:"serviceAccount,omitempty" url:"serviceAccount,omitempty"`
	Password       string `json:"password,omitempty" url:"password,omitempty"`
}

FederatedProviderObject contains the Enterprise Splunk-to-Splunk provider settings supported by this provider.

type FederatedProviderResponse added in v1.5.6

type FederatedProviderResponse struct {
	Entry    []FederatedProviderEntry `json:"entry"`
	Messages []ErrorMessage           `json:"messages"`
}

FederatedProviderResponse is the JSON response returned by the federated provider REST endpoint.

type FlexBool added in v1.5.8

type FlexBool bool

FlexBool unmarshals JSON values that Splunk returns as a boolean, the strings "true" and "false", or the strings "1" and "0". Splunk 10 returns action.email.reportIncludeSplunkLogo as "1" or "0" even though the field is a boolean. null leaves the value unchanged.

func (*FlexBool) UnmarshalJSON added in v1.5.8

func (f *FlexBool) UnmarshalJSON(data []byte) error

type FlexDuration added in v1.5.8

type FlexDuration int

FlexDuration unmarshals a Splunk time value into seconds. Alert action maxtime is a duration such as "5m" or "1m". A bare number is seconds. Suffixes match alert_actions.conf: s, m, h, d. An empty string decodes as 0. null leaves the value unchanged.

func (*FlexDuration) UnmarshalJSON added in v1.5.8

func (f *FlexDuration) UnmarshalJSON(data []byte) error

type FlexHotBuckets added in v1.6.0

type FlexHotBuckets int

FlexHotBuckets unmarshals maxHotBuckets. Splunk 8.1 and earlier return a JSON number. Splunk 8.2 and later return a string such as "3" or "auto". indexes.conf defines "auto" as 3, so this stays an integer and existing Terraform config such as max_hot_buckets = 6 keeps working. See https://github.com/splunk/terraform-provider-splunk/issues/124

func (*FlexHotBuckets) UnmarshalJSON added in v1.6.0

func (f *FlexHotBuckets) UnmarshalJSON(data []byte) error

type FlexInt added in v1.5.2

type FlexInt int

FlexInt unmarshals JSON values that Splunk returns as either a string-encoded integer ("0", "1"), a boolean string ("true", "false"), a bare integer (0, 1), or a boolean (false, true). Splunk Enterprise returns string-encoded integers; Splunk Cloud returns booleans or boolean strings for the same fields.

An empty or blank string decodes as 0 on every FlexInt. That includes fields posted when the value is 0, such as HEC useACK and the saved search action.email.include_* flags. action.snow_event.param.severity is omitempty, so a decoded 0 is not posted. null leaves the value unchanged, as encoding/json does for a plain int. See: https://github.com/splunk/terraform-provider-splunk/issues/130

func (*FlexInt) UnmarshalJSON added in v1.5.2

func (f *FlexInt) UnmarshalJSON(data []byte) error

type FlexString added in v1.6.0

type FlexString string

FlexString unmarshals a Splunk JSON value that is either a string or a number. Index fields such as bucketRebuildMemoryHint ("auto", "16MB") and repFactor ("auto", "0") are strings in indexes.conf, and Splunk sometimes returns those same fields as JSON numbers. null leaves the value unchanged.

func (*FlexString) UnmarshalJSON added in v1.6.0

func (f *FlexString) UnmarshalJSON(data []byte) error

type GlobalHECEntry

type GlobalHECEntry struct {
	Name    string                         `json:"name"`
	Content GlobalHttpEventCollectorObject `json:"content"`
}

type GlobalHECResponse

type GlobalHECResponse struct {
	Entry    []GlobalHECEntry `json:"entry"`
	Messages []ErrorMessage   `json:"messages"`
}

HTTP Input Response Schema

type GlobalHttpEventCollectorObject

type GlobalHttpEventCollectorObject struct {
	Host                string `json:"host,omitempty" url:"host,omitempty"`
	Index               string `json:"index,omitempty" url:"index,omitempty"`
	Disabled            bool   `json:"disabled,omitempty" url:"disabled"`
	EnableSSL           bool   `json:"enableSSL,string,omitempty" url:"enableSSL"`
	Port                int    `json:"port,string,omitempty" url:"port,omitempty"`
	DedicatedIoThreads  int    `json:"dedicatedIoThreads,string,omitempty" url:"dedicatedIoThreads,omitempty"`
	MaxSockets          int    `json:"maxSockets,string,omitempty" url:"maxSockets,omitempty"`
	MaxThreads          int    `json:"maxThreads,string,omitempty" url:"maxThreads,omitempty"`
	UseDeploymentServer int    `json:"useDeploymentServer,string,omitempty" url:"useDeploymentServer"`
}

type HECEntry

type HECEntry struct {
	Name    string                   `json:"name"`
	ACL     ACLObject                `json:"acl"`
	Content HttpEventCollectorObject `json:"content"`
}

type HECResponse

type HECResponse struct {
	Entry    []HECEntry     `json:"entry"`
	Messages []ErrorMessage `json:"messages"`
}

HTTP Input Response Schema

type HttpEventCollectorObject

type HttpEventCollectorObject struct {
	Host       string        `json:"host,omitempty" url:"host,omitempty"`
	Indexes    []interface{} `json:"indexes,omitempty" url:"indexes,omitempty"`
	Index      string        `json:"index,omitempty" url:"index,omitempty"`
	Source     string        `json:"source,omitempty" url:"source,omitempty"`
	SourceType string        `json:"sourcetype,omitempty" url:"sourcetype,omitempty"`
	Token      string        `json:"token,omitempty" url:"token,omitempty"`
	Disabled   bool          `json:"disabled,omitempty" url:"disabled"`
	UseACK     FlexInt       `json:"useACK,omitempty" url:"useACK"`
}

type IndexEntry

type IndexEntry struct {
	Name    string      `json:"name"`
	ACL     ACLObject   `json:"acl"`
	Content IndexObject `json:"content"`
}

type IndexObject

type IndexObject struct {
	BlockSignSize                 int            `json:"blockSignSize,omitempty" url:"blockSignSize,omitempty"`
	BucketRebuildMemoryHint       FlexString     `json:"bucketRebuildMemoryHint,omitempty" url:"bucketRebuildMemoryHint,omitempty"`
	ColdPath                      string         `json:"coldPath,omitempty" url:"coldPath,omitempty"`
	ColdToFrozenDir               string         `json:"coldToFrozenDir,omitempty" url:"coldToFrozenDir,omitempty"`
	ColdToFrozenScript            string         `json:"coldToFrozenScript,omitempty" url:"coldToFrozenScript,omitempty"`
	CompressRawdata               bool           `json:"compressRawdata,omitempty" url:"compressRawdata,omitempty"`
	Datatype                      string         `json:"datatype,omitempty" url:"datatype,omitempty"`
	EnableOnlineBucketRepair      bool           `json:"enableOnlineBucketRepair,omitempty" url:"enableOnlineBucketRepair,omitempty"`
	FrozenTimePeriodInSecs        int            `json:"frozenTimePeriodInSecs,omitempty" url:"frozenTimePeriodInSecs,omitempty"`
	HomePath                      string         `json:"homePath,omitempty" url:"homePath,omitempty"`
	MaxBloomBackfillBucketAge     string         `json:"maxBloomBackfillBucketAge,omitempty" url:"maxBloomBackfillBucketAge,omitempty"`
	MaxConcurrentOptimizes        int            `json:"maxConcurrentOptimizes,omitempty" url:"maxConcurrentOptimizes,omitempty"`
	MaxDataSize                   string         `json:"maxDataSize,omitempty" url:"maxDataSize,omitempty"`
	MaxHotBuckets                 FlexHotBuckets `json:"maxHotBuckets,omitempty" url:"maxHotBuckets,omitempty"`
	MaxHotIdleSecs                int            `json:"maxHotIdleSecs,omitempty" url:"maxHotIdleSecs,omitempty"`
	MaxHotSpanSecs                int            `json:"maxHotSpanSecs,omitempty" url:"maxHotSpanSecs,omitempty"`
	MaxMemMB                      int            `json:"maxMemMB,omitempty" url:"maxMemMB,omitempty"`
	MaxMetaEntries                int            `json:"maxMetaEntries,omitempty" url:"maxMetaEntries,omitempty"`
	MaxTimeUnreplicatedNoAcks     int            `json:"maxTimeUnreplicatedNoAcks,omitempty" url:"maxTimeUnreplicatedNoAcks,omitempty"`
	MaxTimeUnreplicatedWithAcks   int            `json:"maxTimeUnreplicatedWithAcks,omitempty" url:"maxTimeUnreplicatedWithAcks,omitempty"`
	MaxTotalDataSizeMB            int            `json:"maxTotalDataSizeMB,omitempty" url:"maxTotalDataSizeMB,omitempty"`
	MaxWarmDBCount                int            `json:"maxWarmDBCount,omitempty" url:"maxWarmDBCount,omitempty"`
	MinRawFileSyncSecs            string         `json:"minRawFileSyncSecs,omitempty" url:"minRawFileSyncSecs,omitempty"`
	MinStreamGroupQueueSize       int            `json:"minStreamGroupQueueSize,omitempty" url:"minStreamGroupQueueSize,omitempty"`
	PartialServiceMetaPeriod      int            `json:"partialServiceMetaPeriod,omitempty" url:"partialServiceMetaPeriod,omitempty"`
	ProcessTrackerServiceInterval int            `json:"processTrackerServiceInterval,omitempty" url:"processTrackerServiceInterval,omitempty"`
	QuarantineFutureSecs          int            `json:"quarantineFutureSecs,omitempty" url:"quarantineFutureSecs,omitempty"`
	QuarantinePastSecs            int            `json:"quarantinePastSecs,omitempty" url:"quarantinePastSecs,omitempty"`
	RawChunkSizeBytes             int            `json:"rawChunkSizeBytes,omitempty" url:"rawChunkSizeBytes,omitempty"`
	RepFactor                     FlexString     `json:"repFactor,omitempty" url:"repFactor,omitempty"`
	RotatePeriodInSecs            int            `json:"rotatePeriodInSecs,omitempty" url:"rotatePeriodInSecs,omitempty"`
	ServiceMetaPeriod             int            `json:"serviceMetaPeriod,omitempty" url:"serviceMetaPeriod,omitempty"`
	SyncMeta                      bool           `json:"syncMeta,omitempty" url:"syncMeta,omitempty"`
	ThawedPath                    string         `json:"thawedPath,omitempty" url:"thawedPath,omitempty"`
	ThrottleCheckPeriod           int            `json:"throttleCheckPeriod,omitempty" url:"throttleCheckPeriod,omitempty"`
	TstatsHomePath                string         `json:"tstatsHomePath,omitempty" url:"tstatsHomePath,omitempty"`
	WarmToColdScript              string         `json:"warmToColdScript,omitempty" url:"warmToColdScript,omitempty"`
}

func (*IndexObject) UnmarshalJSON added in v1.6.0

func (o *IndexObject) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes an index and, when a flexible field rejects the JSON, names that REST field. encoding/json leaves custom UnmarshalJSON errors unlabeled.

type IndexResponse

type IndexResponse struct {
	Entry    []IndexEntry   `json:"entry"`
	Messages []ErrorMessage `json:"messages"`
}

type InputsMonitorEntry

type InputsMonitorEntry struct {
	Name    string              `json:"name"`
	ACL     ACLObject           `json:"acl"`
	Content InputsMonitorObject `json:"content"`
}

type InputsMonitorObject

type InputsMonitorObject struct {
	Host            string `json:"host,omitempty" url:"host,omitempty"`
	Index           string `json:"index,omitempty" url:"index,omitempty"`
	SourceType      string `json:"sourcetype,omitempty" url:"sourcetype,omitempty"`
	RenameSource    string `json:"rename-source,omitempty" url:"rename-source,omitempty"`
	Disabled        bool   `json:"disabled,omitempty" url:"disabled"`
	CrcSalt         string `json:"crcSalt,omitempty" url:"crcSalt,omitempty"`
	FollowTail      bool   `json:"followTail,omitempty" url:"followTail"`
	Recursive       bool   `json:"recursive,omitempty" url:"recursive"`
	HostRegex       string `json:"host_regex,omitempty" url:"host_regex,omitempty"`
	HostSegment     int    `json:"host_segment,omitempty" url:"host_segment,omitempty"`
	TimeBeforeClose int    `json:"time-before-close,omitempty" url:"time-before-close,omitempty"`
	IgnoreOlderThan string `json:"ignore-older-than,omitempty" url:"ignore-older-than,omitempty"`
	Blacklist       string `json:"blacklist,omitempty" url:"blacklist,omitempty"`
	Whitelist       string `json:"whitelist,omitempty" url:"whitelist,omitempty"`
}

type InputsMonitorResponse

type InputsMonitorResponse struct {
	Entry    []InputsMonitorEntry `json:"entry"`
	Messages []ErrorMessage       `json:"messages"`
}

Scripted Input Response Schema

type InputsScriptEntry

type InputsScriptEntry struct {
	Name    string                     `json:"name"`
	ACL     ACLObject                  `json:"acl"`
	Content InputsScriptObjectResponse `json:"content"`
}

type InputsScriptObject

type InputsScriptObject struct {
	Host         string `json:"host,omitempty" url:"host,omitempty"`
	Index        string `json:"index,omitempty" url:"index,omitempty"`
	Source       string `json:"source,omitempty" url:"source,omitempty"`
	SourceType   string `json:"sourcetype,omitempty" url:"sourcetype,omitempty"`
	RenameSource string `json:"rename-source,omitempty" url:"rename-source,omitempty"`
	PassAuth     string `json:"passAuth,omitempty" url:"passAuth,omitempty"`
	Disabled     bool   `json:"disabled,omitempty" url:"disabled"`
	Interval     int    `json:"interval,omitempty" url:"interval,omitempty"`
}

type InputsScriptObjectResponse added in v1.4.27

type InputsScriptObjectResponse struct {
	Host         string      `json:"host,omitempty"`
	Index        string      `json:"index,omitempty"`
	Source       string      `json:"source,omitempty"`
	SourceType   string      `json:"sourcetype,omitempty"`
	RenameSource string      `json:"rename-source,omitempty"`
	PassAuth     string      `json:"passAuth,omitempty"`
	Disabled     bool        `json:"disabled,omitempty"`
	Interval     interface{} `json:"interval,omitempty"` // Can be int or string
}

type InputsScriptResponse

type InputsScriptResponse struct {
	Entry    []InputsScriptEntry `json:"entry"`
	Messages []ErrorMessage      `json:"messages"`
}

Scripted Input Response Schema

type InputsSplunkTCPTokenEntry

type InputsSplunkTCPTokenEntry struct {
	Name    string                     `json:"name"`
	ACL     ACLObject                  `json:"acl"`
	Content InputsSplunkTCPTokenObject `json:"content"`
}

type InputsSplunkTCPTokenObject

type InputsSplunkTCPTokenObject struct {
	Name  string `json:"name,omitempty" url:"name,omitempty"`
	Token string `json:"token,omitempty" url:"token,omitempty"`
}

type InputsSplunkTCPTokenResponse

type InputsSplunkTCPTokenResponse struct {
	Entry    []InputsSplunkTCPTokenEntry `json:"entry"`
	Messages []ErrorMessage              `json:"messages"`
}

Scripted Input Response Schema

type InputsTCPCookedEntry

type InputsTCPCookedEntry struct {
	Name    string                `json:"name"`
	ACL     ACLObject             `json:"acl"`
	Content InputsTCPCookedObject `json:"content"`
}

type InputsTCPCookedObject

type InputsTCPCookedObject struct {
	Host           string `json:"host,omitempty" url:"host,omitempty"`
	Index          string `json:"index,omitempty" url:"index,omitempty"`
	Disabled       bool   `json:"disabled,omitempty" url:"disabled"`
	ConnectionHost string `json:"connection_host,omitempty" url:"connection_host,omitempty"`
	RestrictToHost string `json:"restrictToHost,omitempty" url:"restrictToHost,omitempty"`
}

type InputsTCPCookedResponse

type InputsTCPCookedResponse struct {
	Entry    []InputsTCPCookedEntry `json:"entry"`
	Messages []ErrorMessage         `json:"messages"`
}

Scripted Input Response Schema

type InputsTCPRawEntry

type InputsTCPRawEntry struct {
	Name    string             `json:"name"`
	ACL     ACLObject          `json:"acl"`
	Content InputsTCPRawObject `json:"content"`
}

type InputsTCPRawObject

type InputsTCPRawObject struct {
	Host           string `json:"host,omitempty" url:"host,omitempty"`
	Index          string `json:"index,omitempty" url:"index,omitempty"`
	Source         string `json:"source,omitempty" url:"source,omitempty"`
	SourceType     string `json:"sourcetype,omitempty" url:"sourcetype,omitempty"`
	Disabled       bool   `json:"disabled,omitempty" url:"disabled"`
	ConnectionHost string `json:"connection_host,omitempty" url:"connection_host,omitempty"`
	Queue          string `json:"queue,omitempty" url:"queue,omitempty"`
	RestrictToHost string `json:"restrictToHost,omitempty" url:"restrictToHost,omitempty"`
	RawTcpDoneTime int    `json:"rawTcpDoneTimeout,omitempty" url:"rawTcpDoneTimeout,omitempty"`
}

type InputsTCPRawResponse

type InputsTCPRawResponse struct {
	Entry    []InputsTCPRawEntry `json:"entry"`
	Messages []ErrorMessage      `json:"messages"`
}

Scripted Input Response Schema

type InputsTCPSSLEntry

type InputsTCPSSLEntry struct {
	Name    string             `json:"name"`
	ACL     ACLObject          `json:"acl"`
	Content InputsTCPSSLObject `json:"content"`
}

type InputsTCPSSLObject

type InputsTCPSSLObject struct {
	Disabled          bool   `json:"disabled,omitempty" url:"disabled"`
	RequireClientCert bool   `json:"requireClientCert,omitempty" url:"requireClientCert"`
	Password          string `json:"password,omitempty" url:"password,omitempty"`
	RootCA            string `json:"rootCA,omitempty" url:"rootCA,omitempty"`
	ServerCert        string `json:"serverCert,omitempty" url:"serverCert,omitempty"`
}

type InputsTCPSSLResponse

type InputsTCPSSLResponse struct {
	Entry    []InputsTCPSSLEntry `json:"entry"`
	Messages []ErrorMessage      `json:"messages"`
}

Scripted Input Response Schema

type InputsUDPEntry

type InputsUDPEntry struct {
	Name    string          `json:"name"`
	ACL     ACLObject       `json:"acl"`
	Content InputsUDPObject `json:"content"`
}

type InputsUDPObject

type InputsUDPObject struct {
	Host                 string `json:"host,omitempty" url:"host,omitempty"`
	Index                string `json:"index,omitempty" url:"index,omitempty"`
	Source               string `json:"source,omitempty" url:"source,omitempty"`
	SourceType           string `json:"sourcetype,omitempty" url:"sourcetype,omitempty"`
	Disabled             bool   `json:"disabled,omitempty" url:"disabled"`
	ConnectionHost       string `json:"connection_host,omitempty" url:"connection_host,omitempty"`
	Queue                string `json:"queue,omitempty" url:"queue,omitempty"`
	RestrictToHost       string `json:"restrictToHost,omitempty" url:"restrictToHost,omitempty"`
	NoAppendingTimestamp bool   `json:"no_appending_timestamp,omitempty" url:"no_appending_timestamp"`
	NoPriorityStripping  bool   `json:"no_priority_stripping,omitempty" url:"no_priority_stripping"`
}

type InputsUDPResponse

type InputsUDPResponse struct {
	Entry    []InputsUDPEntry `json:"entry"`
	Messages []ErrorMessage   `json:"messages"`
}

Scripted Input Response Schema

type LookupTableFile added in v1.4.27

type LookupTableFile struct {
	App          string `json:"namespace,omitempty" url:"namespace,omitempty"`
	Owner        string `json:"owner,omitempty" url:"owner,omitempty"`
	FileName     string `json:"lookup_file,omitempty" url:"lookup_file,omitempty"`
	FileContents string `json:"contents,omitempty" url:"contents,omitempty"`
}

type OutputsTCPDefaultEntry

type OutputsTCPDefaultEntry struct {
	Name    string                  `json:"name"`
	ACL     ACLObject               `json:"acl"`
	Content OutputsTCPDefaultObject `json:"content"`
}

type OutputsTCPDefaultObject

type OutputsTCPDefaultObject struct {
	DefaultGroup          string `json:"defaultGroup,omitempty" url:"defaultGroup,omitempty"`
	DropEventsOnQueueFull int    `json:"dropEventsOnQueueFull,omitempty" url:"dropEventsOnQueueFull,omitempty"`
	HeartbeatFrequency    int    `json:"heartbeatFrequency,omitempty" url:"heartbeatFrequency,omitempty"`
	MaxQueueSize          string `json:"maxQueueSize,omitempty" url:"maxQueueSize,omitempty"`
	Disabled              bool   `json:"disabled,omitempty" url:"disabled"`
	IndexAndForward       bool   `json:"indexAndForward,omitempty" url:"indexAndForward"`
	SendCookedData        bool   `json:"sendCookedData,omitempty" url:"sendCookedData"`
}

type OutputsTCPDefaultResponse

type OutputsTCPDefaultResponse struct {
	Entry    []OutputsTCPDefaultEntry `json:"entry"`
	Messages []ErrorMessage           `json:"messages"`
}

Outputs TCP Default Response Schema

type OutputsTCPGroupEntry

type OutputsTCPGroupEntry struct {
	Name    string                `json:"name"`
	ACL     ACLObject             `json:"acl"`
	Content OutputsTCPGroupObject `json:"content"`
}

type OutputsTCPGroupObject

type OutputsTCPGroupObject struct {
	Compressed            bool     `json:"compressed,omitempty" url:"compressed"`
	Disabled              bool     `json:"disabled,omitempty" url:"disabled"`
	DropEventsOnQueueFull int      `json:"dropEventsOnQueueFull,omitempty" url:"dropEventsOnQueueFull,omitempty"`
	HeartbeatFrequency    int      `json:"heartbeatFrequency,omitempty" url:"heartbeatFrequency,omitempty"`
	MaxQueueSize          string   `json:"maxQueueSize,omitempty" url:"maxQueueSize,omitempty"`
	Method                string   `json:"method,omitempty" url:"method,omitempty"`
	SendCookedData        bool     `json:"sendCookedData,omitempty" url:"sendCookedData"`
	Servers               []string `json:"servers,omitempty" url:"servers,omitempty"`
	Token                 string   `json:"token,omitempty" url:"token,omitempty"`
}

type OutputsTCPGroupResponse

type OutputsTCPGroupResponse struct {
	Entry    []OutputsTCPGroupEntry `json:"entry"`
	Messages []ErrorMessage         `json:"messages"`
}

Outputs TCP Group Response Schema

type OutputsTCPServerEntry

type OutputsTCPServerEntry struct {
	Name    string                 `json:"name"`
	ACL     ACLObject              `json:"acl"`
	Content OutputsTCPServerObject `json:"content"`
}

type OutputsTCPServerObject

type OutputsTCPServerObject struct {
	Disabled             bool   `json:"disabled,omitempty" url:"disabled"`
	Method               string `json:"method,omitempty" url:"method,omitempty"`
	SSLAltNameToCheck    string `json:"sslAltNameToCheck,omitempty" url:"sslAltNameToCheck,omitempty"`
	SSLCertPath          string `json:"sslCertPath,omitempty" url:"sslCertPath,omitempty"`
	SSLCipher            string `json:"sslCipher,omitempty" url:"sslCipher,omitempty"`
	SSLCommonNameToCheck string `json:"sslCommonNameToCheck,omitempty" url:"sslCommonNameToCheck,omitempty"`
	SSLPassword          string `json:"sslPassword,omitempty" url:"sslPassword,omitempty"`
	SSLRootCAPath        string `json:"sslRootCAPath,omitempty" url:"sslRootCAPath,omitempty"`
	SSLVerifyServerCert  bool   `json:"sslVerifyServerCert,omitempty" url:"sslVerifyServerCert"`
}

type OutputsTCPServerResponse

type OutputsTCPServerResponse struct {
	Entry    []OutputsTCPServerEntry `json:"entry"`
	Messages []ErrorMessage          `json:"messages"`
}

Outputs TCP Server Response Schema

type OutputsTCPSyslogEntry

type OutputsTCPSyslogEntry struct {
	Name    string                 `json:"name"`
	ACL     ACLObject              `json:"acl"`
	Content OutputsTCPSyslogObject `json:"content"`
}

type OutputsTCPSyslogObject

type OutputsTCPSyslogObject struct {
	Disabled         bool   `json:"disabled,omitempty" url:"disabled"`
	Priority         int    `json:"priority,string,omitempty" url:"priority,omitempty"`
	Server           string `json:"server,omitempty" url:"server,omitempty"`
	SyslogSourceType string `json:"syslogSourceType,omitempty" url:"syslogSourceType,omitempty"`
	TimestampFormat  string `json:"timestampformat,omitempty" url:"timestampformat,omitempty"`
	Type             string `json:"type,omitempty" url:"type,omitempty"`
}

type OutputsTCPSyslogResponse

type OutputsTCPSyslogResponse struct {
	Entry    []OutputsTCPSyslogEntry `json:"entry"`
	Messages []ErrorMessage          `json:"messages"`
}

Outputs TCP Syslog Response Schema

type Permissions

type Permissions struct {
	Read  []string `json:"read,omitempty" url:"read,omitempty"`
	Write []string `json:"write,omitempty" url:"write,omitempty"`
}

type SavedEventTypeObject added in v1.5.0

type SavedEventTypeObject struct {
	Name        string   `json:"name"`
	Description string   `json:"description" url:"description,omitempty"`
	Disabled    bool     `json:"disabled,omitempty" url:"disabled,omitempty"`
	Color       string   `json:"color,omitempty" url:"color,omitempty"`
	Priority    int      `json:"priority,omitempty" url:"priority,omitempty"`
	Search      string   `json:"search,omitempty" url:"search,omitempty"`
	Tags        []string `json:"tags,omitempty" url:"tags,omitempty"`
}

type SavedEventTypesEntry added in v1.5.0

type SavedEventTypesEntry struct {
	Name    string               `json:"name"`
	ACL     ACLObject            `json:"acl"`
	Content SavedEventTypeObject `json:"content"`
}

type SavedEventTypesResponse added in v1.5.0

type SavedEventTypesResponse struct {
	Entry    []SavedEventTypesEntry `json:"entry"`
	Messages []ErrorMessage         `json:"messages"`
}

type SavedSearchObject

type SavedSearchObject struct {
	Actions                                            string       `json:"actions,omitempty" url:"actions,omitempty"`
	ActionEmail                                        bool         `json:"action.email,omitempty" url:"action.email"`
	ActionEmailAuthPassword                            string       `json:"action.email.auth_password,omitempty" url:"action.email.auth_password,omitempty"`
	ActionEmailAuthUsername                            string       `json:"action.email.auth_username,omitempty" url:"action.email.auth_username,omitempty"`
	ActionEmailBCC                                     string       `json:"action.email.bcc,omitempty" url:"action.email.bcc,omitempty"`
	ActionEmailCC                                      string       `json:"action.email.cc,omitempty" url:"action.email.cc,omitempty"`
	ActionEmailCommand                                 string       `json:"action.email.command,omitempty" url:"action.email.command,omitempty"`
	ActionEmailFormat                                  string       `json:"action.email.format,omitempty" url:"action.email.format,omitempty"`
	ActionEmailFrom                                    string       `json:"action.email.from,omitempty" url:"action.email.from,omitempty"`
	ActionEmailHostname                                string       `json:"action.email.hostname,omitempty" url:"action.email.hostname,omitempty"`
	ActionEmailIncludeResultsLink                      FlexInt      `json:"action.email.include.results_link,omitempty" url:"action.email.include.results_link"`
	ActionEmailIncludeSearch                           FlexInt      `json:"action.email.include.search,omitempty" url:"action.email.include.search"`
	ActionEmailIncludeTrigger                          FlexInt      `json:"action.email.include.trigger,omitempty" url:"action.email.include.trigger"`
	ActionEmailIncludeTriggerTime                      FlexInt      `json:"action.email.include.trigger_time,omitempty" url:"action.email.include.trigger_time"`
	ActionEmailIncludeViewLink                         FlexInt      `json:"action.email.include.view_link,omitempty" url:"action.email.include.view_link"`
	ActionEmailInline                                  bool         `json:"action.email.inline" url:"action.email.inline"`
	ActionEmailMailserver                              string       `json:"action.email.mailserver,omitempty" url:"action.email.mailserver,omitempty"`
	ActionEmailMaxResults                              int          `json:"action.email.maxresults,omitempty" url:"action.email.maxresults,omitempty"`
	ActionEmailMaxTime                                 string       `json:"action.email.maxtime,omitempty" url:"action.email.maxtime,omitempty"`
	ActionEmailMessageAlert                            string       `json:"action.email.message.alert,omitempty" url:"action.email.message.alert,omitempty"`
	ActionEmailMessageReport                           string       `json:"action.email.message.report,omitempty" url:"action.email.message.report,omitempty"`
	ActionEmailPDFView                                 string       `json:"action.email.pdfview,omitempty" url:"action.email.pdfview,omitempty"`
	ActionEmailPreprocessResults                       string       `json:"action.email.preprocess_results,omitempty" url:"action.email.preprocess_results,omitempty"`
	ActionEmailReportCIDFontList                       string       `json:"action.email.reportCIDFontList,omitempty" url:"action.email.reportCIDFontList,omitempty"`
	ActionEmailReportPaperOrientation                  string       `json:"action.email.reportPaperOrientation,omitempty" url:"action.email.reportPaperOrientation,omitempty"`
	ActionEmailReportPaperSize                         string       `json:"action.email.reportPaperSize,omitempty" url:"action.email.reportPaperSize,omitempty"`
	ActionEmailReportServerEnabled                     bool         `json:"action.email.reportServerEnabled" url:"action.email.reportServerEnabled"`
	ActionEmailReportServerURL                         string       `json:"action.email.reportServerURL,omitempty" url:"action.email.reportServerURL,omitempty"`
	ActionEmailSendCSV                                 FlexInt      `json:"action.email.sendcsv,omitempty" url:"action.email.sendcsv,omitempty"`
	ActionEmailSendPDF                                 bool         `json:"action.email.sendpdf" url:"action.email.sendpdf"`
	ActionEmailSendResults                             bool         `json:"action.email.sendresults" url:"action.email.sendresults"`
	ActionEmailSubject                                 string       `json:"action.email.subject,omitempty" url:"action.email.subject,omitempty"`
	ActionEmailTo                                      string       `json:"action.email.to,omitempty" url:"action.email.to,omitempty"`
	ActionEmailTrackAlert                              bool         `json:"action.email.track_alert" url:"action.email.track_alert"`
	ActionEmailTTL                                     string       `json:"action.email.ttl,omitempty" url:"action.email.ttl,omitempty"`
	ActionEmailUseSSL                                  bool         `json:"action.email.use_ssl" url:"action.email.use_ssl"`
	ActionEmailUseTLS                                  bool         `json:"action.email.use_tls" url:"action.email.use_tls"`
	ActionEmailWidthSortColumns                        bool         `json:"action.email.width_sort_columns" url:"action.email.width_sort_columns"`
	ActionPagerdutyIntegrationURL                      string       `json:"action.pagerduty.param.integration_url,omitempty" url:"action.pagerduty.param.integration_url,omitempty"`
	ActionPagerdutyIntegrationURLOverride              string       `` /* 128-byte string literal not displayed */
	ActionPagerdutyParamCustDetails                    string       `json:"action.pagerduty.param.custom_details,omitempty" url:"action.pagerduty.param.custom_details,omitempty"`
	ActionPagerdutyParamIntKey                         string       `json:"action.pagerduty.param.integration_key,omitempty" url:"action.pagerduty.param.integration_key,omitempty"`
	ActionPagerdutyParamIntKeyOverride                 string       `` /* 128-byte string literal not displayed */
	ActionPopulateLookup                               bool         `json:"action.populate_lookup" url:"action.populate_lookup"`
	ActionPopulateLookupCommand                        string       `json:"action.populate_lookup.command,omitempty" url:"action.populate_lookup.command,omitempty"`
	ActionPopulateLookupDest                           string       `json:"action.populate_lookup.dest,omitempty" url:"action.populate_lookup.dest,omitempty"`
	ActionPopulateLookupHostname                       string       `json:"action.populate_lookup.hostname,omitempty" url:"action.populate_lookup.hostname,omitempty"`
	ActionPopulateLookupMaxResults                     int          `json:"action.populate_lookup.maxresults,omitempty" url:"action.populate_lookup.maxresults,omitempty"`
	ActionPopulateLookupMaxTime                        FlexDuration `json:"action.populate_lookup.maxtime,omitempty" url:"action.populate_lookup.maxtime,omitempty,omitempty"`
	ActionPopulateLookupTrackAlert                     bool         `json:"action.populate_lookup.track_alert" url:"action.populate_lookup.track_alert"`
	ActionPopulateLookupTTL                            string       `json:"action.populate_lookup.ttl,omitempty" url:"action.populate_lookup.ttl,omitempty"`
	ActionRSS                                          bool         `json:"-" url:"action.rss"`
	ActionRSSCommand                                   string       `json:"action.rss.command,omitempty" url:"action.rss.command,omitempty"`
	ActionRSSHostname                                  string       `json:"action.rss.hostname,omitempty" url:"action.rss.hostname,omitempty"`
	ActionRSSMaxResults                                int          `json:"action.rss.maxresults,omitempty" url:"action.rss.maxresults,omitempty"`
	ActionRSSMaxTime                                   FlexDuration `json:"action.rss.maxtime,omitempty" url:"action.rss.maxtime,omitempty"`
	ActionRSSTrackAlert                                bool         `json:"action.rss.track_alert" url:"action.rss.track_alert"`
	ActionRSSTTL                                       string       `json:"action.rss.ttl,omitempty" url:"action.rss.ttl,omitempty"`
	ActionScript                                       bool         `json:"-" url:"action.script"`
	ActionScriptCommand                                string       `json:"action.script.command,omitempty" url:"action.script.command,omitempty"`
	ActionScriptFilename                               string       `json:"action.script.filename,omitempty" url:"action.script.filename,omitempty"`
	ActionScriptHostname                               string       `json:"action.script.hostname,omitempty" url:"action.script.hostname,omitempty"`
	ActionScriptMaxResults                             int          `json:"action.script.maxresults,omitempty" url:"action.script.maxresults,omitempty"`
	ActionScriptMaxTime                                FlexDuration `json:"action.script.maxtime,omitempty" url:"action.script.maxtime,omitempty"`
	ActionScriptTrackAlert                             bool         `json:"action.script.track_alert" url:"action.script.track_alert"`
	ActionScriptTTL                                    string       `json:"action.script.ttl,omitempty" url:"action.script.ttl,omitempty"`
	ActionSnowEventParamAccount                        string       `json:"action.snow_event.param.account,omitempty" url:"action.snow_event.param.account,omitempty"`
	ActionSnowEventParamNode                           string       `json:"action.snow_event.param.node,omitempty" url:"action.snow_event.param.node,omitempty"`
	ActionSnowEventParamType                           string       `json:"action.snow_event.param.type,omitempty" url:"action.snow_event.param.type,omitempty"`
	ActionSnowEventParamResource                       string       `json:"action.snow_event.param.resource,omitempty" url:"action.snow_event.param.resource,omitempty"`
	ActionSnowEventParamSeverity                       FlexInt      `json:"action.snow_event.param.severity,omitempty" url:"action.snow_event.param.severity,omitempty"`
	ActionSnowEventParamDescription                    string       `json:"action.snow_event.param.description,omitempty" url:"action.snow_event.param.description,omitempty"`
	ActionSnowEventParamCiIdentifier                   string       `json:"action.snow_event.param.ci_identifier,omitempty" url:"action.snow_event.param.ci_identifier,omitempty"`
	ActionSnowEventParamCustomFields                   string       `json:"action.snow_event.param.custom_fields,omitempty" url:"action.snow_event.param.custom_fields,omitempty"`
	ActionSnowEventParamAdditionalInfo                 string       `json:"action.snow_event.param.additional_info,omitempty" url:"action.snow_event.param.additional_info,omitempty"`
	ActionSummaryIndex                                 bool         `json:"action.summary_index,omitempty" url:"action.summary_index"`
	ActionSummaryIndexName                             string       `json:"action.summary_index._name,omitempty" url:"action.summary_index._name,omitempty"`
	ActionSummaryIndexCommand                          string       `json:"action.summary_index.command,omitempty" url:"action.summary_index.command,omitempty"`
	ActionSummaryIndexHostname                         string       `json:"action.summary_index.hostname,omitempty" url:"action.summary_index.hostname,omitempty"`
	ActionSummaryIndexInline                           bool         `json:"action.summary_index.inline" url:"action.summary_index.inline"`
	ActionSummaryIndexMaxResults                       int          `json:"action.summary_index.maxresults,omitempty" url:"action.summary_index.maxresults,omitempty"`
	ActionSummaryIndexMaxTime                          FlexDuration `json:"action.summary_index.maxtime,omitempty" url:"action.summary_index.maxtime,omitempty"`
	ActionSummaryIndexTrackAlert                       bool         `json:"action.summary_index.track_alert" url:"action.summary_index.track_alert"`
	ActionSummaryIndexTTL                              string       `json:"action.summary_index.ttl,omitempty" url:"action.summary_index.ttl,omitempty"`
	ActionLogEvent                                     string       `json:"action.logevent,omitempty" url:"action.logevent"`
	ActionLogEventParamEvent                           string       `json:"action.logevent.param.event" url:"action.logevent.param.event"`
	ActionLogEventParamHost                            string       `json:"action.logevent.param.host,omitempty" url:"action.logevent.param.host"`
	ActionLogEventParamIndex                           string       `json:"action.logevent.param.index,omitempty" url:"action.logevent.param.index"`
	ActionLogEventParamSourceType                      string       `json:"action.logevent.param.sourcetype,omitempty" url:"action.logevent.param.sourcetype"`
	ActionLogEventParamSource                          string       `json:"action.logevent.param.source,omitempty" url:"action.logevent.param.source"`
	ActionCreateXsoarIncident                          string       `json:"action.create_xsoar_incident,omitempty" url:"action.create_xsoar_incident,omitempty"`
	ActionCreateXsoarIncidentParamSendAllServers       string       `` /* 136-byte string literal not displayed */
	ActionCreateXsoarIncidentParamServerUrl            string       `json:"action.create_xsoar_incident.param.server_url,omitempty" url:"action.create_xsoar_incident.param.server_url,omitempty"`
	ActionCreateXsoarIncidentParamIncidentName         string       `` /* 130-byte string literal not displayed */
	ActionCreateXsoarIncidentParamDetails              string       `json:"action.create_xsoar_incident.param.details,omitempty" url:"action.create_xsoar_incident.param.details,omitempty"`
	ActionCreateXsoarIncidentParamCustomFields         string       `` /* 130-byte string literal not displayed */
	ActionCreateXsoarIncidentParamSeverity             string       `json:"action.create_xsoar_incident.param.severity,omitempty" url:"action.create_xsoar_incident.param.severity,omitempty"`
	ActionCreateXsoarIncidentParamOccurred             string       `json:"action.create_xsoar_incident.param.occurred,omitempty" url:"action.create_xsoar_incident.param.occurred,omitempty"`
	ActionCreateXsoarIncidentParamType                 string       `json:"action.create_xsoar_incident.param.type,omitempty" url:"action.create_xsoar_incident.param.type,omitempty"`
	ActionSlackParamAttachment                         string       `json:"action.slack.param.attachment,omitempty" url:"action.slack.param.attachment,omitempty"`
	ActionSlackParamChannel                            string       `json:"action.slack.param.channel,omitempty" url:"action.slack.param.channel,omitempty"`
	ActionSlackParamFields                             string       `json:"action.slack.param.fields,omitempty" url:"action.slack.param.fields,omitempty"`
	ActionSlackParamMessage                            string       `json:"action.slack.param.message,omitempty" url:"action.slack.param.message,omitempty"`
	ActionSlackParamWebhookUrlOverride                 string       `json:"action.slack.param.webhook_url_override,omitempty" url:"action.slack.param.webhook_url_override,omitempty"`
	ActionSlackAppAlertIntegrationParamAutoJoinChannel string       `` /* 150-byte string literal not displayed */
	ActionSlackAppAlertIntegrationParamBotUsername     string       `` /* 140-byte string literal not displayed */
	ActionSlackAppAlertIntegrationParamChannel         string       `` /* 130-byte string literal not displayed */
	ActionSlackAppAlertIntegrationParamEmoji           string       `` /* 126-byte string literal not displayed */
	ActionSlackAppAlertIntegrationParamMessage         string       `` /* 130-byte string literal not displayed */
	ActionJiraServiceDeskParamAccount                  string       `json:"action.jira_service_desk.param.account,omitempty" url:"action.jira_service_desk.param.account,omitempty"`
	ActionJiraServiceDeskParamJiraProject              string       `json:"action.jira_service_desk.param.jira_project,omitempty" url:"action.jira_service_desk.param.jira_project,omitempty"`
	ActionJiraServiceDeskParamJiraIssueType            string       `` /* 126-byte string literal not displayed */
	ActionJiraServiceDeskParamJiraSummary              string       `json:"action.jira_service_desk.param.jira_summary,omitempty" url:"action.jira_service_desk.param.jira_summary,omitempty"`
	ActionJiraServiceDeskParamJiraPriority             string       `json:"action.jira_service_desk.param.jira_priority,omitempty" url:"action.jira_service_desk.param.jira_priority,omitempty"`
	ActionJiraServiceDeskParamJiraDescription          string       `` /* 128-byte string literal not displayed */
	ActionJiraServiceDeskParamJiraDedup                string       `json:"action.jira_service_desk.param.jira_dedup,omitempty" url:"action.jira_service_desk.param.jira_dedup,omitempty"`
	ActionJiraServiceDeskParamJiraCustomfields         string       `` /* 130-byte string literal not displayed */
	ActionVictoropsParamMessageType                    string       `json:"action.victorops.param.message_type,omitempty" url:"action.victorops.param.message_type,omitempty"`
	ActionVictoropsParamMonitoringTool                 string       `json:"action.victorops.param.monitoring_tool,omitempty" url:"action.victorops.param.monitoring_tool,omitempty"`
	ActionVictoropsParamEntityId                       string       `json:"action.victorops.param.entity_id,omitempty" url:"action.victorops.param.entity_id,omitempty"`
	ActionVictoropsParamStateMessage                   string       `json:"action.victorops.param.state_message,omitempty" url:"action.victorops.param.state_message,omitempty"`
	ActionVictoropsParamRecordId                       string       `json:"action.victorops.param.record_id,omitempty" url:"action.victorops.param.record_id,omitempty"`
	ActionVictoropsParamRoutingKeyOverride             string       `json:"action.victorops.param.routing_key_override,omitempty" url:"action.victorops.param.routing_key_override,omitempty"`
	ActionVictoropsParamEnableRecovery                 string       `json:"action.victorops.param.enable_recovery,omitempty" url:"action.victorops.param.enable_recovery,omitempty"`
	ActionVictoropsParamPollInterval                   string       `json:"action.victorops.param.poll_interval,omitempty" url:"action.victorops.param.poll_interval,omitempty"`
	ActionVictoropsParamInactivePolls                  string       `json:"action.victorops.param.inactive_polls,omitempty" url:"action.victorops.param.inactive_polls,omitempty"`
	ActionBetterWebhookParamUrl                        string       `json:"action.better_webhook.param.url,omitempty" url:"action.better_webhook.param.url,omitempty"`
	ActionBetterWebhookParamBodyFormat                 string       `json:"action.better_webhook.param.body_format,omitempty" url:"action.better_webhook.param.body_format,omitempty"`
	ActionBetterWebhookParamCredential                 string       `json:"action.better_webhook.param.credential,omitempty" url:"action.better_webhook.param.credential,omitempty"`
	ActionBetterWebhookParamCredentials                string       `json:"action.better_webhook.param.credentials,omitempty" url:"action.better_webhook.param.credentials,omitempty"`
	ActionWebhookParamUrl                              string       `json:"action.webhook.param.url,omitempty" url:"action.webhook.param.url"`
	ActionRunAiagentParamAgentName                     string       `json:"action.run_aiagent.param.agent_name,omitempty" url:"action.run_aiagent.param.agent_name,omitempty"`
	ActionRunAiagentParamPrompt                        string       `json:"action.run_aiagent.param.prompt,omitempty" url:"action.run_aiagent.param.prompt,omitempty"`
	AlertDigestMode                                    bool         `json:"alert.digest_mode" url:"alert.digest_mode"`
	AlertExpires                                       string       `json:"alert.expires,omitempty" url:"alert.expires,omitempty"`
	AlertSeverity                                      int          `json:"alert.severity,omitempty" url:"alert.severity,omitempty"`
	AlertSuppress                                      bool         `json:"alert.suppress" url:"alert.suppress"`
	AlertSuppressFields                                string       `json:"alert.suppress.fields,omitempty" url:"alert.suppress.fields,omitempty"`
	AlertSuppressPeriod                                string       `json:"alert.suppress.period,omitempty" url:"alert.suppress.period,omitempty"`
	AlertTrack                                         bool         `json:"alert.track" url:"alert.track"`
	AlertComparator                                    string       `json:"alert_comparator,omitempty" url:"alert_comparator,omitempty"`
	AlertCondition                                     string       `json:"alert_condition,omitempty" url:"alert_condition,omitempty"`
	AlertThreshold                                     string       `json:"alert_threshold,omitempty" url:"alert_threshold,omitempty"`
	AlertType                                          string       `json:"alert_type,omitempty" url:"alert_type,omitempty"`
	AllowSkew                                          string       `json:"allow_skew,omitempty" url:"allow_skew,omitempty"`
	AutoSummarize                                      bool         `json:"auto_summarize,omitempty" url:"auto_summarize,omitempty"`
	AutoSummarizeCommand                               string       `json:"auto_summarize.command,omitempty" url:"auto_summarize.command,omitempty"`
	AutoSummarizeCronSchedule                          string       `json:"auto_summarize.cron_schedule,omitempty" url:"auto_summarize.cron_schedule,omitempty"`
	AutoSummarizeDispatchEarliestTime                  string       `json:"auto_summarize.dispatch.earliest_time,omitempty" url:"auto_summarize.dispatch.earliest_time,omitempty"`
	AutoSummarizeDispatchLatestTime                    string       `json:"auto_summarize.dispatch.latest_time,omitempty" url:"auto_summarize.dispatch.latest_time,omitempty"`
	AutoSummarizeDispatchTimeFormat                    string       `json:"auto_summarize.dispatch.time_format,omitempty" url:"auto_summarize.dispatch.time_format,omitempty"`
	AutoSummarizeDispatchTTL                           string       `json:"auto_summarize.dispatch.ttl,omitempty" url:"auto_summarize.dispatch.ttl,omitempty"`
	AutoSummarizeMaxDisabledBuckets                    int          `json:"auto_summarize.max_disabled_buckets,omitempty" url:"auto_summarize.max_disabled_buckets,omitempty"`
	AutoSummarizeMaxSummaryRatio                       float64      `json:"auto_summarize.max_summary_ratio,omitempty" url:"auto_summarize.max_summary_ratio,omitempty"`
	AutoSummarizeMaxSummarySize                        int          `json:"auto_summarize.max_summary_size,omitempty" url:"auto_summarize.max_summary_size,omitempty"`
	AutoSummarizeMaxTime                               FlexInt      `json:"auto_summarize.max_time,omitempty" url:"auto_summarize.max_time,omitempty"`
	AutoSummarizeSuspendPeriod                         string       `json:"auto_summarize.suspend_period,omitempty" url:"auto_summarize.suspend_period,omitempty"`
	AutoSummarizeTimespan                              string       `json:"auto_summarize.timespan,omitempty" url:"auto_summarize.timespan,omitempty"`
	CronSchedule                                       string       `json:"cron_schedule,omitempty" url:"cron_schedule,omitempty"`
	Description                                        string       `json:"description,omitempty" url:"description,omitempty"`
	Disabled                                           bool         `json:"disabled" url:"disabled"`
	DispatchBuckets                                    int          `json:"dispatch.buckets,omitempty" url:"dispatch.buckets,omitempty"`
	DispatchEarliestTime                               string       `json:"dispatch.earliest_time,omitempty" url:"dispatch.earliest_time,omitempty"`
	DispatchIndexEarliest                              string       `json:"dispatch.index_earliest,omitempty" url:"dispatch.index_earliest,omitempty"`
	DispatchIndexLatest                                string       `json:"dispatch.index_latest,omitempty" url:"dispatch.index_latest,omitempty"`
	DispatchIndexedRealtime                            bool         `json:"dispatch.indexedRealtime" url:"dispatch.indexedRealtime"`
	DispatchIndexedRealtimeOffset                      FlexInt      `json:"dispatch.indexedRealtimeOffset" url:"dispatch.indexedRealtimeOffset,omitempty"`
	DispatchIndexedRealtimeMinspan                     FlexInt      `json:"dispatch.indexedRealtimeMinspan" url:"dispatch.indexedRealtimeMinspan,omitempty"`
	DispatchLatestTime                                 string       `json:"dispatch.latest_time,omitempty" url:"dispatch.latest_time,omitempty"`
	DispatchLookups                                    bool         `json:"dispatch.lookups" url:"dispatch.lookups"`
	DispatchMaxCount                                   int          `json:"dispatch.max_count,omitempty" url:"dispatch.max_count,omitempty"`
	DispatchMaxTime                                    int          `json:"dispatch.max_time,omitempty" url:"dispatch.max_time,omitempty"`
	DispatchReduceFreq                                 int          `json:"dispatch.reduce_freq,omitempty" url:"dispatch.reduce_freq,omitempty"`
	DispatchRtBackfill                                 bool         `json:"dispatch.rt_backfill" url:"dispatch.rt_backfill"`
	DispatchRtMaximumSpan                              int          `json:"dispatch.rt_maxtimespan" url:"dispatch.rt_maxtimespan,omitempty"`
	DispatchSpawnProcess                               bool         `json:"dispatch.spawn_process" url:"dispatch.spawn_process"`
	DispatchTimeFormat                                 string       `json:"dispatch.time_format,omitempty" url:"dispatch.time_format,omitempty"`
	DispatchTTL                                        string       `json:"dispatch.ttl,omitempty" url:"dispatch.ttl,omitempty"`
	DisplayView                                        string       `json:"displayview,omitempty" url:"displayview,omitempty"`
	IsScheduled                                        bool         `json:"is_scheduled" url:"is_scheduled"`
	IsVisible                                          bool         `json:"is_visible" url:"is_visible"`
	MaxConcurrent                                      int          `json:"max_concurrent,omitempty" url:"max_concurrent,omitempty"`
	NextScheduledTime                                  string       `json:"next_scheduled_time,omitempty" url:"next_scheduled_time,omitempty"`
	QualifiedSearch                                    string       `json:"qualifiedSearch,omitempty" url:"qualifiedSearch,omitempty"`
	RealtimeSchedule                                   bool         `json:"realtime_schedule" url:"realtime_schedule"`
	RequestUIDispatchApp                               string       `json:"request.ui_dispatch_app,omitempty" url:"request.ui_dispatch_app,omitempty"`
	RequestUIDispatchView                              string       `json:"request.ui_dispatch_view,omitempty" url:"request.ui_dispatch_view,omitempty"`
	RestartOnSearchPeerAdd                             bool         `json:"restart_on_searchpeer_add" url:"restart_on_searchpeer_add"`
	RunOnStartup                                       bool         `json:"run_on_startup" url:"run_on_startup"`
	ScheduleWindow                                     string       `json:"schedule_window,omitempty" url:"schedule_window,omitempty"`
	SchedulePriority                                   string       `json:"schedule_priority,omitempty" url:"schedule_priority,omitempty"`
	Search                                             string       `json:"search,omitempty" url:"search,omitempty"`
	VSID                                               string       `json:"vsid,omitempty" url:"vsid,omitempty"`
	WorkloadPool                                       string       `json:"workload_pool,omitempty" url:"workload_pool,omitempty"`
}

type SavedSearchesEntry

type SavedSearchesEntry struct {
	Name    string            `json:"name"`
	ACL     ACLObject         `json:"acl"`
	Content SavedSearchObject `json:"content"`
}

type SavedSearchesResponse

type SavedSearchesResponse struct {
	Entry    []SavedSearchesEntry `json:"entry"`
	Messages []ErrorMessage       `json:"messages"`
}

type ShIndexesManagerEntry added in v1.4.2

type ShIndexesManagerEntry struct {
	Name    string                 `json:"name"`
	Id      string                 `json:"id"`
	ACL     ACLObject              `json:"acl"`
	Content ShIndexesManagerObject `json:"content"`
}

type ShIndexesManagerObject added in v1.4.2

type ShIndexesManagerObject struct {
	Datatype               string `json:"datatype,omitempty" url:"datatype,omitempty"`
	FrozenTimePeriodInSecs string `json:"frozenTimePeriodInSecs,omitempty" url:"frozenTimePeriodInSecs,omitempty"`
	MaxGlobalRawDataSizeMB string `json:"maxGlobalRawDataSizeMB,omitempty" url:"maxGlobalRawDataSizeMB,omitempty"`
}

type ShIndexesManagerResponse added in v1.4.2

type ShIndexesManagerResponse struct {
	Entry    []ShIndexesManagerEntry `json:"entry"`
	Messages []ErrorMessage          `json:"messages"`
}

type SplunkDashboardsObject added in v1.3.9

type SplunkDashboardsObject struct {
	Name    string `json:"name,omitempty" url:"name,omitempty"`
	EAIData string `json:"eai:data,omitempty" url:"eai:data,omitempty"`
}

type SplunkLookupDefinitionEntry added in v1.4.28

type SplunkLookupDefinitionEntry struct {
	Name    string                       `json:"name"`
	ACL     ACLObject                    `json:"acl"`
	Content SplunkLookupDefinitionObject `json:"content"`
}

type SplunkLookupDefinitionObject added in v1.4.28

type SplunkLookupDefinitionObject struct {
	Name     string `json:"name,omitempty" url:"name,omitempty"`
	Filename string `json:"filename,omitempty" url:"filename,omitempty"`
}

type SplunkLookupDefinitionResponse added in v1.4.28

type SplunkLookupDefinitionResponse struct {
	Entry    []SplunkLookupDefinitionEntry `json:"entry"`
	Messages []ErrorMessage                `json:"messages"`
}

Jump to

Keyboard shortcuts

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