types

package

Go to main page

Versions in this module

v0

v0.5.81

Sep 5, 2026

v0.5.9

Sep 8, 2026

Changes in this version

+ var SupportedLanguages = map[string]struct

type UserMePatchRequest

+ PreferredLanguage string

type UserMeResponse

+ PreferredLanguage string

v0.5.8

Sep 3, 2026

Changes in this version

+ type AlertChannelCreateRequest struct

+ Config json.RawMessage

+ Enabled bool

+ EnvironmentID uint

+ Info string

+ Name string

+ Type string

+ type AlertChannelTestRequest struct

+ Config json.RawMessage

+ ID uint

+ Type string

+ type AlertChannelTypeSpec struct

+ Description string

+ Fields []AlertFieldSpec

+ HasSecret bool

+ SecretFields []string

+ Type string

+ type AlertFieldSpec struct

+ Default any

+ Help string

+ Label string

+ Name string

+ Placeholder string

+ Required bool

+ Type string

+ type AlertRuleCreateRequest struct

+ ChannelIDs []uint

+ CooldownMinutes int

+ Enabled bool

+ EnvironmentID uint

+ Info string

+ MatchField string

+ MatchType string

+ MatchValue string

+ Name string

+ NodeUUID string

+ Source string

+ StatusSeverity string

type LogSinkCreateRequest

+ Categories []string

type LogSinkTypeSpec

+ Categories []string

type LogSinkUpdateRequest

+ Categories []string

type OsqueryTable

+ Cacheable bool

+ Columns []OsqueryTableColumn

+ Description string

+ Evented bool

+ Examples []string

+ Notes string

+ type OsqueryTableColumn struct

+ Description string

+ Hidden bool

+ Index bool

+ Name string

+ Notes string

+ Required bool

+ Type string

v0.5.7

Aug 24, 2026

Changes in this version

+ type LogSinkCloneRequest struct

+ Overwrite bool

+ SourceEnvironmentID uint

+ TargetEnvironmentID uint

+ type LogSinkCreateRequest struct

+ Config json.RawMessage

+ Enabled bool

+ EnvironmentID uint

+ Info string

+ Name string

+ Order int

+ Type string

+ type LogSinkFieldSpec struct

+ Default any

+ Help string

+ Label string

+ Name string

+ Options []string

+ Placeholder string

+ Required bool

+ Secret bool

+ Type string

+ type LogSinkTypeSpec struct

+ Description string

+ Fields []LogSinkFieldSpec

+ HasSecret bool

+ SecretFields []string

+ Type string

+ type LogSinkUpdateRequest struct

+ Config json.RawMessage

+ Enabled bool

+ Info string

+ Name string

+ Order int

+ Type string

v0.5.6

Aug 19, 2026

Changes in this version

+ type ApiAddPackageRequest struct

+ Arch string

+ IsDefault bool

+ Type string

+ URL string

+ type ApiUpdatePackageRequest struct

+ URL string

+ type ServiceCommandResponse struct

+ Action string

+ CommandID string

+ ConsumedAt *time.Time

+ ConsumedBy string

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ RecoveredAt *time.Time

+ RecoveredBy string

+ RequestedBy string

+ RequestedFrom string

+ Status string

+ TargetService string

+ type ServiceConfigApplyRequest struct

+ Service string

+ type ServiceConfigApplyResponse struct

+ Command *ServiceCommandResponse

+ Message string

+ Service string

+ type ServiceConfigPersistRequest struct

+ Service string

+ type ServiceConfigPersistResponse struct

+ Command *ServiceCommandResponse

+ Message string

+ Service string

+ type ServiceConfigStatusResponse struct

+ CheckedAt time.Time

+ FilePath string

+ FileReason string

+ FileWritable bool

+ PendingChanges bool

+ Service string

+ type ServiceConfigUpdateRequest struct

+ Value json.RawMessage

v0.5.5

Aug 5, 2026

Changes in this version

type LogResultData

+ Snapshot json.RawMessage

+ type NodeHealth struct

+ Reason string

+ Signals []string

+ Status string

+ func CalculateNodeHealth(n nodes.OsqueryNode, inactiveHours int64, postureEnabled bool, ...) NodeHealth

+ type NodePostureSummary struct

