api

package

Go to main page

Versions in this module

v0

v0.2.43

Sep 10, 2026

v0.2.42

Sep 10, 2026

v0.2.41

Sep 10, 2026

v0.2.40

Sep 10, 2026

Changes in this version

+ type AppBindingCandidateView struct

+ Capabilities []string

+ DeviceID string

+ EntityID string

+ Name string

+ type AppBindingRequirementView struct

+ AllowReuse bool

+ Capability string

+ Cardinality string

+ ID string

+ MinItems int

type AppBindingView

+ DeviceID string

type AppBindingsView

+ Candidates []AppBindingCandidateView

+ Requirements []AppBindingRequirementView

v0.2.39

Sep 10, 2026

v0.2.35

Sep 10, 2026

v0.2.34

Sep 10, 2026

v0.2.33

Sep 10, 2026

v0.2.32

Sep 10, 2026

v0.2.31

Sep 9, 2026

v0.2.30

Sep 9, 2026

v0.2.29

Sep 9, 2026

Changes in this version

type PluginUISectionData

+ I18n map[string]string

v0.2.28

Sep 9, 2026

v0.2.27

Sep 9, 2026

v0.2.26

Sep 9, 2026

Changes in this version

type PluginUIPageData

+ Description string

type PluginUISectionData

+ Description string

+ EmptyText string

+ Title string

v0.2.25

Sep 9, 2026

Changes in this version

+ type CommandHandledRequest struct

+ AllUnhandled bool

+ IDs []int64

type CommandView

+ HandledAt int64

+ type SeriesSampleView struct

+ DeviceID string

+ Key string

+ Quality string

+ Ts int64

+ Value float64

+ type SeriesSamplesView struct

+ NextBefore int64

+ Samples []SeriesSampleView

v0.2.24

Sep 9, 2026

v0.2.23

Sep 9, 2026

Changes in this version

+ const APIErrApplicationRejected

+ const APIErrApplicationUnavailable

+ const APIErrAuthenticationRequired

+ const APIErrCommandDeliveryFailed

+ const APIErrConflict

+ const APIErrDeviceNotFound

+ const APIErrEdgeOffline

+ const APIErrInternal

+ const APIErrInvalidArgs

+ const APIErrInvalidCredentials

+ const APIErrInvalidIdempotencyKey

+ const APIErrInvalidPluginResponse

+ const APIErrInvalidRequest

+ const APIErrInvalidRole

+ const APIErrInvalidScopes

+ const APIErrJobNotFound

+ const APIErrLastAdminProtected

+ const APIErrNotFound

+ const APIErrPermissionDenied

+ const APIErrPluginCatalogUnavailable

+ const APIErrPluginNotFound

+ const APIErrPluginUIAssetForbidden

+ const APIErrPluginUIAssetNotFound

+ const APIErrPluginUIAssetTooLarge

+ const APIErrPluginUIAssetTypeNotAllowed

+ const APIErrRateLimited

+ const APIErrSetupAlreadyComplete

+ const APIErrSetupForbidden

+ const APIErrStoreUnavailable

+ const APIErrTokenNotFound

+ const APIErrUnsupportedCommand

+ const APIErrUserNotFound

+ const APIErrUsernameConflict

+ const APIErrWriteForbidden

+ const PluginErrHostMismatch

+ const PluginErrKindUnavailable

+ const PluginErrKindUnsupported

+ const PluginErrStoreUnavailable

+ func IsKnownErrorCode(code string) bool

+ type ErrorResponse struct

+ Code string

+ Error string

+ Message string

+ Params map[string]any

+ RequestID string

type PluginApplicationContributionData

+ I18n map[string]string

+ UI *PluginUIData

type PluginConnectorContributionData

+ I18n map[string]string

type PluginDriverContributionData

+ I18n map[string]string

+ UI *PluginUIData

+ type PluginUIData struct

+ APIVersion int

+ Device *PluginUIDeviceData

+ Navigation *PluginUINavigationData

+ Pages []PluginUIPageData

+ type PluginUIDeviceData struct

+ Sections []PluginUISectionData

+ type PluginUINavigationData struct

+ I18n map[string]string

+ Icon string

+ Order int

+ Route string

+ Title string

+ Visibility string

+ type PluginUIPageData struct

+ I18n map[string]string

+ ID string

+ Sections []PluginUISectionData

+ Title string

+ type PluginUISectionData struct

+ Entry string

+ Fields []map[string]any

+ Presentation string

+ RecordType string

+ Scopes []string

+ Source string

+ Text string

+ Type string

v0.2.22

Sep 9, 2026

v0.2.21

Sep 9, 2026

v0.2.20

Sep 8, 2026

v0.2.19

Sep 8, 2026

v0.2.18

Sep 8, 2026

v0.2.15

Sep 8, 2026

Changes in this version

+ type AppJobRunRequest struct

+ ArgsJSON string

+ IdempotencyKey string

+ type AppJobRunView struct

+ InstanceID string

