api

type ApplicationVersionData struct {
	// Name of the software component.
	// Example: IncusOS
	Name string `json:"name" yaml:"name"`

	// Version string.
	// Example: 202512250102
	Version string `json:"version" yaml:"version"`

	// AvailableVersion is the most recent version available for this application
	// in the update channel assigned to the respective system.
	AvailableVersion *string `json:"available_version,omitempty" yaml:"available_version,omitempty"`

	// NeedsUpdate is true, if this application needs to be updated
	// (available_version > version).
	NeedsUpdate *bool `json:"needs_update,omitempty" yaml:"needs_update,omitempty"`

	// InMaintenance is the application state indicating if the application
	// is in maintenance mode (e.g. for Incus, if it has been evacuated).
	InMaintenance InMaintenanceState `json:"in_maintenance" yaml:"in_maintenance"`
}

type Certificate struct {
	*x509.Certificate
}

type Channel struct {
	ChannelPost

	// LastUpdated is the time, when this information has been updated for the last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type ChannelPost struct {
	ChannelPut

	// Name of the channel.
	// Example: stable
	Name string `json:"name" yaml:"name"`
}

type ChannelPut struct {
	// Description of the channel.
	// Example: stable channel, used for production.
	Description string `json:"description" yaml:"description"`
}

type Cluster struct {
	ClusterPut `yaml:",inline"`

	// A human-friendly name for this cluster.
	// Example: MyCluster
	Name string `json:"name" yaml:"name"`

	// Certificate of the cluster endpoint in PEM encoded format.
	// Example:
	//	-----BEGIN CERTIFICATE-----
	//	...
	//	-----END CERTIFICATE-----
	Certificate string `json:"certificate" yaml:"certificate"`

	// Fingerprint in SHA256 format of the certificate.
	// Example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69
	Fingerprint string `json:"fingerprint" yaml:"fingerprint"`

	// Status contains the status the cluster is currently in from the point of view of Operations Center.
	// Possible values for status are: pending, ready
	// Example: pending
	Status ClusterStatus `json:"status" yaml:"status"`

	// UpdateStatus contains the aggregated update state for the cluster,
	// which consists of the lowest state of all the servers of the cluster.
	//
	// Additionally, it contains details about an ongoing cluster wide update
	// process if any.
	UpdateStatus ClusterUpdateStatus `json:"update_status" yaml:"update_status"`

	// LastUpdated is the time, when this information has been updated for the last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type ClusterArtifact struct {
	// Cluster the artifact belongs to.
	// Example: cluster01
	Cluster string `json:"cluster" yaml:"cluster"`

	// Name of the artifact
	// Example: terraform-configuration
	Name string `json:"name" yaml:"name"`

	// Description of the cluster artifact.
	// Example: Terraform configuration.
	Description string `json:"description" yaml:"description"`

	// Properties contains properties of the artifact as key/value pairs.
	// Example (in YAML notation for readability):
	//   properties:
	//     arch: x86_64
	//     os: linux
	Properties ConfigMap `json:"properties" yaml:"properties"`

	// Files contains the list of files, that form the given artifact.
	Files []ClusterArtifactFile `json:"files" yaml:"files"`

	// LastUpdated is the time, when this information has been updated for the
	// last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type ClusterArtifactFile struct {
	// Name of the artifact file.
	// Example: somefile.txt
	Name string `json:"name" yaml:"name"`

	// MimeType of the artifact file, used when the file content is returned
	// to set the correct Content-Type header.
	// Example: text/plain
	MimeType string `json:"mime_type" yaml:"mime_type"`

	// Size of the File in bytes.
	// Example: 54300000
	Size int64 `json:"size" yaml:"size"`
}

type ClusterBulkUpdateAction string

type ClusterBulkUpdatePost struct {
	// Action to be executed for this bulk update.
	Action ClusterBulkUpdateAction `json:"action" yaml:"action"`

	// Arguments for the action, the exact structure depends on the
	// defined action.
	Arguments *json.RawMessage `json:"arguments" yaml:"arguments"`
}

type ClusterCertificatePut struct {
	// The new certificate (X509 PEM encoded) for the cluster.
	// Example: X509 PEM certificate
	ClusterCertificate string `json:"cluster_certificate" yaml:"cluster_certificate"`

	// The new certificate key (X509 PEM encoded) for the cluster.
	// Example: X509 PEM certificate key
	ClusterCertificateKey string `json:"cluster_certificate_key" yaml:"cluster_certificate_key"`
}

type ClusterConfig struct {
	RollingRestart ClusterConfigRollingRestart `json:"rolling_restart" yaml:"rolling_restart"`
}

