notification

package
v1.16.3 Latest Latest
Warning

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

Go to latest
Published: Mar 16, 2026 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppriseResponse

type AppriseResponse struct {
	// ID is the unique identifier of the Apprise settings.
	//
	// Required: true
	ID uint `json:"id"`

	// APIURL is the URL of the Apprise API endpoint.
	//
	// Required: false
	APIURL string `json:"apiUrl"`

	// Enabled indicates if Apprise is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// ImageUpdateTag is the tag to use for image update notifications.
	//
	// Required: false
	ImageUpdateTag string `json:"imageUpdateTag"`

	// ContainerUpdateTag is the tag to use for container update notifications.
	//
	// Required: false
	ContainerUpdateTag string `json:"containerUpdateTag"`
}

type AppriseUpdate

type AppriseUpdate struct {
	// APIURL is the URL of the Apprise API endpoint.
	//
	// Required: false
	APIURL string `json:"apiUrl"`

	// Enabled indicates if Apprise is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// ImageUpdateTag is the tag to use for image update notifications.
	//
	// Required: false
	ImageUpdateTag string `json:"imageUpdateTag"`

	// ContainerUpdateTag is the tag to use for container update notifications.
	//
	// Required: false
	ContainerUpdateTag string `json:"containerUpdateTag"`
}

type DispatchAutoHeal added in v1.16.2

type DispatchAutoHeal struct {
	ContainerName string `json:"containerName"`
	ContainerID   string `json:"containerId"`
}

type DispatchBatchImageUpdate added in v1.16.2

type DispatchBatchImageUpdate struct {
	Updates map[string]*imageupdate.Response `json:"updates"`
}

type DispatchContainerUpdate added in v1.16.2

type DispatchContainerUpdate struct {
	ContainerName string `json:"containerName"`
	ImageRef      string `json:"imageRef"`
	OldDigest     string `json:"oldDigest,omitempty"`
	NewDigest     string `json:"newDigest,omitempty"`
}

type DispatchImageUpdate added in v1.16.2

type DispatchImageUpdate struct {
	ImageRef   string               `json:"imageRef"`
	UpdateInfo imageupdate.Response `json:"updateInfo"`
}

type DispatchKind added in v1.16.2

type DispatchKind string
const (
	DispatchKindImageUpdate        DispatchKind = "image_update"
	DispatchKindBatchImageUpdate   DispatchKind = "batch_image_update"
	DispatchKindContainerUpdate    DispatchKind = "container_update"
	DispatchKindVulnerabilityFound DispatchKind = "vulnerability_found"
	DispatchKindPruneReport        DispatchKind = "prune_report"
	DispatchKindAutoHeal           DispatchKind = "auto_heal"
)

type DispatchPruneReport added in v1.16.2

type DispatchPruneReport struct {
	Result system.PruneAllResult `json:"result"`
}

type DispatchRequest added in v1.16.2

type DispatchRequest struct {
	Kind               DispatchKind                `json:"kind"`
	ImageUpdate        *DispatchImageUpdate        `json:"imageUpdate,omitempty"`
	BatchImageUpdate   *DispatchBatchImageUpdate   `json:"batchImageUpdate,omitempty"`
	ContainerUpdate    *DispatchContainerUpdate    `json:"containerUpdate,omitempty"`
	VulnerabilityFound *DispatchVulnerabilityFound `json:"vulnerabilityFound,omitempty"`
	PruneReport        *DispatchPruneReport        `json:"pruneReport,omitempty"`
	AutoHeal           *DispatchAutoHeal           `json:"autoHeal,omitempty"`
}

type DispatchVulnerabilityFound added in v1.16.2

type DispatchVulnerabilityFound struct {
	CVEID            string `json:"cveId"`
	CVELink          string `json:"cveLink"`
	Severity         string `json:"severity"`
	ImageName        string `json:"imageName"`
	FixedVersion     string `json:"fixedVersion,omitempty"`
	PkgName          string `json:"pkgName,omitempty"`
	InstalledVersion string `json:"installedVersion,omitempty"`
}

type Provider

type Provider string

Provider is the type for notification provider identifiers.

const (
	// NotificationProviderDiscord is the builtin Discord notification provider.
	NotificationProviderDiscord Provider = "discord"

	// NotificationProviderEmail is the builtin Email notification provider.
	NotificationProviderEmail Provider = "email"

	// NotificationProviderTelegram is the builtin Telegram notification provider.
	NotificationProviderTelegram Provider = "telegram"

	// NotificationProviderSignal is the builtin Signal notification provider.
	NotificationProviderSignal Provider = "signal"

	// NotificationProviderSlack is the builtin Slack notification provider.
	NotificationProviderSlack Provider = "slack"

	// NotificationProviderNtfy is the builtin Ntfy notification provider.
	NotificationProviderNtfy Provider = "ntfy"

	// NotificationProviderPushover is the builtin Pushover notification provider.
	NotificationProviderPushover Provider = "pushover"

	// NotificationProviderMatrix is the builtin Matrix webhook notification provider.
	NotificationProviderMatrix Provider = "matrix"

	// NotificationProviderGeneric is the builtin Generic webhook notification provider.
	NotificationProviderGeneric Provider = "generic"
)

type Response

type Response struct {
	// ID is the unique identifier of the notification settings.
	//
	// Required: true
	ID uint `json:"id"`

	// Provider is the notification provider type.
	//
	// Required: true
	Provider Provider `json:"provider"`

	// Enabled indicates if the notification provider is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// Config contains the provider-specific configuration.
	//
	// Required: true
	Config base.JsonObject `json:"config"`
}

type Update

type Update struct {
	// Provider is the notification provider type.
	//
	// Required: true
	Provider Provider `json:"provider" binding:"required"`

	// Enabled indicates if the notification provider is enabled.
	//
	// Required: true
	Enabled bool `json:"enabled"`

	// Config contains the provider-specific configuration.
	//
	// Required: true
	Config base.JsonObject `json:"config" binding:"required"`
}

Jump to

Keyboard shortcuts

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