+ JobID string

+ ResultJSON string

+ type AppJobView struct

+ ID string

+ InputSchemaJSON string

+ ManualOnly bool

+ Title string

type AppJobsView

+ JobDescriptors []AppJobView

+ type EntityObservationSet struct

+ EntityID string

+ Observations map[string]model.Observation

type StateData

+ Observations []EntityObservationSet

v0.2.14

Sep 7, 2026

Changes in this version

type StatsView

+ AuthMode string

v0.2.13

Sep 6, 2026

v0.2.12

Sep 5, 2026

v0.2.11

Sep 5, 2026

v0.2.10

Sep 5, 2026

v0.2.9

Sep 5, 2026

v0.2.8

Sep 5, 2026

Changes in this version

type AppJobsView

+ Scheduled []AppScheduledJobView

+ type AppScheduledJobView struct

+ Cron string

+ LastRunAt int64

+ MissedPolicy string

+ NextRunAt int64

+ Revision int64

+ ScheduleID string

+ State string

+ Timezone string

v0.2.7

Sep 5, 2026

Changes in this version

+ type AppBindingView struct

+ Capability string

+ EntityID string

+ RequirementID string

+ type AppBindingsView struct

+ Bindings []AppBindingView

+ InstanceID string

+ Running bool

+ type AppDomainRecordView struct

+ DataJSON string

+ RecordID string

+ RecordType string

+ UpdatedAt int64

+ Version string

+ type AppDomainRecordsView struct

+ InstanceID string

+ Limit int

+ Offset int

+ RecordType string

+ Records []AppDomainRecordView

+ type AppJobsView struct

+ InstanceID string

+ Jobs []string

+ Running bool

+ type DomainRecordData struct

+ Created bool

+ DataJSON string

+ InstanceID string

+ RecordID string

+ RecordType string

+ UpdatedAt int64

+ Version string

type MsgType

+ const MsgDomainRecord

v0.2.6

Sep 5, 2026

v0.2.5

Sep 4, 2026

v0.2.4

Sep 4, 2026

v0.2.3

Sep 4, 2026

Changes in this version

type EventData

+ EntityID string

v0.2.2

Sep 4, 2026

Changes in this version

+ type CapabilitiesData struct

+ Sources []CapabilitySource

+ type CapabilitySource struct

+ Capabilities []model.Capability

+ Source string

type MsgType

+ const MsgCapabilities

v0.2.1

Sep 4, 2026

v0.2.0

Sep 4, 2026

v0.1.0

Sep 3, 2026

Changes in this version

+ const PluginAckApplied

+ const PluginAckFailed

+ const PluginAckRejected

+ const PluginErrConflict

+ const PluginErrEdgeOffline

+ const PluginErrInvalidConfig

+ const PluginErrNotFound

+ const PluginErrPermissionConfirm

+ const PluginErrQuota

+ const PluginErrSecretForbidden

+ const Version

+ func DeviceKey(edgeID, deviceID string) string

+ type AckData struct

+ CommandID int64

+ Detail string

+ Status string

+ type AdapterView struct

+ Commands []string

+ Name string

+ type CommandData struct

+ Args string

+ Cmd string

+ CommandID int64

+ type CommandView struct

+ AckedAt int64

+ Args string

+ Cmd string

+ CreatedAt int64

+ DeviceID string

+ ID int64

+ Result string

+ Status string

+ type DeviceMeta struct

+ Adapter string

+ ID string

+ Name string

+ Port string

+ type DeviceView struct

+ Adapter string

+ EdgeID string

+ ID string

+ LastSeen int64

+ Name string

+ Online bool

+ Port string

+ State map[string]any

+ UpdatedAt int64

+ type EdgeUpData struct

+ Devices []string

+ EdgeID string

+ Version string

+ type EdgeView struct

+ ConnectedAt int64

+ Devices []string

+ EdgeID string

+ Online bool

+ Version string

+ type Envelope struct

+ Data json.RawMessage

+ Device string

+ Ts int64

+ Type MsgType

+ V int

+ type EventData struct

+ Label string

+ Type string

+ type EventView struct

+ DeviceID string

+ ID int64

+ Payload string

+ Ts int64

+ Type string

+ type HealthView struct

+ DevicesOnline int

+ DevicesTotal int

+ EdgesOnline int

+ OK bool

+ UptimeS int64

+ Version string

+ type HelloData struct

+ Devices []DeviceMeta

+ EdgeID string

+ Tenant string

+ Token string

+ Version string

+ type MsgType string

+ const MsgCommand

+ const MsgCommandAck

+ const MsgDescriptor

+ const MsgEdgeDown

+ const MsgEdgeUp

+ const MsgEvent

+ const MsgHello

+ const MsgPing

+ const MsgPluginAck

+ const MsgPluginDesired

+ const MsgPluginStatus

+ const MsgPong

+ const MsgSnapshot

+ const MsgState

+ type OverviewView struct

+ CommandsFailed int