type ClusterConfigRollingRestart struct {
	// PostRestoreDelay holds the time, that is waited between the resore
	// of a server and the evacuation of the next server. This should be set if
	// RestoreMode is kept at the default value in order to grant a cluster
	// enough time to move previously evacuated instances back to their
	// originating server.
	PostRestoreDelay time.Duration `json:"post_restore_delay" yaml:"post_restore_delay"`

	// RestoreMode is the mode applied dring Incus restore operation. Valid
	// values are "" (default, move instances back, that have been evacuated
	// previously) and "skip" (skip moving evacuated instances back).
	// Example: skip
	RestoreMode string `json:"restore_mode" yaml:"restore_mode"`
}

type ClusterDeleteMode string

type ClusterPost struct {
	Cluster `yaml:",inline"`

	// Names of the servers beloning to the cluster.
	// Example: [ "server1", "server2" ]
	ServerNames []string `json:"server_names" yaml:"server_names"`

	// ServerType is the expected type of servers to be clustered.
	// Clustering will fail, if not all the servers are of the same type.
	ServerType ServerType `json:"server_type" yaml:"server_type"`

	// ServicesConfig contains the configuration for each service, which should be configured on Hypervisor OS.
	// Operations Center is simply passing forward the settings to Hypervisor OS.
	// For details about the configuration settings available refer to the service
	// API definitions in https://github.com/lxc/incus-os/tree/main/incus-osd/api.
	ServicesConfig map[string]any `json:"services_config" yaml:"services_config"`

	// ApplicationSeedConfig contains the seed configuration for the application, which is
	// applied during post clustering. This configuration is application specific.
	ApplicationSeedConfig map[string]any `json:"application_seed_config" yaml:"application_seed_config"`

	// ClusterTemplate contains the name of a cluster template, which should be
	// used for the cluster creation.
	// If ClusterTemplate is a none empty string, the respective cluster template
	// is used and the values in ServiceConfig and ApplicationConfig are
	// disregarded. If the cluster template is not found, an error is returned.
	ClusterTemplate string `json:"cluster_template" yaml:"cluster_template"`

	// ClusterTemplateVariableValues contains the variable values, which should
	// be applied to the respective placeholders in the cluster template.
	ClusterTemplateVariableValues ConfigMap `json:"cluster_template_variable_values" yaml:"cluster_template_variable_values"`
}

type ClusterPut struct {
	// URL, hostname or IP address of the cluster endpoint.
	// This is only user facing, e.g. the address of a load balancer infront of
	// the cluster and not used by Operations Center for direct communication
	// Operations Center relies on the connection URL of the cluster members.
	// Example: https://incus.local:6443
	ConnectionURL string `json:"connection_url" yaml:"connection_url"`

	// Channel the cluster is following for updates.
	// Example: stable
	Channel string `json:"channel" yaml:"channel"`

	// Description of the cluster.
	// Example: Lab cluster with limited resources.
	Description string `json:"description" yaml:"description"`

	// Properties contains properties of the cluster as key/value pairs.
	// Example (in YAML notation for readability):
	//   properties:
	//     env: lab
	Properties ConfigMap `json:"properties" yaml:"properties"`

	// Config contains cluster wide configuration used by Operations Center
	// when interacting with the cluster. For example waiting delays during
	// cluster evacuation and restore, before a subsequent server is processed.
	Config ClusterConfig `json:"config" yaml:"config"`
}

type ClusterStatus string

type ClusterTemplate struct {
	ClusterTemplatePost `yaml:",inline"`

	// LastUpdated is the time, when this information has been updated for the last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type ClusterTemplatePost struct {
	ClusterTemplatePut `yaml:",inline"`

	// A human-friendly name for this cluster config template.
	// Example: MyTemplate
	Name string `json:"name" yaml:"name"`
}

type ClusterTemplatePut struct {
	// Description of the cluster config template.
	// Example: Cluster configuration for production clusters.
	Description string `json:"description" yaml:"description"`

	// ServiceConfigTemplate represents a template the service config for cluster
	// creation.
	// It contains contains the configuration for each service, which should be
	// configured on Hypervisor OS.
	// Operations Center is simply passing forward the settings to Hypervisor OS.
	// For details about the configuration settings available refer to the service
	// API definitions in https://github.com/lxc/incus-os/tree/main/incus-osd/api.
	ServiceConfigTemplate string `json:"service_config_template" yaml:"service_config_template"`

	// ApplicationConfigTemplate represents a template for the application config
	// for cluster creation.
	// It contains the seed configuration for the application, which is
	// applied during post clustering. This configuration is application specific.
	ApplicationConfigTemplate string `json:"application_config_template" yaml:"application_config_template"`

	// Variables is a map of variable names to variable definitions.
	Variables ClusterTemplateVariables `json:"variables" yaml:"variables"`
}

