Versions in this module Expand all Collapse all v1 v1.1.0-rc.1 Aug 24, 2026 v1.0.0 Aug 12, 2026 Changes in this version + const AlertSeverityCritical + const AlertSeverityWarning + const AlertStateDetected + const AlertStateResolved + const AlertStateTriggered + const AlertTimelineAlertSortByComponent + const AlertTimelineAlertSortByLastUpdate + const AlertTimelineAlertSortByStartTime + const AlertTimelineNodeSortByAlert + const AlertTimelineNodeSortByComputeZone + const AlertTimelineNodeSortByGPUType + const AlertTimelineNodeSortByHostname + const AlertTimelineNodeSortByLastUpdate + const AlertTimelineNodeSortByNodeGroup + const AlertTimelineOrderAsc + const AlertTimelineOrderDesc + const AlertTimelineStateCritical + const AlertTimelineStateResolved + const AlertTimelineStateWarning + const DefaultTimeout + const ErrorReportGroupByError + const ErrorReportGroupByNode + const ErrorReportTimeModeAbsolute + const ErrorReportTimeModeRelative + const ErrorReportViewGraph + const ErrorReportViewList + const ErrorReportViewOverview + const InventoryReportOrderAsc + const InventoryReportOrderDesc + const InventoryReportSortByComputeZone + const InventoryReportSortByGPUCount + const InventoryReportSortByGPUType + const InventoryReportSortByGeoLocation + const InventoryReportSortByHostname + const InventoryReportSortByIntegrityCheck + const InventoryReportSortByNodeGroup + const InventoryReportSortByNodeUUID + const InventoryReportSortByPrivateIP + const InventoryReportSortByPublicIP + const MaxEventBuckets + const NodeAgentOffline + const NodeAgentOnline + const NodeAgentUnknown + const NodeFirmwareFailed + const NodeFirmwarePassed + const NodeFirmwareUnknown + const NodeGroupHealthDegraded + const NodeGroupHealthHealthy + const NodeGroupHealthUnhealthy + const NodeGroupHealthUnknown + const NodeGroupOrderAsc + const NodeGroupOrderDesc + const NodeGroupSortByHealth + const NodeGroupSortByNodes + const NodeGroupViewBasic + const NodeGroupViewDetail + const NodeHealthDegraded + const NodeHealthHealthy + const NodeHealthUnhealthy + const NodeHealthUnknown + const NodeIntegrityDegraded + const NodeIntegrityFailed + const NodeIntegrityPassed + const NodeIntegrityPending + const NodeIntegrityUnknown + const NodeIntegrityUnsupported + const NodeIntegrityUnverified + const NodeIntegrityVerified + const NodeOrderAsc + const NodeOrderDesc + const NodeSortByAgentStatus + const NodeSortByAgentVersion + const NodeSortByComputeZone + const NodeSortByGPUCount + const NodeSortByGPUDriverVersion + const NodeSortByGPUFirmwareVersions + const NodeSortByGPUType + const NodeSortByHealthStatus + const NodeSortByHostname + const NodeSortByIntegrityCheck + const NodeSortByKernelVersion + const NodeSortByNodeGroup + const NodeSortByUUID + const NodeViewBasic + const NodeViewDetail + const ReportFormatCSV + const ReportFormatJSON + var ErrInsecureBaseURL = errors.New("insecure base URL: https is required") + var ErrInvalidBundle = errors.New("invalid signature bundle: expected a Sigstore .sig.bundle file") + var ErrInvalidKey = errors.New("invalid public key: expected a PEM-encoded public key") + var ErrMissingAPIKey = errors.New("API key is required") + var ErrMissingBaseURL = errors.New("base URL is required") + var ErrResponseTooLarge = errors.New("API response exceeded the maximum allowed size") + var ErrVerificationFailed = errors.New("signature verification failed: the report does not match the signature") + func ValidateBaseURL(rawURL string) error + func VerifySignedReport(csv, bundleJSON, publicKeyPEM []byte) error + type APIError struct + Details string + Message string + Status string + StatusCode int + func (e *APIError) Error() string + type Alert struct + Component string + ComponentDisplayName string + DetectedAt string + Error string + EventTimestamp string + FiredAt string + LastUpdated string + Message string + NodeUUID string + Severity string + State string + TriggeredAt string + UUID string + type AlertSeverity string + func (severity AlertSeverity) Valid() bool + type AlertState string + func (state AlertState) Valid() bool + type AlertTimelineAlertSortBy string + func (sortBy AlertTimelineAlertSortBy) Valid() bool + type AlertTimelineDetails struct + AlertStatus string + AlertUUID string + Component string + ComponentDisplayName string + ComputeZone string + CustomerID string + HasMore bool + IsBackendComponent bool + NodeGroup string + NodeUUID string + Page int + PageSize int + RawJSON []byte + Timeline []AlertTimelineEvent + Total int + type AlertTimelineEvent struct + Actions []SuggestedAction + AlertStatus string + Error string + EventTimestamp string + EventType string + ExtraInfo map[string]any + Incidents []any + Message string + type AlertTimelineFilterField struct + Name string + Options []AlertTimelineFilterOption + type AlertTimelineFilterOption struct + ID string + Value string + func (option *AlertTimelineFilterOption) UnmarshalJSON(data []byte) error + func (option AlertTimelineFilterOption) MarshalJSON() ([]byte, error) + type AlertTimelineFilterOptions struct + Filters AlertTimelineFilters + RawJSON []byte + Sorting AlertTimelineSortingOptions + type AlertTimelineFilters struct + Fields []AlertTimelineFilterField + type AlertTimelineNode struct + ComputeZone string + CriticalCount int + GPUType string + HostStatus string + Hostname string + LastAlertTime string + NodeGroup string + NodeUUID string + ResolvedCount int + WarningCount int + type AlertTimelineNodeAlert struct + AlertStatus string + AlertUUID string + Component string + ComponentDisplayName string + LastEventTime string + StartTime string + type AlertTimelineNodeSortBy string + func (sortBy AlertTimelineNodeSortBy) Valid() bool + type AlertTimelineNodesPage struct + DistinctComputeZoneCount int + DistinctGPUTypeCount int + DistinctNodeGroupCount int + HasMore bool + Nodes []AlertTimelineNode + Page int + PageSize int + RawJSON []byte + Total int + TotalCritical int + TotalResolved int + TotalWarning int + type AlertTimelineSortOrder string + func (order AlertTimelineSortOrder) Valid() bool + type AlertTimelineSortingDefaults struct + Field string + Order string + type AlertTimelineSortingOptions struct + Defaults AlertTimelineSortingDefaults + Fields []string + Orders []string + type AlertTimelineState string + func (state AlertTimelineState) Valid() bool + type AlertsPage struct + Alerts []Alert + Page int + PageCursorNext string + PageSize int + RawJSON []byte + Total int + type AuthStatus struct + Authenticated bool + RawJSON []byte + type BlockDevice struct + FSType string + MountPoint string + Name string + Parents []string + PartUUID string + Size *int + Type string + Used *int + WWN string + type CPUInfo struct + Architecture string + LogicalCores string + Manufacturer string + Type string + type Client struct + func NewClient(baseURL, apiKey string, opts ...Option) (*Client, error) + func (c *Client) APIKeyConfigured() bool + func (c *Client) BaseURL() string + func (c *Client) DescribeAlertTimeline(ctx context.Context, nodeUUID, alertUUID string) (AlertTimelineDetails, error) + func (c *Client) DescribeAlertTimelineWithOptions(ctx context.Context, nodeUUID, alertUUID string, ...) (AlertTimelineDetails, error) + func (c *Client) DescribeNode(ctx context.Context, nodeUUID string) (NodeDetails, error) + func (c *Client) FetchSigningKey(ctx context.Context) ([]byte, error) + func (c *Client) GetAlertTimelineFilterOptions(ctx context.Context, active bool) (AlertTimelineFilterOptions, error) + func (c *Client) GetAuthStatus(ctx context.Context) (AuthStatus, error) + func (c *Client) GetErrorReport(ctx context.Context, opts ErrorReportOptions) (ErrorReport, error) + func (c *Client) GetEventBuckets(ctx context.Context, opts EventBucketsOptions) (EventBuckets, error) + func (c *Client) GetInventoryReport(ctx context.Context, opts InventoryReportOptions) (InventoryReport, error) + func (c *Client) GetOverview(ctx context.Context, opts OverviewOptions) (Overview, error) + func (c *Client) ListAlertTimelineNodes(ctx context.Context, opts ListAlertTimelineNodesOptions) (AlertTimelineNodesPage, error) + func (c *Client) ListAlerts(ctx context.Context, opts ListAlertsOptions) (AlertsPage, error) + func (c *Client) ListComputeZones(ctx context.Context, opts ListComputeZonesOptions) (ComputeZonesPage, error) + func (c *Client) ListEvents(ctx context.Context, opts EventListOptions) (EventsPage, error) + func (c *Client) ListNodeAlertTimeline(ctx context.Context, opts ListNodeAlertTimelineOptions) (NodeAlertTimelinePage, error) + func (c *Client) ListNodeGroups(ctx context.Context, opts ListNodeGroupsOptions) (NodeGroupsPage, error) + func (c *Client) ListNodes(ctx context.Context, opts ListNodesOptions) (NodesPage, error) + func (c *Client) ListTags(ctx context.Context, opts TagListOptions) (TagList, error) + func (c *Client) NodeHealthHistory(ctx context.Context, nodeUUID string, opts NodeHealthHistoryOptions) (NodeHealthHistory, error) + type ComputeZone struct + GeoLocation *GeoLocation + ID string + Name string + NodeCount *int + Type string + type ComputeZoneView string + const ComputeZoneViewBasic + const ComputeZoneViewDetail + func (view ComputeZoneView) Valid() bool + type ComputeZonesPage struct + ComputeZones []ComputeZone + HasMore bool + Page int + PageSize int + RawJSON []byte + Total int + type DescribeAlertTimelineOptions struct + Order AlertTimelineSortOrder + Page *int + PageSize *int + type DiskInfo struct + BlockDevices []BlockDevice + ContainerRootDisk string + type ErrorReport struct + Errors []ErrorReportError + Graph *ErrorReportGraph + GroupBy ErrorReportGroupBy + HasMore bool + Nodes []ErrorReportNode + Overview *ErrorReportOverview + Page int + PageSize int + RawCSV []byte + RawJSON []byte + Total int + View ErrorReportView + type ErrorReportError struct + Count *int + Name string + NodeCount *int + SuggestedAction *SuggestedAction + type ErrorReportGraph struct + Result []ErrorTimeSeries + TimeRange *TimeRange + type ErrorReportGroupBy string + func (groupBy ErrorReportGroupBy) Valid() bool + type ErrorReportNode struct + Errors []string + Hostname string + NodeUUID string + type ErrorReportOptions struct + ComputeZoneIDs []string + EndTime string + Errors []string + Format ReportFormat + GroupBy ErrorReportGroupBy + NodeGroupIDs []string + Page *int + PageSize *int + StartTime string + Step string + Tags []string + TimeMode ErrorReportTimeMode + View ErrorReportView + Window string + type ErrorReportOverview struct + TotalErrorNodes *int + TotalErrorTypes *int + TotalErrors *int + type ErrorReportTimeMode string + func (mode ErrorReportTimeMode) Valid() bool + type ErrorReportView string + func (view ErrorReportView) Valid() bool + type ErrorTimeSeries struct + Error string + Values string + type Event struct + Component string + CreatedAt string + EventID string + Message string + Name string + NodeUUID string + SuggestedActions []SuggestedAction + Timestamp string + Type string + type EventBucket struct + Count *int + EndTime string + FirstEventTime string + StartTime string + type EventBuckets struct + BucketInterval string + Buckets []EventBucket + RawJSON []byte + type EventBucketsOptions struct + Component string + EndTime string + MaxBuckets *int + NodeUUID string + StartTime string + Window string + type EventListOptions struct + Component string + EndTime string + NodeUUID string + Page *int + PageSize *int + StartTime string + Window string + type EventsPage struct + Events []Event + HasMore bool + Page int + PageSize int + RawJSON []byte + Total int + type GPUDevice struct + BoardID *int + BusID string + ChassisSN string + GPUIndex string + MinorID string + SerialNumber string + UUID string + VBIOSVersion string + type GPUInfo struct + Architecture string + GPUs []GPUDevice + Manufacturer string + Memory string + Product string + type GeoLocation struct + City string + Country string + Latitude *float32 + Longitude *float32 + Region string + type InventoryNode struct + ComputeZone string + EnrolledAt string + FirmwareCheck string + GPUCount *int + GPUType string + GeoLocation *GeoLocation + Hostname string + IntegrityCheck string + IntegrityCheckReason string + LastIntegrityCheckTime string + NodeGroup string + NodeUUID string + PrivateIP string + PublicIP string + RemovedAt string + SerialNumbers []string + type InventoryReport struct + Filename string + HasMore bool + Nodes []InventoryNode + Page int + PageSize int + RawCSV []byte + RawJSON []byte + RawSigned []byte + Total int + type InventoryReportOptions struct + ComputeZoneIDs []string + EndTime string + Format ReportFormat + NodeGroupIDs []string + Order InventoryReportSortOrder + Page *int + PageSize *int + Signed bool + SortBy InventoryReportSortBy + StartTime string + Tags []string + type InventoryReportSortBy string + func (sortBy InventoryReportSortBy) Valid() bool + type InventoryReportSortOrder string + func (order InventoryReportSortOrder) Valid() bool + type ListAlertTimelineNodesOptions struct + Active bool + AlertStates []AlertTimelineState + ComponentTypes []string + ComputeZoneIDs []string + GPUTypes []string + Hostname string + NodeGroupIDs []string + Order AlertTimelineSortOrder + Page *int + PageSize *int + SortBy AlertTimelineNodeSortBy + type ListAlertsOptions struct + Component string + NodeUUID string + Page *int + PageSize *int + Severity AlertSeverity + State AlertState + type ListComputeZonesOptions struct + Page *int + PageSize *int + View ComputeZoneView + ZoneIDs []string + type ListNodeAlertTimelineOptions struct + Active bool + AlertStates []AlertTimelineState + ComponentTypes []string + ComputeZoneIDs []string + GPUTypes []string + NodeGroupIDs []string + NodeUUID string + Order AlertTimelineSortOrder + Page *int + PageSize *int + SortBy AlertTimelineAlertSortBy + WithoutPSIRT bool + type ListNodeGroupsOptions struct + GPUTypes []string + HealthStatuses []NodeGroupHealthStatus + NodeGroupIDs []string + Order NodeGroupSortOrder + Page *int + PageSize *int + SortBy NodeGroupSortBy + View NodeGroupView + type ListNodesOptions struct + AgentStatuses []NodeAgentStatus + ComputeZoneIDs []string + ComputeZoneNames []string + FirmwareChecks []NodeFirmwareCheck + GPUCounts []int + GPUTypes []string + HealthStatuses []NodeHealthStatus + Hostname string + IntegrityChecks []NodeIntegrityCheck + NodeGroupIDs []string + NodeGroupNames []string + NodeUUIDs []string + Order NodeSortOrder + Page *int + PageSize *int + PrivateIPs []string + PublicIPs []string + SortBy NodeSortBy + View NodeView + type MemoryInfo struct + TotalBytes string + type NICInfo struct + PrivateIPInterfaces []NICInterface + type NICInterface struct + IP string + Interface string + MAC string + type Node struct + AgentStatus string + ComputeZone string + FirmwareCheck string + GPUCount *int + GPUType string + Health string + Hostname string + IntegrityCheck string + IntegrityCheckReason string + LastIntegrityCheckTime string + LastUpdatedTime string + NodeGroup string + PrivateIP string + PublicIP string + UUID string + type NodeAgentStatus string + func (status NodeAgentStatus) Valid() bool + type NodeAlertTimelinePage struct + Alerts []AlertTimelineNodeAlert + HasMore bool + Hostname string + NodeUUID string + Page int + PageSize int + RawJSON []byte + Total int + type NodeDetails struct + ComputeZoneID string + DegradedComponentCount *int + EnrolledAt string + GeoLocation *GeoLocation + HealthyComponentCount *int + NodeGroupID string + RawJSON []byte + Resources *NodeResources + SystemInfo *SystemInfo + Tags []string + UnhealthyComponentCount *int + type NodeFirmwareCheck string + func (check NodeFirmwareCheck) Valid() bool + type NodeGroup struct + ComputeZoneID string + ComputeZoneName string + Health string + HealthPercentage *float32 + ID string + Name string + NodeCount *int + type NodeGroupHealthStatus string + func (status NodeGroupHealthStatus) Valid() bool + type NodeGroupSortBy string + func (sortBy NodeGroupSortBy) Valid() bool + type NodeGroupSortOrder string + func (order NodeGroupSortOrder) Valid() bool + type NodeGroupView string + func (view NodeGroupView) Valid() bool + type NodeGroupsPage struct + HasMore bool + NodeGroups []NodeGroup + Page int + PageSize int + RawJSON []byte + Total int + type NodeHealthHistory struct + EnrolledAt string + HealthSummary *NodeHealthSummary + RawJSON []byte + Segments []NodeHealthSegment + type NodeHealthHistoryOptions struct + EndTime string + StartTime string + type NodeHealthSegment struct + EndTime string + StartTime string + Status string + type NodeHealthStatus string + func (status NodeHealthStatus) Valid() bool + type NodeHealthSummary struct + DegradedDurationSeconds *float32 + DegradedPercentage *float32 + HealthyDurationSeconds *float32 + HealthyPercentage *float32 + UnhealthyDurationSeconds *float32 + UnhealthyPercentage *float32 + type NodeIntegrityCheck string + func (check NodeIntegrityCheck) Valid() bool + type NodeResources struct + CPUInfo *CPUInfo + DiskInfo *DiskInfo + GPUInfo *GPUInfo + MemoryInfo *MemoryInfo + NICInfo *NICInfo + type NodeSortBy string + func (sortBy NodeSortBy) Valid() bool + type NodeSortOrder string + func (order NodeSortOrder) Valid() bool + type NodeView string + func (view NodeView) Valid() bool + type NodesPage struct + HasMore bool + Nodes []Node + Page int + PageSize int + RawJSON []byte + Total int + type Option func(*Client) + func WithHTTPClient(httpClient *http.Client) Option + func WithTimeout(timeout time.Duration) Option + type Overview struct + CPUCoresCount *int + ComputeZoneCount *int + DegradedNodeCount *int + GPUsCount *int + HealthPercentage *float32 + HealthyNodeCount *int + Metrics []OverviewMetric + NodeGroupCount *int + NodesCount *int + RawJSON []byte + UnhealthyNodeCount *int + UnknownNodeCount *int + type OverviewMetric struct + Aggregation string + Description string + LastUpdated string + Name string + Unit string + Value *float32 + type OverviewOptions struct + IncludeMetrics *bool + type ReportFormat string + func (format ReportFormat) Valid() bool + type SuggestedAction struct + Action string + Code string + Persona string + Type string + type SystemInfo struct + AgentVersion string + BootID string + CUDAVersion string + ContainerRuntimeVersion string + DCGMVersion string + GPUDriverVersion string + Hostname string + KernelVersion string + OSImage string + OperatingSystem string + StartedAt string + SystemUUID string + type TagList struct + RawJSON []byte + Tags []string + type TagListOptions struct + ComputeZoneID string + NodeGroupID string + NodeUUID string + Prefix string + type TimeRange struct + End string + Start string
Go to main page