Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.1.0

Nov 23, 2025

Changes in this version

+ const APIStatus

+ const APIVersion

+ const DefaultStoragePool

+ const DefaultTarget

+ const DefaultTargetProject

+ func CertEncodeToPEM(rawCert []byte) string

+ func ValidNICType(s string) error

+ func X509CertEncodeToPEM(cert *x509.Certificate) string

+ type Artifact struct

+ Files []string

+ LastUpdated time.Time

+ UUID uuid.UUID

+ func (a Artifact) DefaultArtifactFile() (string, error)

+ type ArtifactPost struct

+ Type ArtifactType

+ type ArtifactPut struct

+ Architectures []string

+ Description string

+ OS OSType

+ SourceType SourceType

+ Versions []string

+ type ArtifactType string

+ const ARTIFACTTYPE_DRIVER

+ const ARTIFACTTYPE_OSIMAGE

+ const ARTIFACTTYPE_SDK

+ type Batch struct

+ StartDate time.Time

+ Status BatchStatusType

+ StatusMessage string

+ type BatchConfig struct

+ BackgroundSyncInterval string

+ FinalBackgroundSyncLimit string

+ PlacementScriptlet string

+ PostMigrationRetries int

+ RerunScriptlets bool

+ RestrictionOverrides InstanceRestrictionOverride

+ type BatchConstraint struct

+ Description string

+ IncludeExpression string

+ MaxConcurrentInstances int

+ MinInstanceBootTime string

+ Name string

+ type BatchDefaults struct

+ MigrationNetwork []MigrationNetworkPlacement

+ Placement BatchPlacement

+ type BatchPlacement struct

+ StoragePool string

+ Target string

+ TargetProject string

+ type BatchPut struct

+ Config BatchConfig

+ Constraints []BatchConstraint

+ Defaults BatchDefaults

+ IncludeExpression string

+ MigrationWindows []MigrationWindow

+ Name string

+ type BatchStatusType string

+ const BATCHSTATUS_DEFINED

+ const BATCHSTATUS_ERROR

+ const BATCHSTATUS_FINISHED

+ const BATCHSTATUS_RUNNING

+ const BATCHSTATUS_STOPPED

+ func (b BatchStatusType) 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 ExternalConnectivityStatus string

+ const EXTERNALCONNECTIVITYSTATUS_AUTH_ERROR

+ const EXTERNALCONNECTIVITYSTATUS_CANNOT_CONNECT

+ const EXTERNALCONNECTIVITYSTATUS_OK

+ const EXTERNALCONNECTIVITYSTATUS_TLS_CONFIRM_FINGERPRINT

+ const EXTERNALCONNECTIVITYSTATUS_TLS_ERROR

+ const EXTERNALCONNECTIVITYSTATUS_UNKNOWN

+ const EXTERNALCONNECTIVITYSTATUS_WAITING_OIDC

+ func MapExternalConnectivityStatusToStatus(err error) ExternalConnectivityStatus

+ type IncusNICType string

+ const INCUSNICTYPE_BRIDGED

+ const INCUSNICTYPE_MANAGED

+ type IncusProperties struct

+ ConnectionTimeout string

+ ConnectivityStatus ExternalConnectivityStatus

+ CreateLimit int

+ Endpoint string

+ ImportLimit int

+ OIDCTokens *oidc.Tokens[*oidc.IDTokenClaims]

+ ServerCertificate []byte

+ TLSClientCert string

+ TLSClientKey string

+ TrustedServerCertificateFingerprint string

+ type Instance struct

+ LastUpdateFromSource time.Time

+ Overrides InstanceOverride

+ Properties InstanceProperties

+ Source string

+ SourceType SourceType

+ func (i Instance) GetName() string

+ type InstanceOverride struct

+ Comment string

+ DisableMigration bool

+ IgnoreRestrictions bool

+ LastUpdate time.Time

+ Properties InstancePropertiesConfigurable

+ type InstanceProperties struct

+ BackgroundImport bool

+ Disks []InstancePropertiesDisk

+ LegacyBoot bool

+ Location string

+ NICs []InstancePropertiesNIC

+ Running bool

+ SecureBoot bool

+ Snapshots []InstancePropertiesSnapshot

+ TPM bool

+ UUID uuid.UUID

+ func (i *InstanceProperties) Apply(cfg InstancePropertiesConfigurable)

+ type InstancePropertiesConfigurable struct

+ Architecture string

+ CPUs int64

+ Config map[string]string

+ Description string

+ Memory int64

+ Name string

+ OS string

+ OSVersion string

+ type InstancePropertiesDisk struct

+ Capacity int64

+ Name string

+ Shared bool

+ Supported bool

+ type InstancePropertiesNIC struct

+ HardwareAddress string

+ IPv4Address string

+ IPv6Address string

+ Location string

+ SourceSpecificID string

+ UUID uuid.UUID

+ type InstancePropertiesSnapshot struct

+ Name string

+ type InstanceRestrictionOverride struct

+ AllowNoBackgroundImport bool

+ AllowNoIPv4 bool

+ AllowUnknownOS bool

+ type MigrationNetworkPlacement struct

+ Target string

+ TargetProject string

+ type MigrationStatusType string

+ const MIGRATIONSTATUS_BACKGROUND_IMPORT

+ const MIGRATIONSTATUS_BLOCKED

+ const MIGRATIONSTATUS_CANCELED

+ const MIGRATIONSTATUS_CREATING

+ const MIGRATIONSTATUS_ERROR

+ const MIGRATIONSTATUS_FINAL_IMPORT

+ const MIGRATIONSTATUS_FINISHED