type ClusterTemplateVariable struct {
	// Description describes a cluster config template variable.
	// Example: Long name for the cluster.
	Description string `json:"description" yaml:"description"`

	// DefaultValue is the default value applied for a cluster config variable
	// if no value is provided for the variable.
	// Example: Incus cluster
	DefaultValue string `json:"default" yaml:"default"`
}

type ClusterTemplateVariables map[string]ClusterTemplateVariable

type ClusterUpdateInProgress string

type ClusterUpdateInProgressStatus struct {
	// InProgress is true, if a cluster wide update is on going and false
	// otherwise.
	// Example: true
	InProgress ClusterUpdateInProgress `json:"in_progress" yaml:"in_progress"`

	// StatusDescription contains progress information for the user in plain text
	// form.
	// Example: [3/20] Evacuating server xyz
	StatusDescription *string `json:"status_description,omitempty" yaml:"status_description"`

	// EvacuatedBefore contains the list of server names of the servers, that have
	// been manually evacuated already before the rolling update has been
	// triggered.
	EvacuatedBefore []string `json:"evacuated_before" yaml:"evacuated_before"`

	// LastUpdated is the time, when this information has been updated for the
	// last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type ClusterUpdatePost struct {
	// Reboot indicates ifif after the update a rolling reboot of the servers
	// should be triggered or not. If reboot is set to true, the servers are
	// rebooted, otherwise only the updates are applied without reboot (OS updates
	// will require a reboot at a later stage).
	Reboot bool `json:"reboot" yaml:"reboot"`
}

type ClusterUpdateStatus struct {
	// NeedsUpdate holds the list of server names of the servers within the
	// cluster, which need to be updated. If NeedsUpdate is empty, all servers are
	// up to date.
	NeedsUpdate []string `json:"needs_update,omitempty" yaml:"needs_update"`

	// NeedsReboot holds the list of server names of the servers within the
	// cluster, which need to be rebooted. If NeedsReboot is empty, all servers
	// are up to date and don't require a reboot.
	NeedsReboot []string `json:"needs_reboot,omitempty" yaml:"needs_reboot"`

	// InMaintenance holds the list of server names of the servers within the
	// cluster, which are currently in a maintenance state other than
	// `NotInMaintenance`. If InMaintenance is empty, all servers are fully
	// operational and not in maintenance.
	InMaintenance []string `json:"in_maintenance,omitempty" yaml:"in_maintenance"`

	// InProgressStatus holds the status information about an ongoing cluster
	// update, if any.
	InProgressStatus ClusterUpdateInProgressStatus `json:"in_progress_status" yaml:"in_progress_status"`
}

type ConfigMap map[string]string

type HardwareData struct {
	incusapi.Resources
}

type Image struct {
	UUID        uuid.UUID      `json:"uuid" yaml:"uuid"`
	Cluster     string         `json:"cluster" yaml:"cluster"`
	ProjectName string         `json:"project_name" yaml:"project_name"`
	Name        string         `json:"name" yaml:"name"`
	Object      incusapi.Image `json:"object" yaml:"object"`
	LastUpdated time.Time      `json:"last_updated" yaml:"last_updated"`
}

type ImageType string

type InMaintenanceState int

type Instance struct {
	UUID        uuid.UUID             `json:"uuid" yaml:"uuid"`
	Cluster     string                `json:"cluster" yaml:"cluster"`
	Server      string                `json:"server" yaml:"server"`
	ProjectName string                `json:"project_name" yaml:"project_name"`
	Name        string                `json:"name" yaml:"name"`
	Object      incusapi.InstanceFull `json:"object" yaml:"object"`
	LastUpdated time.Time             `json:"last_updated" yaml:"last_updated"`
}

type InventoryAggregate struct {
	Cluster              string                `json:"cluster" yaml:"cluster"`
	Servers              []string              `json:"servers" yaml:"servers"`
	Images               []Image               `json:"images" yaml:"images"`
	Instances            []Instance            `json:"instances" yaml:"instances"`
	Networks             []Network             `json:"networks" yaml:"networks"`
	NetworkACLs          []NetworkACL          `json:"network_acls" yaml:"network_acls"`
	NetworkAddressSets   []NetworkAddressSet   `json:"network_address_sets" yaml:"network_address_sets"`
	NetworkForwards      []NetworkForward      `json:"network_forwards" yaml:"network_forwards"`
	NetworkIntegrations  []NetworkIntegration  `json:"network_integrations" yaml:"network_integrations"`
	NetworkLoadBalancers []NetworkLoadBalancer `json:"network_load_balancers" yaml:"network_load_balancers"`
	NetworkPeers         []NetworkPeer         `json:"network_peers" yaml:"network_peers"`
	NetworkZones         []NetworkZone         `json:"network_zones" yaml:"network_zones"`
	Profiles             []Profile             `json:"profiles" yaml:"profiles"`
	Projects             []Project             `json:"projects" yaml:"projects"`
	StorageBuckets       []StorageBucket       `json:"storage_buckets" yaml:"storage_buckets"`
	StoragePools         []StoragePool         `json:"storage_pools" yaml:"storage_pools"`
	StorageVolumes       []StorageVolume       `json:"storage_volumes" yaml:"storage_volumes"`
}