+ RiskLevel string

+ type NodeUptime struct

+ Days int

+ Hours int

+ LastSeen time.Time

+ Minutes int

+ Seconds int

+ TotalSeconds int64

type NodeView

+ CountryCode string

+ Health NodeHealth

+ Posture *NodePostureSummary

+ Tags []tags.AdminTag

+ Uptime *NodeUptime

+ func ProjectNodeWithCountry(n nodes.OsqueryNode, countryCode string) NodeView

+ func ProjectNodeWithCountryAndUptime(n nodes.OsqueryNode, countryCode string, uptime *NodeUptime) NodeView

+ func ProjectNodeWithCountryUptimeAndPosture(n nodes.OsqueryNode, countryCode string, uptime *NodeUptime, ...) NodeView

+ func ProjectNodeWithCountryUptimePostureTagsAndHealth(n nodes.OsqueryNode, countryCode string, uptime *NodeUptime, ...) NodeView

+ func ProjectNodeWithUptime(n nodes.OsqueryNode, uptime *NodeUptime) NodeView

+ func ProjectNodesWithCountry(in []nodes.OsqueryNode, lookup func(ip string) string) []NodeView

+ func ProjectNodesWithCountryAndUptime(in []nodes.OsqueryNode, lookup func(ip string) string, ...) []NodeView

+ func ProjectNodesWithCountryUptimeAndPosture(in []nodes.OsqueryNode, lookup func(ip string) string, ...) []NodeView

+ func ProjectNodesWithCountryUptimePostureTagsAndHealth(in []nodes.OsqueryNode, lookup func(ip string) string, ...) []NodeView

v0.5.4

Jul 6, 2026

Changes in this version

+ type DistributedQueryView struct

+ Targets []QueryTargetView

type NodeView

+ NodeKey string

+ type QueryTargetView struct

+ Type string

+ Value string

v0.5.3

Jun 12, 2026

Changes in this version

type AdminUserView

+ AuthSource string

type ApiUserRequest

+ AdminAccess *bool

+ CarveAccess *bool

+ QueryAccess *bool

+ UserAccess *bool

+ type GetPermissionsResponse struct

+ Permissions map[string]EnvAccessView

+ Username string

+ type SetPermissionsAllRequest struct

+ Access EnvAccessView

+ type SetPermissionsAllResponse struct

+ Access EnvAccessView

+ Total int

+ Updated int

type UserMeResponse

+ Permissions map[string]EnvAccessView

v0.5.2

May 18, 2026

Changes in this version

+ type AdminUserView struct

+ Admin bool

+ CreatedAt time.Time

+ Email string

+ EnvironmentID uint

+ Fullname string

+ ID uint

+ Service bool

+ TokenExpire time.Time

+ UUID string

+ UpdatedAt time.Time

+ Username string

+ type ApiEnvRequest struct

+ Action string

+ Hostname string

+ Icon string

+ Name string

+ Type string

+ UUID string

type ApiErrorResponse

+ Code string

type ApiLoginResponse

+ CSRFToken string

+ type AuditLogView struct

+ CreatedAt time.Time

+ EnvUUID string

+ EnvironmentID uint

+ ID uint

+ Line string

+ LogType uint

+ Service string

+ Severity uint

+ SourceIP string

+ Username string

+ type AuditLogsPagedResponse struct

+ Items []AuditLogView

+ Page int

+ PageSize int

+ TotalItems int64

+ TotalPages int

+ type BIOSInfo struct

+ Address string

+ Date string

+ Revision string

+ Size string

+ Vendor string

+ Version string

+ VolumeSize string

+ type CarveDetailResponse struct

+ Files []CarveFileView

+ Query queries.DistributedQuery

+ type CarveFileView struct

+ Archived bool

+ BlockSize int

+ CarveID string

+ CarveSize int

+ CompletedAt time.Time

+ CompletedBlocks int

+ CreatedAt time.Time

+ Path string

+ SessionID string

+ Status string

+ TotalBlocks int

+ UUID string

+ type CarvesPagedResponse struct

+ Items []queries.DistributedQuery

+ Page int

+ PageSize int

+ TotalItems int64

+ TotalPages int

+ type EnvAccessView struct

+ Admin bool

