api

package

Go to main page

Versions in this module

v0

v0.5.8

Apr 22, 2026

Changes in this version

type ServerStatusDetail

+ const ServerStatusDetailReadyRestoring

type ServerUpdateState

+ const ServerUpdateStateInMaintenancePostRestore

v0.5.7

Apr 20, 2026

v0.5.6

Apr 19, 2026

v0.5.5

Apr 17, 2026

v0.5.4

Apr 14, 2026

v0.5.3

Apr 7, 2026

Changes in this version

type ClusterUpdateInProgress

+ const ClusterUpdateInProgressError

type ClusterUpdateInProgressStatus

+ Error string

v0.5.2

Apr 2, 2026

v0.5.1

Mar 31, 2026

v0.5.0

Mar 28, 2026

Changes in this version

+ type ClusterBulkUpdateAction string

+ const ClusterBulkUpdateActionAddApplication

+ const ClusterBulkUpdateActionAddISCSIStorageTarget

+ const ClusterBulkUpdateActionAddMultipathStorageTarget

+ const ClusterBulkUpdateActionAddNVMEStorageTarget

+ const ClusterBulkUpdateActionAddNetworkInterfaceVLANTags

+ const ClusterBulkUpdateActionInvalid

+ const ClusterBulkUpdateActionRemoveISCSIStorageTarget

+ const ClusterBulkUpdateActionRemoveMultipathStorageTarget

+ const ClusterBulkUpdateActionRemoveNVMEStorageTarget

+ const ClusterBulkUpdateActionRemoveNetworkInterfaceVLANTags

+ const ClusterBulkUpdateActionUpdateSystemKernel

+ const ClusterBulkUpdateActionUpdateSystemLogging

+ type ClusterBulkUpdatePost struct

+ Action ClusterBulkUpdateAction

+ Arguments *json.RawMessage

+ type ClusterConfig struct

+ RollingRestart ClusterConfigRollingRestart

+ func (c *ClusterConfig) Scan(value any) error

+ func (c ClusterConfig) Value() (driver.Value, error)

+ type ClusterConfigRollingRestart struct

+ PostRestoreDelay time.Duration

+ RestoreMode string

type ClusterPut

+ Config ClusterConfig

+ Description string

+ Properties ConfigMap

+ type ClusterUpdateInProgress string

+ const ClusterUpdateInProgressApplyUpdate

+ const ClusterUpdateInProgressApplyUpdateWithReboot

+ const ClusterUpdateInProgressInactive

+ const ClusterUpdateInProgressRollingRestart

+ type ClusterUpdateInProgressStatus struct

+ EvacuatedBefore []string

+ InProgress ClusterUpdateInProgress

+ LastUpdated time.Time

+ StatusDescription *string

+ type ClusterUpdatePost struct

+ Reboot bool

type ClusterUpdateStatus

+ InProgressStatus ClusterUpdateInProgressStatus

+ func (c *ClusterUpdateStatus) Scan(value any) error

+ func (c ClusterUpdateStatus) Value() (driver.Value, error)

+ type SeedApplication = seed.Application

+ type SeedApplications = seed.Applications

+ type SeedIncus = seed.Incus

+ type SeedInstall = seed.Install

+ type SeedMigrationManager = seed.MigrationManager

+ type SeedNetwork = seed.Network

+ type SeedOperationsCenter = seed.OperationsCenter

+ type SeedUpdate = seed.Update

+ type SeedUpdateConfig = api.SystemUpdateConfig

type ServerPut

+ Description string

+ Properties ConfigMap

+ type ServerSystemKernel = incusosapi.SystemKernel

+ type ServerSystemLogging = incusosapi.SystemLogging

+ type ServerSystemNetworkVLAN = incusosapi.SystemNetworkVLAN

+ type UpdateChangelog = images.Changelog

+ type UpdateChangelogs []UpdateChangelog

v0.4.2

Mar 5, 2026

v0.4.1

Mar 2, 2026

v0.4.0

Feb 28, 2026

Changes in this version

type ClusterUpdateStatus

+ InMaintenance []string

+ NeedsReboot []string

+ type InMaintenanceState int

+ const InMaintenanceEvacuated

+ const InMaintenanceEvacuating

+ const InMaintenanceRestoring