type Network struct {
	UUID        uuid.UUID        `json:"uuid" yaml:"uuid"`
	Cluster     string           `json:"cluster" yaml:"cluster"`
	ProjectName string           `json:"project_name" yaml:"project_name"`
	Name        string           `json:"name" yaml:"name"`
	Object      incusapi.Network `json:"object" yaml:"object"`
	LastUpdated time.Time        `json:"last_updated" yaml:"last_updated"`
}

type NetworkACL struct {
	UUID        uuid.UUID           `json:"uuid" yaml:"uuid"`
	Cluster     string              `json:"cluster" yaml:"cluster"`
	ProjectName string              `json:"project_name" yaml:"project_name"`
	Name        string              `json:"name" yaml:"name"`
	Object      incusapi.NetworkACL `json:"object" yaml:"object"`
	LastUpdated time.Time           `json:"last_updated" yaml:"last_updated"`
}

type NetworkAddressSet struct {
	UUID        uuid.UUID                  `json:"uuid" yaml:"uuid"`
	Cluster     string                     `json:"cluster" yaml:"cluster"`
	ProjectName string                     `json:"project_name" yaml:"project_name"`
	Name        string                     `json:"name" yaml:"name"`
	Object      incusapi.NetworkAddressSet `json:"object" yaml:"object"`
	LastUpdated time.Time                  `json:"last_updated" yaml:"last_updated"`
}

type NetworkForward struct {
	UUID        uuid.UUID               `json:"uuid" yaml:"uuid"`
	Cluster     string                  `json:"cluster" yaml:"cluster"`
	ProjectName string                  `json:"project_name" yaml:"project_name"`
	NetworkName string                  `json:"parent_name" yaml:"parent_name"`
	Name        string                  `json:"name" yaml:"name"`
	Object      incusapi.NetworkForward `json:"object" yaml:"object"`
	LastUpdated time.Time               `json:"last_updated" yaml:"last_updated"`
}

type NetworkIntegration struct {
	UUID        uuid.UUID                   `json:"uuid" yaml:"uuid"`
	Cluster     string                      `json:"cluster" yaml:"cluster"`
	Name        string                      `json:"name" yaml:"name"`
	Object      incusapi.NetworkIntegration `json:"object" yaml:"object"`
	LastUpdated time.Time                   `json:"last_updated" yaml:"last_updated"`
}

type NetworkLoadBalancer struct {
	UUID        uuid.UUID                    `json:"uuid" yaml:"uuid"`
	Cluster     string                       `json:"cluster" yaml:"cluster"`
	ProjectName string                       `json:"project_name" yaml:"project_name"`
	NetworkName string                       `json:"parent_name" yaml:"parent_name"`
	Name        string                       `json:"name" yaml:"name"`
	Object      incusapi.NetworkLoadBalancer `json:"object" yaml:"object"`
	LastUpdated time.Time                    `json:"last_updated" yaml:"last_updated"`
}

type NetworkPeer struct {
	UUID        uuid.UUID            `json:"uuid" yaml:"uuid"`
	Cluster     string               `json:"cluster" yaml:"cluster"`
	ProjectName string               `json:"project_name" yaml:"project_name"`
	NetworkName string               `json:"parent_name" yaml:"parent_name"`
	Name        string               `json:"name" yaml:"name"`
	Object      incusapi.NetworkPeer `json:"object" yaml:"object"`
	LastUpdated time.Time            `json:"last_updated" yaml:"last_updated"`
}

type NetworkZone struct {
	UUID        uuid.UUID            `json:"uuid" yaml:"uuid"`
	Cluster     string               `json:"cluster" yaml:"cluster"`
	ProjectName string               `json:"project_name" yaml:"project_name"`
	Name        string               `json:"name" yaml:"name"`
	Object      incusapi.NetworkZone `json:"object" yaml:"object"`
	LastUpdated time.Time            `json:"last_updated" yaml:"last_updated"`
}