+ const MIGRATIONSTATUS_IDLE

+ const MIGRATIONSTATUS_POST_IMPORT

+ const MIGRATIONSTATUS_WAITING

+ const MIGRATIONSTATUS_WORKER_DONE

+ func (m MigrationStatusType) Validate() error

+ type MigrationWindow struct

+ Config MigrationWindowConfig

+ End time.Time

+ Lockout time.Time

+ Name string

+ Start time.Time

+ type MigrationWindowConfig struct

+ Capacity int

+ type Network struct

+ Location string

+ Overrides NetworkPlacement

+ Placement NetworkPlacement

+ Properties json.RawMessage

+ Source string

+ SourceSpecificID string

+ Type NetworkType

+ UUID uuid.UUID

+ type NetworkPlacement struct

+ NICType IncusNICType

+ Network string

+ VlanID string

+ func (n *NetworkPlacement) Apply(overrides NetworkPlacement)

+ type NetworkType string

+ const NETWORKTYPE_VMWARE_DISTRIBUTED

+ const NETWORKTYPE_VMWARE_DISTRIBUTED_NSX

+ const NETWORKTYPE_VMWARE_NSX

+ const NETWORKTYPE_VMWARE_STANDARD

+ type OSType string

+ const OSTYPE_FORTIGATE

+ const OSTYPE_LINUX

+ const OSTYPE_WINDOWS

+ type Placement struct

+ Networks map[string]NetworkPlacement

+ StoragePools map[string]string

+ TargetName string

+ TargetProject string

+ type QueueEntry struct

+ BatchName string

+ InstanceName string

+ InstanceUUID uuid.UUID

+ LastWorkerResponse time.Time

+ MigrationStatus MigrationStatusType

+ MigrationStatusMessage string

+ MigrationWindow MigrationWindow

+ Placement Placement

+ type ServerPut struct

+ Config map[string]string

+ type ServerUntrusted struct

+ APIStatus string

+ APIVersion string

+ Auth string

+ AuthMethods []string

+ type Source struct

+ SourceType SourceType

+ type SourcePut struct

+ Name string

+ Properties json.RawMessage

+ type SourceType string

+ const SOURCETYPE_COMMON

+ const SOURCETYPE_NSX

+ const SOURCETYPE_VMWARE

+ func NetworkSourceTypes() []SourceType

+ func VMSourceTypes() []SourceType

+ type SystemCertificatePost struct

+ CA string

+ Cert string

+ Key string

+ type SystemConfig struct

+ Network SystemNetwork

+ Security SystemSecurity

+ Settings SystemSettings

+ type SystemNetwork struct

+ Address string

+ WorkerEndpoint string

+ type SystemSecurity struct

+ OIDC SystemSecurityOIDC

+ OpenFGA SystemSecurityOpenFGA

+ TrustedTLSClientCertFingerprints []string

+ type SystemSecurityOIDC struct

+ Audience string

+ Claim string

+ ClientID string

+ Issuer string

+ Scope string

+ type SystemSecurityOpenFGA struct

+ APIToken string

+ APIURL string

+ StoreID string

+ type SystemSettings struct

+ DisableAutoSync bool

+ LogLevel string

+ SyncInterval string

+ type Target struct

+ TargetType TargetType

+ type TargetPut struct

+ Name string

+ Properties json.RawMessage

+ type TargetType string

+ const TARGETTYPE_INCUS

+ type VMwareProperties struct

+ ConnectivityStatus ExternalConnectivityStatus

+ Endpoint string

+ ImportLimit int

+ Password string

+ ServerCertificate []byte

+ TrustedServerCertificateFingerprint string

+ Username string

+ type Warning struct

+ Count int

+ FirstSeenDate time.Time

+ LastSeenDate time.Time

+ Messages []string

+ Scope WarningScope

+ Type WarningType

+ UUID uuid.UUID

+ UpdatedDate time.Time

+ type WarningPut struct

+ Status WarningStatus

+ type WarningScope struct

+ Entity string

+ EntityType string

+ Scope string

+ func WarningScopeSync() WarningScope

+ func (s WarningScope) Match(w Warning) bool

+ type WarningStatus string

+ const WARNINGSTATUS_ACKNOWLEDGED

+ const WARNINGSTATUS_NEW

+ type WarningType string

+ const InstanceCannotMigrate

+ const InstanceImportFailed

+ const InstanceIncomplete

+ const InstanceMissingNetworkSource

+ const NetworkImportFailed

+ const SourceUnavailable

+ type WorkerCommand struct

+ Architecture string

+ Command WorkerCommandType

+ Location string

+ OS string

+ OSType OSType

+ OSVersion string

+ Source json.RawMessage

+ SourceType SourceType

+ type WorkerCommandType int

+ const WORKERCOMMAND_FINALIZE_IMPORT

+ const WORKERCOMMAND_IDLE

+ const WORKERCOMMAND_IMPORT_DISKS

+ const WORKERCOMMAND_POST_IMPORT

+ const WORKERCOMMAND_UNKNOWN

+ type WorkerResponse struct

+ Status WorkerResponseType

+ StatusMessage string

+ type WorkerResponseType int

+ const WORKERRESPONSE_FAILED

+ const WORKERRESPONSE_RUNNING

+ const WORKERRESPONSE_SUCCESS

+ const WORKERRESPONSE_UNKNOWN

v0.0.0-pre.5

Sep 29, 2025

v0.0.0-pre.4

Jul 14, 2025

v0.0.0-pre.3

Apr 11, 2025

v0.0.0-pre.2

Feb 28, 2025

v0.0.0-pre.1

Feb 17, 2025