+ const NotInMaintenance

+ func (m InMaintenanceState) String() string

type Server

+ StatusDetail ServerStatusDetail

+ SystemStateIsTrusted bool

+ func (s Server) RecommendedAction() ServerAction

+ func (s Server) State() string

+ func (s Server) UpdateState() ServerUpdateState

type ServerStatus

+ const ServerStatusOffline

+ type ServerStatusDetail string

+ const ServerStatusDetailNone

+ const ServerStatusDetailOfflineRebooting

+ const ServerStatusDetailOfflineShutdown

+ const ServerStatusDetailOfflineUnresponsive

+ const ServerStatusDetailPendingReconfiguring

+ const ServerStatusDetailReadyUpdating

+ func (s *ServerStatusDetail) Scan(value any) error

+ func (s *ServerStatusDetail) UnmarshalText(text []byte) error

+ func (s ServerStatusDetail) MarshalText() ([]byte, error)

+ func (s ServerStatusDetail) String() string

+ func (s ServerStatusDetail) Value() (driver.Value, error)

type ServerUntrusted

+ ServerVersion string

type ServerUpdateState

+ const ServerUpdateStateEvacuating

+ const ServerUpdateStateInMaintenanceRebooting

+ const ServerUpdateStateInMaintenanceRestoring

+ const ServerUpdateStateRebooting

+ const ServerUpdateStateUndefined

+ const ServerUpdateStateUpToDate

+ const ServerUpdateStateUpdating

type SystemUpdatesPut

+ ImageServerAuthenticationByQueryParam bool

v0.3.2

Feb 24, 2026

v0.3.1

Feb 23, 2026

v0.3.0

Feb 21, 2026

Changes in this version

+ const ServerNameOperationsCenter

type ApplicationVersionData

+ AvailableVersion *string

+ InMaintenance bool

+ NeedsUpdate *bool

+ type Channel struct

+ LastUpdated time.Time

+ type ChannelPost struct

+ Name string

+ type ChannelPut struct

+ Description string

type Cluster

+ UpdateStatus ClusterUpdateStatus

type ClusterPut

+ Channel string

+ type ClusterUpdateStatus struct

+ Applications []ApplicationVersionData

+ NeedsUpdate bool

+ OS OSVersionData

type OSVersionData

+ AvailableVersion *string

+ NeedsUpdate *bool

+ type ServerAction string

+ const ServerActionEvacuate

+ const ServerActionNone

+ const ServerActionReboot

+ const ServerActionRestore

+ const ServerActionUpdate

type ServerPut

+ Channel string

+ type ServerSystemUpdate = incusosapi.SystemUpdate

+ type ServerUpdateApplication struct

+ Name string

+ TriggerUpdate bool

+ type ServerUpdatePost struct

+ Applications []ServerUpdateApplication

+ OS ServerUpdateApplication

+ type ServerUpdateState string

+ const ServerUpdateStateEvacuationPending

+ const ServerUpdateStateInMaintenanceRebootPending

+ const ServerUpdateStateInMaintenanceRestorePending

+ const ServerUpdateStateReady

+ const ServerUpdateStateRebootPending

+ const ServerUpdateStateUpdatePending

+ func (s ServerUpdateState) String() string

type ServerVersionData

+ InMaintenance *bool

+ NeedsReboot *bool

+ NeedsUpdate *bool

+ func (s *ServerVersionData) Compute(latestAvailableVersions map[images.UpdateFileComponent]string)

+ func (s *ServerVersionData) RecommendedAction() ServerAction

+ func (s *ServerVersionData) State() ServerUpdateState

type SystemUpdatesPut

+ ServerDefaultChannel string

+ UpdatesDefaultChannel string

type TokenPut

+ Channel string

type Update

+ UpstreamChannels []string

+ type UpdatePut struct

+ Channels []string

v0.2.2

Jan 20, 2026

Changes in this version

+ type ApplicationVersionData struct

+ Name string

+ Version string

+ type OSVersionData struct

+ Name string

+ NeedsReboot bool

+ Version string

+ VersionNext string

+ type ServerVersionData struct

+ Applications []ApplicationVersionData

+ OS OSVersionData

+ UpdateChannel string

+ func (s *ServerVersionData) Scan(value any) error