type OSData struct {
	// Network contains the network data of the server OS, in the same form as presented by IncusOS in the network API.
	Network incusosapi.SystemNetwork `json:"network" yaml:"network"`

	// Security contains the security data of the server OS, in the same form as presented by IncusOS in the security API.
	Security incusosapi.SystemSecurity `json:"security" yaml:"security"`

	// Storage contains the storage data of the server OS, in the same form as presented by IncusOS in the storage API.
	Storage incusosapi.SystemStorage `json:"storage" yaml:"storage"`
}

type OSVersionData struct {
	// Name of the software component.
	// Example: IncusOS
	Name string `json:"name" yaml:"name"`

	// Version string.
	// Example: 202512250102
	Version string `json:"version" yaml:"version"`

	// Next Version string. If this version is different from "version",
	// an update is available and applied on the system, but the system has
	// not yet been rebooted, so the new update is not yet active.
	// Example: 202512250102
	VersionNext string `json:"version_next" yaml:"version_next"`

	// AvailableVersion is the most recent version available for the OS in the
	// update channel assigned to the respective system.
	AvailableVersion *string `json:"available_version,omitempty" yaml:"available_version,omitempty"`

	// NeedsReboot is the "needs_reboot" state reported by the server. Currently
	// this is only expected to be "true", if "version_next" is different than
	// "version", but in the future, there might be other reasons for a server
	// to report, that a reboot is required.
	NeedsReboot bool `json:"needs_reboot" yaml:"needs_reboot"`

	// NeedsUpdate is true, if the OS needs to be updated
	// (available_version > version_next).
	NeedsUpdate *bool `json:"needs_update,omitempty" yaml:"needs_update,omitempty"`
}

type Profile struct {
	UUID        uuid.UUID        `json:"uuid" yaml:"uuid"`
	Cluster     string           `json:"cluster" yaml:"cluster"`
	ProjectName string           `json:"project_name" yaml:"project_name"`
	Name        string           `json:"name" yaml:"name"`
	Object      incusapi.Profile `json:"object" yaml:"object"`
	LastUpdated time.Time        `json:"last_updated" yaml:"last_updated"`
}

type Project struct {
	UUID        uuid.UUID        `json:"uuid" yaml:"uuid"`
	Cluster     string           `json:"cluster" yaml:"cluster"`
	Name        string           `json:"name" yaml:"name"`
	Object      incusapi.Project `json:"object" yaml:"object"`
	LastUpdated time.Time        `json:"last_updated" yaml:"last_updated"`
}

type Response struct {
	Type ResponseType `json:"type" yaml:"type"`

	// Valid only for Sync responses
	Status     string `json:"status" yaml:"status"`
	StatusCode int    `json:"status_code" yaml:"status_code"`

	// Valid only for Async responses
	Operation string `json:"operation" yaml:"operation"`

	// Valid only for Error responses
	Code  int    `json:"error_code" yaml:"error_code"`
	Error string `json:"error" yaml:"error"`

	// Valid for Sync and Error responses
	Metadata json.RawMessage `json:"metadata" yaml:"metadata"`
}

type ResponseRaw struct {
	Type ResponseType `json:"type" yaml:"type"`

	// Valid only for Sync responses
	Status     string `json:"status" yaml:"status"`
	StatusCode int    `json:"status_code" yaml:"status_code"`

	// Valid only for Async responses
	Operation string `json:"operation" yaml:"operation"`

	// Valid only for Error responses
	Code  int    `json:"error_code" yaml:"error_code"`
	Error string `json:"error" yaml:"error"`

	// Valid for Sync and Error responses
	Metadata any `json:"metadata" yaml:"metadata"`
}

type ResponseType string

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 Server struct {
	ServerPost `yaml:",inline"`

	// Certificate of the server endpoint in PEM encoded format.
	// Example:
	//	-----BEGIN CERTIFICATE-----
	//	...
	//	-----END CERTIFICATE-----
	Certificate string `json:"certificate" yaml:"certificate"`

	// Fingerprint in SHA256 format of the certificate.
	// Example: fd200419b271f1dc2a5591b693cc5774b7f234e1ff8c6b78ad703b6888fe2b69
	Fingerprint string `json:"fingerprint" yaml:"fingerprint"`

	// The cluster the server is part of.
	// Example: one
	Cluster string `json:"cluster" yaml:"cluster"`

	// Type defines the type of the server, which is normally one of "incus", "migration-manager", "operations-center".
	// Example: incus
	Type ServerType `json:"server_type" yaml:"server_type"`

	// HardwareData contains the hardware data of the server, in the same form as presented by Incus in the resource API.
	HardwareData HardwareData `json:"hardware_data" yaml:"hardware_data"`

	// OSData contains the configuration data of the operating system, e.g. incus-os.
	OSData OSData `json:"os_data" yaml:"os_data"`

	// VersionData contains information about the servers version.
	VersionData ServerVersionData `json:"version_data" yaml:"version_data"`

	// Status contains the status the server is currently in from the point of view of Operations Center.
	// Possible values for status are: pending, ready
	// Example: pending
	Status ServerStatus `json:"server_status" yaml:"server_status"`

	// StatusDetail contains the secondary status, which gives additional details
	// on the server status.
	// Example: rebooting
	StatusDetail ServerStatusDetail `json:"server_status_detail" yaml:"server_status_detail"`

	// LastUpdated is the time, when this information has been updated for the last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`

	// LastSeen is the time, when this server has been seen for the last time
	// by any sort of connection between the server and operations center
	// in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastSeen time.Time `json:"last_seen" yaml:"last_seen"`

	// SystemStateIsTrusted is extracted from the OSData. The system state is
	// trusted, if this value is set to true. Otherwise the system state is not
	// trusted.
	SystemStateIsTrusted bool `json:"system_state_is_trusted" yaml:"system_state_is_trusted"`
}