+ Carve bool

+ Query bool

+ User bool

+ type EnvConfigPatchRequest struct

+ ATC *string

+ Decorators *string

+ Flags *string

+ Options *string

+ Packs *string

+ Schedule *string

+ type EnvConfigResponse struct

+ ATC string

+ Decorators string

+ Flags string

+ Options string

+ Packs string

+ Schedule string

+ type EnvCreateRequest struct

+ Hostname string

+ Icon string

+ Name string

+ Type string

+ type EnvExpirationPatchRequest struct

+ Action string

+ type EnvIntervalsPatchRequest struct

+ ConfigInterval *int

+ LogInterval *int

+ QueryInterval *int

+ type EnvUpdateRequest struct

+ AcceptEnrolls *bool

+ DebugHTTP *bool

+ Hostname *string

+ Icon *string

+ Name *string

+ Type *string

+ type LoginEnvironment struct

+ Name string

+ UUID string

+ type NodeEnrichment struct

+ BIOS *BIOSInfo

+ OS *OSInfo

+ Osquery *OsqueryRuntime

+ System *SystemInfo

+ type NodeView struct

+ Enrichment *NodeEnrichment

+ func ProjectNode(n nodes.OsqueryNode) NodeView

+ func ProjectNodes(in []nodes.OsqueryNode) []NodeView

+ type NodesPagedResponse struct

+ Items []NodeView

+ Page int

+ PageSize int

+ TotalItems int64

+ TotalPages int

+ type OSInfo struct

+ Codename string

+ Major string

+ Minor string

+ Name string

+ Patch string

+ Platform string

+ PlatformLike string

+ Version string

+ type OsqueryConfigRequest struct

+ Configuration string

+ Integrity string

+ type OsqueryRuntime struct

+ BuildDistro string

+ BuildPlatform string

+ ConfigValid string

+ Extensions string

+ StartTime string

+ Version string

+ type PasswordChangeRequest struct

+ CurrentPassword string

+ NewPassword string

+ type QueriesPagedResponse struct

+ Items []queries.DistributedQuery

+ Page int

+ PageSize int

+ TotalItems int64

+ TotalPages int

+ type QueryResultsResponse struct

+ Items []map[string]any

+ Page int

+ PageSize int

+ Since string

+ TotalItems int64

+ TotalPages int

+ type SavedQueriesPagedResponse struct

+ Items []SavedQueryView

+ Page int

+ PageSize int

+ TotalItems int64

+ TotalPages int

+ type SavedQueryCreateRequest struct

+ Name string

+ Query string

+ type SavedQueryUpdateRequest struct

+ Query string

+ type SavedQueryView struct

+ CreatedAt time.Time

+ Creator string

+ EnvironmentID uint

+ ExtraData string

+ ID uint

+ Name string

+ Query string

+ UpdatedAt time.Time

+ type SetPermissionsRequest struct

+ Access EnvAccessView

+ EnvUUID string

+ type SettingPatchRequest struct

+ Boolean *bool

+ Integer *int64

+ String *string

+ Type string

+ type SystemInfo struct

+ CPUBrand string

+ CPULogicalCores string

+ CPUPhysicalCores string

+ CPUSubtype string

+ CPUType string

+ ComputerName string

+ HardwareModel string

+ HardwareSerial string

+ HardwareVendor string

+ HardwareVersion string

+ LocalHostname string

+ PhysicalMemory string

+ type TLSEnvironmentView struct

+ AcceptEnrolls bool

+ CarvesTLS bool

+ ConfigInterval int

+ ConfigTLS bool

+ CreatedAt time.Time

+ DebugHTTP bool

+ EnrollExpire time.Time

+ Hostname string

+ ID uint

+ Icon string

+ LogInterval int

+ LoggingTLS bool

+ Name string

+ QueryInterval int

+ QueryTLS bool

+ RemoveExpire time.Time

+ Type string

+ UUID string

+ UpdatedAt time.Time

+ type TokenResponse struct

+ Expires time.Time

+ Token string

+ type UserMePatchRequest struct

+ Email string

+ Fullname string

+ type UserMeResponse struct

+ Admin bool

+ Email string

+ Fullname string

+ LastAccess time.Time

+ Service bool