+ func (s ServerVersionData) Value() (driver.Value, error)

type TokenSeedConfigs

+ Update map[string]any

v0.2.1

Jan 9, 2026

v0.2.0

Jan 8, 2026

Changes in this version

+ type ServerSystemStorage = incusosapi.SystemStorage

type SystemSecurityPut

+ TrustedHTTPSProxies []string

v0.1.2

Dec 22, 2025

v0.1.1

Dec 18, 2025

v0.1.0

Dec 16, 2025

Changes in this version

+ const APIStatus

+ const APIVersion

+ const AuthenticationMethodOIDC

+ const AuthenticationMethodTLS

+ var ClusterDeleteModes = map[ClusterDeleteMode]struct

+ var ClusterStatuses = map[ClusterStatus]struct

+ var NotIncusOSError = notIncusOSError

+ var StatusCodeNames = map[StatusCode]string

+ func AsNotIncusOSError(err error) error

+ func CertEncodeToPEM(rawCert []byte) string

+ func StatusErrorCheck(err error, matchStatusCodes ...int) bool

+ func StatusErrorMatch(err error, matchStatusCodes ...int) (int, bool)

+ func X509CertEncodeToPEM(cert *x509.Certificate) string

+ type ACMEChallengeType string

+ const ACMEChallengeDNS

+ const ACMEChallengeHTTP

+ func (a ACMEChallengeType) Validate() error

+ type Certificate struct

+ func (c *Certificate) UnmarshalJSON(b []byte) error

+ func (c *Certificate) UnmarshalYAML(unmarshal func(v any) error) error

+ func (c Certificate) MarshalJSON() ([]byte, error)

+ func (c Certificate) MarshalYAML() (any, error)

+ func (c Certificate) String() string

+ type Cluster struct

+ Certificate string

+ Fingerprint string

+ LastUpdated time.Time

+ Name string

+ Status ClusterStatus

+ type ClusterArtifact struct

+ Cluster string

+ Description string

+ Files []ClusterArtifactFile

+ LastUpdated time.Time

+ Name string

+ Properties ConfigMap

+ type ClusterArtifactFile struct

+ MimeType string

+ Name string

+ Size int64

+ type ClusterCertificatePut struct

+ ClusterCertificate string

+ ClusterCertificateKey string

+ type ClusterDeleteMode string

+ const ClusterDeleteModeFactoryReset

+ const ClusterDeleteModeForce

+ const ClusterDeleteModeNormal

+ func (s ClusterDeleteMode) String() string

+ type ClusterPost struct

+ ApplicationSeedConfig map[string]any

+ ClusterTemplate string

+ ClusterTemplateVariableValues ConfigMap

+ ServerNames []string

+ ServerType ServerType

+ ServicesConfig map[string]any

+ type ClusterPut struct

+ ConnectionURL string

+ type ClusterStatus string

+ const ClusterStatusPending

+ const ClusterStatusReady

+ const ClusterStatusUnknown

+ func (s *ClusterStatus) Scan(value any) error

+ func (s *ClusterStatus) UnmarshalText(text []byte) error

+ func (s ClusterStatus) MarshalText() ([]byte, error)

+ func (s ClusterStatus) String() string

+ func (s ClusterStatus) Value() (driver.Value, error)

+ type ClusterTemplate struct

+ LastUpdated time.Time

+ type ClusterTemplatePost struct

+ Name string

+ type ClusterTemplatePut struct

+ ApplicationConfigTemplate string

+ Description string

+ ServiceConfigTemplate string

+ Variables ClusterTemplateVariables

+ type ClusterTemplateVariable struct

+ DefaultValue string

+ Description string

+ type ClusterTemplateVariables map[string]ClusterTemplateVariable

+ func (c *ClusterTemplateVariables) Scan(value any) error

+ func (c ClusterTemplateVariables) Value() (driver.Value, error)

+ type ConfigMap map[string]string

+ func (m *ConfigMap) Scan(value any) error

+ func (m *ConfigMap) UnmarshalJSON(data []byte) error

+ func (m *ConfigMap) UnmarshalYAML(unmarshal func(any) error) error

+ func (m ConfigMap) Value() (driver.Value, error)

+ type HardwareData struct