type ServerAction string

type ServerPost struct {
	ServerPut `yaml:",inline"`

	// Name of the server.
	// Example: incus.local
	Name string `json:"name" yaml:"name"`

	// URL, hostname or IP address of the server endpoint used by Operations
	// Center for its communication.
	// Example: https://incus.local:6443
	ConnectionURL string `json:"connection_url" yaml:"connection_url"`
}

type ServerPut struct {
	// Public URL, hostname or IP address of the server endpoint for user facing
	// communication with the server. Only required, if it differs from
	// connection_url, e.g. because the server is behind a reverse proxy.
	// Example: https://incus.local:6443
	PublicConnectionURL string `json:"public_connection_url" yaml:"public_connection_url"`

	// Channel the server is following for updates.
	// Example: stable
	Channel string `json:"channel" yaml:"channel"`

	// Description of the server.
	// Example: Lab server with limited resources.
	Description string `json:"description" yaml:"description"`

	// Properties contains properties of the server as key/value pairs.
	// Example (in YAML notation for readability):
	//   properties:
	//     arch: x86_64
	//     os: linux
	Properties ConfigMap `json:"properties" yaml:"properties"`
}

type ServerRegistrationResponse struct {
	// ClientCertificate is the certificate in PEM format used by Operations Center
	// when connecting to servers or clusters.
	ClientCertificate string `json:"certificate" yaml:"certificate"`
}

type ServerSelfUpdate struct {
	// URL, hostname or IP address of the server endpoint.
	// Example: https://incus.local:6443
	ConnectionURL string `json:"connection_url" yaml:"connection_url"`
}

type ServerStatus string

type ServerStatusDetail string

type ServerSystemKernel = incusosapi.SystemKernel

type ServerSystemLogging = incusosapi.SystemLogging

type ServerSystemNetwork = incusosapi.SystemNetwork

type ServerSystemNetworkVLAN = incusosapi.SystemNetworkVLAN

type ServerSystemProvider = incusosapi.SystemProvider

type ServerSystemStorage = incusosapi.SystemStorage

type ServerSystemUpdate = incusosapi.SystemUpdate

type ServerType string

type ServerUntrusted struct {
	// Support status of the current API (one of "devel", "stable" or "deprecated")
	// Read only: true
	// Example: stable
	APIStatus string `json:"api_status" yaml:"api_status"`

	// API version number
	// Read only: true
	// Example: 1.0
	APIVersion string `json:"api_version" yaml:"api_version"`

	// Whether the client is trusted (one of "trusted" or "untrusted")
	// Read only: true
	// Example: untrusted
	Auth string `json:"auth" yaml:"auth"`

	// List of supported authentication methods
	// Read only: true
	// Example: ["tls"]
	//
	// API extension: macaroon_authentication
	AuthMethods []string `json:"auth_methods" yaml:"auth_methods"`

	// Server version number
	// Read only: true
	// Example: 1.0.0
	ServerVersion string `json:"server_version" yaml:"server_version"`
}

type ServerUpdateApplication struct {
	// Name of the software component.
	// Example: IncusOS
	Name string `json:"name" yaml:"name"`

	// TriggerUpdate triggers an update for the given application, if the provided
	// value is set to true.
	TriggerUpdate bool `json:"trigger_update" yaml:"trigger_update"`
}

type ServerUpdatePost struct {
	// Applications holds the update trigger information for the installed applications.
	Applications []ServerUpdateApplication `json:"applications" yaml:"applications"`

	// OS holds the update trigger information for the operating system.
	OS ServerUpdateApplication `json:"os" yaml:"os"`
}

type ServerUpdateState string