+ TokenExpire time.Time

+ UUID string

+ Username string

v0.5.1

Mar 31, 2026

v0.5.0

Feb 24, 2026

v0.4.9

Dec 24, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

v0.4.8

Nov 5, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

v0.4.7

Sep 30, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

Changes in this version

type ApiDistributedQueryRequest

+ Path string

+ Tags []string

type ApiNodeTagRequest

+ Custom string

type ApiTagsRequest

+ Custom string

+ Env string

v0.4.6

Sep 2, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

Changes in this version

+ type ApiNodeTagRequest struct

+ Tag string

+ Type uint

+ UUID string

+ type ApiUserRequest struct

+ API bool

+ Admin bool

+ Email string

+ Environments []string

+ Fullname string

+ NotAdmin bool

+ NotService bool

+ Password string

+ Service bool

+ Username string

+ type BuildMetadata struct

+ Commit string

+ Date string

+ Version string

v0.4.5

Aug 9, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

Changes in this version

+ type ApiLookupRequest struct

+ Identifier string

v0.4.4

Mar 26, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

v0.4.3

Feb 22, 2025 GO-2026-4576 +1 more

GO-2026-4576: osctrl has Stored Cross-Site Scripting (XSS) in On-Demand Query List in github.com/jmpsec/osctrl

GO-2026-4579: osctrl is Vulnerable to OS Command Injection via Environment Configuration in github.com/jmpsec/osctrl

Changes in this version

+ const LogFormatConsole

+ const LogFormatJSON

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ const QueryLog

+ const ResultLog

+ const StatusLog

+ type AcceleratedQueryReadResponse struct

+ Accelerate int

+ NodeInvalid bool

+ Queries queries.QueryReadQueries

+ type ApiActionsRequest struct

+ Certificate string

+ DebPkgURL string

+ MacPkgURL string

+ MsiPkgURL string

+ RpmPkgURL string

+ type ApiDataResponse struct

+ Data string

+ type ApiDistributedCarveRequest struct

+ ExpHours int

+ Path string

+ UUID string

+ type ApiDistributedQueryRequest struct

+ Environments []string

+ ExpHours int

+ Hidden bool

+ Hosts []string

+ Platforms []string

+ Query string

+ UUIDs []string

+ type ApiErrorResponse struct

+ Error string

+ type ApiGenericResponse struct

+ Message string

+ type ApiLoginRequest struct

+ ExpHours int

+ Password string

+ Username string

+ type ApiLoginResponse struct

+ Token string

+ type ApiNodeGenericRequest struct

+ UUID string

+ type ApiQueriesResponse struct

+ Name string

+ type ApiTagsRequest struct

+ Color string

+ Description string

+ EnvUUID string

+ Icon string

+ Name string

+ TagType uint

+ type CarveBlockRequest struct

+ BlockID int

+ Data string

+ RequestID string

+ SessionID string

+ type CarveBlockResponse struct

+ Success bool

+ type CarveInitRequest struct

+ BlockCount int

+ BlockSize int

+ CarveID string

+ CarveSize int

+ NodeKey string

+ RequestID string

+ type CarveInitResponse struct

+ SessionID string

+ Success bool

+ type CertRequest FlagsRequest

+ type ConfigRequest GenericRequest

+ type ConfigResponse GenericResponse

+ type EnrollRequest struct

+ EnrollSecret string

+ HostDetails struct{ ... }

+ HostIdentifier string

+ PlatformType string

+ type EnrollResponse struct

+ NodeInvalid bool

+ NodeKey string

+ type FlagsRequest struct

+ CertFile string

+ SecrefFile string

+ Secret string

+ type GenericRequest struct

+ NodeKey string

+ type GenericResponse struct

+ NodeInvalid bool

+ type JSONConfigurationAPI struct

+ Auth string

+ Carver string

+ Host string

+ Listener string

+ LogFormat string

+ LogLevel string

+ Port string

+ type JSONConfigurationAdmin struct

+ Auth string

+ Carver string

+ Host string

+ Listener string

+ LogFormat string

+ LogLevel string

+ Logger string

+ Port string

+ SessionKey string

+ type JSONConfigurationHeaders struct

+ AdminGroup string

+ DefaultEnv string

+ DisplayName string