+ func (h *HardwareData) Scan(value any) error

+ func (h HardwareData) Value() (driver.Value, error)

+ type Image struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.Image

+ ProjectName string

+ UUID uuid.UUID

+ type ImageType string

+ const ImageTypeISO

+ const ImageTypeRaw

+ func (i *ImageType) UnmarshalText(text []byte) error

+ func (i ImageType) FileExt() string

+ func (i ImageType) IsValid() bool

+ func (i ImageType) MarshalText() ([]byte, error)

+ func (i ImageType) String() string

+ func (i ImageType) UpdateFileType() images.UpdateFileType

+ type Instance struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.InstanceFull

+ ProjectName string

+ Server string

+ UUID uuid.UUID

+ type InventoryAggregate struct

+ Cluster string

+ Images []Image

+ Instances []Instance

+ NetworkACLs []NetworkACL

+ NetworkAddressSets []NetworkAddressSet

+ NetworkForwards []NetworkForward

+ NetworkIntegrations []NetworkIntegration

+ NetworkLoadBalancers []NetworkLoadBalancer

+ NetworkPeers []NetworkPeer

+ NetworkZones []NetworkZone

+ Networks []Network

+ Profiles []Profile

+ Projects []Project

+ Servers []string

+ StorageBuckets []StorageBucket

+ StoragePools []StoragePool

+ StorageVolumes []StorageVolume

+ type Network struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.Network

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkACL struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.NetworkACL

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkAddressSet struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.NetworkAddressSet

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkForward struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ NetworkName string

+ Object incusapi.NetworkForward

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkIntegration struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.NetworkIntegration

+ UUID uuid.UUID

+ type NetworkLoadBalancer struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ NetworkName string

+ Object incusapi.NetworkLoadBalancer

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkPeer struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ NetworkName string

+ Object incusapi.NetworkPeer

+ ProjectName string

+ UUID uuid.UUID

+ type NetworkZone struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.NetworkZone

+ ProjectName string

+ UUID uuid.UUID

+ type OSData struct

+ Network incusosapi.SystemNetwork

+ Security incusosapi.SystemSecurity

+ Storage incusosapi.SystemStorage

+ func (h *OSData) Scan(value any) error

+ func (h OSData) Value() (driver.Value, error)

+ type Profile struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.Profile

+ ProjectName string

+ UUID uuid.UUID

+ type Project struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.Project

+ UUID uuid.UUID

+ type Response struct

+ Code int

+ Error string

+ Metadata json.RawMessage

+ Operation string

+ Status string

+ StatusCode int

+ Type ResponseType

+ func (r *Response) MetadataAsMap() (map[string]any, error)

+ func (r *Response) MetadataAsStringSlice() ([]string, error)

+ func (r *Response) MetadataAsStruct(target any) error

+ type ResponseRaw struct

+ Code int

+ Error string

+ Metadata any

+ Operation string

+ Status string

+ StatusCode int

+ Type ResponseType

+ type ResponseType string

+ const AsyncResponse

+ const ErrorResponse

+ const SyncResponse

+ type Server struct

+ Certificate string

+ Cluster string

+ Fingerprint string

+ HardwareData HardwareData

+ LastSeen time.Time

+ LastUpdated time.Time

+ OSData OSData

+ Status ServerStatus

+ Type ServerType

+ VersionData json.RawMessage

+ type ServerPost struct

+ ConnectionURL string

+ Name string

+ type ServerPut struct

+ PublicConnectionURL string

+ type ServerRegistrationResponse struct

+ ClientCertificate string

+ type ServerSelfUpdate struct

+ ConnectionURL string

+ type ServerStatus string

+ const ServerStatusPending

+ const ServerStatusReady

+ const ServerStatusUnknown

+ func (s *ServerStatus) Scan(value any) error

+ func (s *ServerStatus) UnmarshalText(text []byte) error

+ func (s ServerStatus) MarshalText() ([]byte, error)

+ func (s ServerStatus) String() string

+ func (s ServerStatus) Value() (driver.Value, error)

+ type ServerSystemNetwork = incusosapi.SystemNetwork

+ type ServerSystemProvider = incusosapi.SystemProvider

+ type ServerType string

+ const ServerTypeIncus