type ServerVersionData struct {
	// OS holds the version information for the operating system.
	OS OSVersionData `json:"os" yaml:"os"`

	// Applications holds the version information for the installed applications.
	Applications []ApplicationVersionData `json:"applications" yaml:"applications"`

	// The channel the system is following for updates.
	UpdateChannel string `json:"update_channel" yaml:"update_channel"`

	// NeedsUpdate is the aggregated state over OS and all applications indicating
	// if there is any component, where an update is available.
	NeedsUpdate *bool `json:"needs_update,omitempty" yaml:"needs_update"`

	// NeedsReboot is the aggregated state over OS and all applications indicating
	// if there is any component, where a reboot is required.
	NeedsReboot *bool `json:"needs_reboot,omitempty" yaml:"needs_reboot"`

	// InMaintenance is the aggreaged state over OS and all applications indicating
	// if there is any component currently in maintenance state.
	InMaintenance *InMaintenanceState `json:"in_maintenance,omitempty" yaml:"in_maintenance"`
}

type StatusCode int

type StatusError struct {
	// contains filtered or unexported fields
}

type StorageBucket struct {
	UUID            uuid.UUID                  `json:"uuid" yaml:"uuid"`
	Cluster         string                     `json:"cluster" yaml:"cluster"`
	Server          string                     `json:"server" yaml:"server"`
	ProjectName     string                     `json:"project_name" yaml:"project_name"`
	StoragePoolName string                     `json:"parent_name" yaml:"parent_name"`
	Name            string                     `json:"name" yaml:"name"`
	Object          incusapi.StorageBucketFull `json:"object" yaml:"object"`
	LastUpdated     time.Time                  `json:"last_updated" yaml:"last_updated"`
}

type StoragePool struct {
	UUID        uuid.UUID            `json:"uuid" yaml:"uuid"`
	Cluster     string               `json:"cluster" yaml:"cluster"`
	Name        string               `json:"name" yaml:"name"`
	Object      incusapi.StoragePool `json:"object" yaml:"object"`
	LastUpdated time.Time            `json:"last_updated" yaml:"last_updated"`
}

type StorageVolume struct {
	UUID            uuid.UUID                  `json:"uuid" yaml:"uuid"`
	Cluster         string                     `json:"cluster" yaml:"cluster"`
	Server          string                     `json:"server" yaml:"server"`
	ProjectName     string                     `json:"project_name" yaml:"project_name"`
	StoragePoolName string                     `json:"parent_name" yaml:"parent_name"`
	Name            string                     `json:"name" yaml:"name"`
	Type            string                     `json:"type" yaml:"type"`
	Object          incusapi.StorageVolumeFull `json:"object" yaml:"object"`
	LastUpdated     time.Time                  `json:"last_updated" yaml:"last_updated"`
}

type Token struct {
	TokenPut `yaml:",inline"`

	// UUID of the token, which serves as the the token.
	// Example: b32d0079-c48b-4957-b1cb-bef54125c861
	UUID uuid.UUID `json:"uuid" yaml:"uuid"`
}

type TokenImagePost struct {
	// Type contains the type of image to be generated.
	// Possible values for status are: iso, raw
	// Example: iso
	Type ImageType `json:"type" yaml:"type"`

	// Architecture contains the CPU architecture the image should be generated
	// for.
	Architecture images.UpdateFileArchitecture `json:"architecture" yaml:"architecture"`

	// Seeds represents the seed configuration for e.g. applications.yaml,
	// install.yaml and network.yaml.
	Seeds TokenSeedConfigs `json:"seeds" yaml:"seeds"`
}

type TokenProviderConfig struct {
	api.SystemProviderConfig `yaml:",inline"`

	Version string `json:"version" yaml:"version"`
}

type TokenPut struct {
	// Value indicating, how many times the token might be used for registration.
	// Example: 10
	UsesRemaining int `json:"uses_remaining" yaml:"uses_remaining"`

	// The time at which the token expires in RFC3339 format with seconds precision.
	// Example: "2025-02-04T07:25:47Z"
	ExpireAt time.Time `json:"expire_at" yaml:"expire_at"`

	// Description of this token.
	// Example: "Test Environment"
	Description string `json:"description" yaml:"description"`

	// Channel, used to seed images as well as which gets assigned to servers
	// using this token during provisioning.
	// Example: "stable"
	Channel string `json:"channel" yaml:"channel"`
}

type TokenSeed struct {
	TokenSeedPost `yaml:",inline"`

	// UUID of the token.
	// Example: b32d0079-c48b-4957-b1cb-bef54125c861
	Token uuid.UUID `json:"token_uuid" yaml:"token_uuid"`

	// LastUpdated is the time, when this information has been updated for the last time in RFC3339 format.
	// Example: 2024-11-12T16:15:00Z
	LastUpdated time.Time `json:"last_updated" yaml:"last_updated"`
}