+ DistinguishedName string

+ Email string

+ FirstName string

+ Groups string

+ LastName string

+ TrustedPrefix string

+ UserGroup string

+ UserName string

+ type JSONConfigurationJWT struct

+ HoursToExpire int

+ JWTSecret string

+ type JSONConfigurationTLS struct

+ Auth string

+ Carver string

+ Host string

+ Listener string

+ LogFormat string

+ LogLevel string

+ Logger string

+ MetricsEnabled bool

+ MetricsListener string

+ MetricsPort string

+ Port string

+ type KafkaConfiguration struct

+ BoostrapServer string

+ ConnectionTimeout time.Duration

+ SASL KafkaSASLConfigurations

+ SSLCALocation string

+ Topic string

+ type KafkaSASLConfigurations struct

+ Mechanism string

+ Password string

+ Username string

+ type LogDecorations struct

+ ConfigHash string

+ DaemonHash string

+ Hostname string

+ LocalHostname string

+ OsqueryUser string

+ OsqueryVersion string

+ Username string

+ type LogGenericData struct

+ Decorations LogDecorations

+ HostIdentifier string

+ Version string

+ type LogRequest struct

+ Data json.RawMessage

+ LogType string

+ NodeKey string

+ type LogResponse GenericResponse

+ type LogResultData struct

+ Action string

+ CalendarTime string

+ Columns json.RawMessage

+ Counter int

+ Decorations LogDecorations

+ Epoch int64

+ HostIdentifier string

+ Name string

+ UnixTime StringInt

+ type LogStatusData struct

+ CalendarTime string

+ Decorations LogDecorations

+ Filename string

+ HostIdentifier string

+ Line StringInt

+ Message string

+ Severity StringInt

+ UnixTime StringInt

+ Version string

+ type OSVersionTable struct

+ Codename string

+ ID string

+ Major string

+ Minor string

+ Name string

+ Patch string

+ Platform string

+ PlatformLike string

+ Version string

+ type OsqueryInfoTable struct

+ BuildDistro string

+ BuildPlatform string

+ ConfigHash string

+ ConfigValid string

+ Extension string

+ InstanceID string

+ PID string

+ StartTime string

+ UUID string

+ Version string

+ Watcher string

+ type OsqueryTable struct

+ Filter string

+ Name string

+ Platforms []string

+ URL string

+ type PlatformInfoTable struct

+ Address string

+ Date string

+ Extra string

+ Revision string

+ Size string

+ Vendor string

+ Version string

+ VolumeSize string

+ type QueryCarveScheduled struct

+ Carve string

+ CarveGUID string

+ Path string

+ RequestID string

+ SHA256 string

+ Size string

+ Status string

+ Time string

+ type QueryReadRequest GenericRequest

+ type QueryReadResponse struct

+ NodeInvalid bool

+ Queries queries.QueryReadQueries

+ type QueryWriteData struct

+ Message string

+ Name string

+ Result json.RawMessage

+ Status int

+ type QueryWriteMessages map[string]string

+ type QueryWriteQueries map[string]json.RawMessage

+ type QueryWriteRequest struct

+ Messages QueryWriteMessages

+ NodeKey string

+ Queries QueryWriteQueries

+ Statuses QueryWriteStatuses

+ type QueryWriteResponse GenericResponse

+ type QueryWriteStatuses map[string]int

+ type S3Configuration struct

+ AccessKey string

+ Bucket string

+ Region string

+ SecretAccessKey string

+ type ScriptRequest struct

+ Certificate string

+ FlagsFile string

+ SecrefFile string

+ Secret string

+ type StringInt int

+ func (si *StringInt) UnmarshalJSON(b []byte) error

+ type SystemInfoTable struct

+ CPUBrand string

+ CPULogicalCores string

+ CPUPhysicalCores string

+ CPUSubtype string

+ CPUType string

+ ComputerName string

+ HardwareModel string

+ HardwareSerial string

+ HardwareVendor string

+ HardwareVersion string

+ Hostname string

+ LocalHostname string

+ PhysicalMemory string

+ UUID string

+ type VerifyRequest FlagsRequest

+ type VerifyResponse struct

+ Certificate string

+ Flags string

+ OsqueryVersion string

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