+ const ServerTypeMigrationManager

+ const ServerTypeOperationsCenter

+ const ServerTypeUnknown

+ func (s *ServerType) Scan(value any) error

+ func (s *ServerType) UnmarshalText(text []byte) error

+ func (s ServerType) MarshalText() ([]byte, error)

+ func (s ServerType) String() string

+ func (s ServerType) Value() (driver.Value, error)

+ type ServerUntrusted struct

+ APIStatus string

+ APIVersion string

+ Auth string

+ AuthMethods []string

+ type StatusCode int

+ const Failure

+ const Success

+ func (o StatusCode) String() string

+ type StatusError struct

+ func StatusErrorf(status int, format string, a ...any) StatusError

+ func (e StatusError) Error() string

+ func (e StatusError) Status() int

+ type StorageBucket struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.StorageBucketFull

+ ProjectName string

+ Server string

+ StoragePoolName string

+ UUID uuid.UUID

+ type StoragePool struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.StoragePool

+ UUID uuid.UUID

+ type StorageVolume struct

+ Cluster string

+ LastUpdated time.Time

+ Name string

+ Object incusapi.StorageVolumeFull

+ ProjectName string

+ Server string

+ StoragePoolName string

+ Type string

+ UUID uuid.UUID

+ type SystemCertificatePost struct

+ Certificate string

+ Key string

+ type SystemNetwork struct

+ type SystemNetworkPut struct

+ OperationsCenterAddress string

+ RestServerAddress string

+ type SystemSecurity struct

+ type SystemSecurityACME struct

+ Address string

+ AgreeTOS bool

+ CAURL string

+ Challenge ACMEChallengeType

+ Domain string

+ Email string

+ Provider string

+ ProviderEnvironment []string

+ ProviderResolvers []string

+ type SystemSecurityOIDC struct

+ Audience string

+ Claim string

+ ClientID string

+ Issuer string

+ Scope string

+ type SystemSecurityOpenFGA struct

+ APIToken string

+ APIURL string

+ StoreID string

+ type SystemSecurityPut struct

+ ACME SystemSecurityACME

+ OIDC SystemSecurityOIDC

+ OpenFGA SystemSecurityOpenFGA

+ TrustedTLSClientCertFingerprints []string

+ type SystemSettings struct

+ type SystemSettingsPut struct

+ LogLevel string

+ type SystemUpdates struct

+ type SystemUpdatesPut struct

+ FileFilterExpression string

+ FilterExpression string

+ SignatureVerificationRootCA string

+ Source string

+ type Token struct

+ UUID uuid.UUID

+ type TokenImagePost struct

+ Architecture images.UpdateFileArchitecture

+ Seeds TokenSeedConfigs

+ Type ImageType

+ type TokenProviderConfig struct

+ Version string

+ type TokenPut struct

+ Description string

+ ExpireAt time.Time

+ UsesRemaining int

+ type TokenSeed struct

+ LastUpdated time.Time

+ Token uuid.UUID

+ type TokenSeedConfigs struct

+ Applications map[string]any

+ Incus map[string]any

+ Install map[string]any

+ MigrationManager map[string]any

+ Network map[string]any

+ OperationsCenter map[string]any

+ type TokenSeedPost struct

+ Name string

+ type TokenSeedPut struct

+ Description string

+ Public bool

+ Seeds TokenSeedConfigs

+ type Update struct

+ Changelog string

+ Channels []string

+ Origin string

+ PublishedAt time.Time

+ Severity images.UpdateSeverity

+ Status UpdateStatus

+ URL string

+ UUID uuid.UUID

+ Version string

+ type UpdateFile struct

+ Architecture images.UpdateFileArchitecture

+ Component images.UpdateFileComponent

+ Filename string

+ Sha256 string

+ Size int

+ Type images.UpdateFileType

+ type UpdateStatus string

+ const UpdateStatusPending

+ const UpdateStatusReady

+ const UpdateStatusUnknown

+ func (s *UpdateStatus) Scan(value any) error

+ func (s *UpdateStatus) UnmarshalText(text []byte) error

+ func (s UpdateStatus) MarshalText() ([]byte, error)

+ func (s UpdateStatus) String() string

+ func (s UpdateStatus) Value() (driver.Value, error)

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