type TokenSeedConfigs struct {
	// Applications represents the applications configuration (applications.yaml) to be included in the pre-seeded image.
	Applications SeedApplications `json:"applications" yaml:"applications"`

	// Incus represents the incus preseed configuration (incus.yaml) fo be included in the pre-seeded image.
	Incus SeedIncus `json:"incus" yaml:"incus"`

	// Install represents the install configuration (install.yaml) to be included in the pre-seeded image.
	Install SeedInstall `json:"install" yaml:"install"`

	// MigrationManager represents the seed configuration for migration manager (migration-manager.yaml) to be included in the pre-seeded image.
	MigrationManager SeedMigrationManager `json:"migration_manager" yaml:"migration_manager"`

	// Network represents the network configuration (network.yaml) to be included in the pre-seeded image.
	Network SeedNetwork `json:"network" yaml:"network"`

	// OperationsCenter represents the seed configuration for operations center (operations-center.yaml) to be included in the pre-seeded image.
	OperationsCenter SeedOperationsCenter `json:"operations_center" yaml:"operations_center"`

	// Update represents the seed configuration for updates (update.yaml) to be included in the pre-seeded image.
	Update SeedUpdate `json:"update" yaml:"update"`
}

type TokenSeedPost struct {
	// Name contains the name of the token seed configuration.
	// Example: MyConfig
	Name string `json:"name" yaml:"name"`

	TokenSeedPut `yaml:",inline"`
}

type TokenSeedPut struct {
	// Description contains the description of the token seed configuration.
	// Example: Configuration for lab servers.
	Description string `json:"description" yaml:"description"`

	// Public defines, if images generated based on the given token seed
	// configuration can be retrieved without authentication. If public is set to
	// `true`, no authentication is necessary, otherwise authentication is
	// required.
	// Example: true
	Public bool `json:"public" yaml:"public"`

	// Seeds represents the seed configuration for e.g. application.yaml,
	// install.yaml and network.yaml.
	Seeds TokenSeedConfigs `json:"seeds" yaml:"seeds"`
}

type Update struct {
	UpdatePut `yaml:",inline"`

	// UUID of the update.
	UUID uuid.UUID `json:"uuid" yaml:"uuid"`

	// Version of the Update as opaque string.
	// Example: 202501311418
	Version string `json:"version" yaml:"version"`

	// PublishedAt is the date, when the Update has been published in RFC3339 format.
	// Example: 2025-02-12T09:59:00Z
	PublishedAt time.Time `json:"published_at" yaml:"published_at"`

	// Severity of the Update. Allowed values: none, low, medium, high, critical
	// Example: none
	Severity images.UpdateSeverity `json:"severity" yaml:"severity"`

	// Origin of the Update.
	// Example: linuxcontainers.org
	Origin string `json:"origin" yaml:"origin"`

	// // URL of the File.
	// // Example: releases/download/202501311418/
	URL string `json:"url" yaml:"url"`

	// UpstreamChannels holds the name of the channels from upstream (source)
	// the update is part of.
	// Example: stable
	UpstreamChannels []string `json:"upstream_channels" yaml:"upstream_channels"`

	// Status contains the status the update is currently in.
	// Possible values for status are: pending, ready
	// Example: ready
	Status UpdateStatus `json:"update_status" yaml:"update_status"`
}

type UpdateChangelog = images.Changelog

type UpdateChangelogs []UpdateChangelog

type UpdateFile struct {
	// Filename of the File.
	// Example: IncusOS_202501311418.efi.gz
	Filename string `json:"filename" yaml:"filename"`

	// Size of the File in bytes.
	// Example: 54300000
	Size int `json:"size" yaml:"size"`

	// Sha256 checksum of the file in hex encoding (64 ascii characters in the alphabet [0-9A-Fa-f])
	// Example: 11465a836ce54a8f293ac9234aa51050094cfbb8906c1a10ab9487dd92088643
	Sha256 string `json:"sha256"`

	// Component the file provides. One of: os, incus, debug
	// Example: os
	Component images.UpdateFileComponent `json:"component" yaml:"component"`

	// Type of the file. One of: image-raw, image-iso, image-manifest, update-efi, update-usr, update-usr-verity, update-usr-verity-signature
	// Example: image-raw
	Type images.UpdateFileType `json:"type" yaml:"type"`

	// Architecture of the file. E.g. x86_64, aarch64
	// Example: x86_64
	Architecture images.UpdateFileArchitecture `json:"architecture" yaml:"architecture"`
}

type UpdatePut struct {
	// Channels holds the name of the channels the update is assigned to.
	// Example: stable
	Channels []string `json:"channels" yaml:"channels"`
}

type UpdateStatus string