+ DevicesOnline int

+ DevicesTotal int

+ EdgesOnline int

+ EdgesTotal int

+ FailedCommands []CommandView

+ OfflineDevices []DeviceView

+ PluginsActive int

+ PluginsDesired int

+ RecentEvents []EventView

+ ServerTime int64

+ type PluginAckData struct

+ Results []PluginApplyResultData

+ Revision uint64

+ SnapshotDigest string

+ Status string

+ type PluginApplicationContributionData struct

+ ID string

+ Title string

+ type PluginApplyResultData struct

+ Detail string

+ InstanceID string

+ Status string

+ type PluginConnectorContributionData struct

+ Direction string

+ Host string

+ ID string

+ Title string

+ type PluginContributionsData struct

+ Applications []PluginApplicationContributionData

+ Connectors []PluginConnectorContributionData

+ Drivers []PluginDriverContributionData

+ type PluginDesiredData struct

+ Instances []PluginDesiredInstanceData

+ Revision uint64

+ SnapshotDigest string

+ type PluginDesiredInstanceData struct

+ Config map[string]string

+ Enabled bool

+ InstanceID string

+ Isolation string

+ PluginID string

+ Version string

+ type PluginDriverContributionData struct

+ Discovery string

+ ID string

+ Title string

+ type PluginInstallationStatusData struct

+ Capabilities []string

+ Contributions PluginContributionsData

+ Digest string

+ Kind string

+ Permissions PluginPermissionsData

+ PluginID string

+ Protocol int

+ TrustMode string

+ Verified bool

+ VerifiedPublisher string

+ Version string

+ type PluginInstanceActionRequest struct

+ Force bool

+ type PluginInstanceCreateRequest struct

+ Config map[string]string

+ ConfirmPermissions bool

+ EdgeID string

+ Enabled *bool

+ InstanceID string

+ Isolation string

+ PluginID string

+ SecretRefs []string

+ Version string

+ type PluginInstanceDeleteRequest struct

+ Purge bool

+ type PluginInstanceDesiredView struct

+ Config map[string]string

+ Enabled bool

+ InstanceID string

+ Isolation string

+ PluginID string

+ Revision uint64

+ SecretRefs []string

+ UpdatedAt int64

+ Version string

+ type PluginInstanceListResponse struct

+ Instances []PluginInstanceView

+ type PluginInstanceObservedView struct

+ Detail string

+ Health string

+ LastHealthy int64

+ ReportedAt int64

+ RestartCount int

+ State string

+ Version string

+ type PluginInstanceUpdateRequest struct

+ Config map[string]string

+ ConfirmPermissions bool

+ Enabled *bool

+ Isolation *string

+ SecretRefs []string

+ Version *string

+ type PluginInstanceView struct

+ AppliedRevision uint64

+ Desired PluginInstanceDesiredView

+ DesiredRevision uint64

+ Drift bool

+ EdgeID string

+ EdgeOnline bool

+ HasObserved bool

+ ID string

+ LastAckAt int64

+ Observed *PluginInstanceObservedView

+ Stale bool

+ TenantID int64

+ type PluginInstanceWriteResponse struct

+ ID string

+ Instance PluginInstanceView

+ RequestID string

+ Revision uint64

+ type PluginObservedInstanceData struct

+ Detail string

+ Health string

+ HostOnline bool

+ InstanceID string

+ LastHealthy int64

+ MessageRate float64

+ PluginID string

+ RestartCount int

+ State string

+ Version string

+ type PluginPermissionsData struct

+ Filesystem []string

+ Hardware []string

+ Network []string

+ Secrets []string

+ type PluginStatusData struct

+ AppliedRevision uint64

+ BootID string

+ Installations []PluginInstallationStatusData

+ ObservedInstances []PluginObservedInstanceData

+ Sequence uint64

+ type SessionView struct

+ CreatedAt int64

+ ExpiresAt int64

+ ID string

+ LastSeenAt int64

+ UserID int64

+ type SnapshotData struct

+ Descriptors []model.Descriptor

+ Devices []DeviceView

+ Edges []EdgeView

+ type StateData struct

+ Online bool

+ Raw map[string]any

+ UpdatedAt int64

+ type StatsView struct

+ AuthEnabled bool

+ Commands int64

+ Devices int64

+ Events int64

+ OldestEvent int64

+ RetentionDays int

+ SchemaVersion int

+ type TenantView struct

+ CreatedAt int64

+ ID int64

+ Name string

+ Slug string

+ type TokenView struct

+ CreatedAt int64

+ ExpiresAt *int64

+ ID int64

+ LastUsedAt *int64

+ Name string

+ Prefix string

+ RevokedAt *int64

+ Scopes []string

+ type UserRole string

+ const RoleAdmin

+ const RoleOperator

+ const RoleViewer

+ type UserView struct

+ Disabled bool

+ ID int64

+ Name string

+ Role string

+ TenantID int64

+ TenantSlug string

+ Username string

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