GetParentAndSnapshotName returns the parent name, snapshot name, and whether it actually was a snapshot name.

NewURL creates a new URL.

ParseFileHeaders extracts the file ownership, type, mode and operation type from HTTP headers.

StatusCodeFromString returns the status code of the giving status name.

StatusErrorCheck returns whether or not err was caused by a StatusError and if it matches one of the optional status codes.

StatusErrorf returns a new StatusError containing the specified status and message.

StatusErrorMatch checks if err was caused by StatusError.

Status codes.

Response types.

AuthenticationMethodOIDC is a token based authentication method.

AuthenticationMethodTLS is the default authentication method for interacting with Incus remotely.

Status codes.

Status codes.

CertificateTypeClient indicates a client certificate type.

CertificateTypeMetrics indicates a metrics certificate type.

CertificateTypeServer indicates a server certificate type.

CertificateTypeUnknown indicates an unknown certificate type.

Status codes.

Response types.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Define consts for all the lifecycle events.

Event types.

Event types.

Event types.

Event types.

Status codes.

Status codes.

Status codes.

InstanceTypeAny defines the instance type value for requesting any instance type.

InstanceTypeContainer defines the instance type value for a container.

InstanceTypeVM defines the instance type value for a virtual-machine.

NetworkStatusCreated network is fully created.

NetworkStatusErrored network is in error status.

NetworkStatusPending network is pending creation on other cluster nodes.

NetworkStatusUnavailable network failed to initialize.

NetworkStatusUnknown network is in unknown status.

OperationClassTask represents the Task OperationClass.

OperationClassToken represents the Token OperationClass.

OperationClassWebsocket represents the Websocket OperationClass.

Status codes.

Status codes.

ProjectDefaultName is the name of the default project that can never be deleted.

Status codes.

Status codes.

SecretNameControl is the secret name used for the migration control connection.

SecretNameFilesystem is the secret name used for the migration filesystem connection.

Legacy value used for backward compatibility for clients.

Status codes.

Status codes.

Status codes.

Status codes.

StoragePoolStatusCreated storage pool is fully created.

StoragePoolStatusErrored storage pool is in error status.

StoragePoolStatusPending storage pool is pending creation on other cluster nodes.

StoragePoolStatusUnknown storage pool is in unknown status.

StoragePoolStatusUnvailable storage pool failed to initialize.

Status codes.

Response types.

Status codes.

StatusCodeNames associates a status code to its name.

Certificate represents a certificate swagger:model.

CertificateAddToken represents the fields contained within an encoded certificate add token.

CertificatePut represents the modifiable fields of a certificate swagger:model API extension: certificate_update.

CertificatesPost represents the fields of a new certificate swagger:model.

Cluster represents high-level information about a cluster.

ClusterCertificatePut represents the certificate and key pair for all cluster members swagger:model API extension: clustering_update_certs.

ClusterGroup represents a cluster group.

ClusterGroupPost represents the fields required to rename a cluster group.

ClusterGroupPut represents the modifiable fields of a cluster group.

ClusterGroupsPost represents the fields available for a new cluster group.

ClusterMember represents a member of a cluster.

ClusterMemberConfigKey represents a single config key that a new member of the cluster is required to provide when joining.

ClusterMemberJoinToken represents the fields contained within an encoded cluster member join token.

ClusterMemberPost represents the fields required to rename a cluster member.

ClusterMemberPut represents the modifiable fields of a cluster member swagger:model API extension: clustering_edit_roles.

ClusterMembersPost represents the fields required to request a join token to add a member to the cluster.

ClusterMemberState represents the state of a cluster member.

ClusterMemberStatePost represents the fields required to evacuate a cluster member.

ClusterMemberSysInfo represents the sysinfo of a cluster member.

ClusterPut represents the fields required to bootstrap or join a cluster.

Event represents an event entry (over websocket) swagger:model.

EventLifecycle represets a lifecycle type event entry API extension: event_lifecycle.

EventLifecycleRequestor represents the initial requestor for an event API extension: event_lifecycle_requestor.

EventLogging represents a logging type event entry (admin only).

EventLogRecord represents single log record.

Image represents an image swagger:model.

ImageAlias represents an alias from the alias list of an image swagger:model.

ImageAliasesEntry represents an image alias swagger:model.

ImageAliasesEntryPost represents the required fields to rename an image alias swagger:model.

ImageAliasesEntryPut represents the modifiable fields of an image alias swagger:model.

ImageAliasesPost represents a new image alias swagger:model.

ImageExportPost represents the fields required to export an image swagger:model API extension: images_push_relay.

ImageMetadata represents image metadata (used in image tarball) swagger:model.

ImageMetadataTemplate represents a template entry in image metadata (used in image tarball) swagger:model.

ImagePut represents the modifiable fields of an image swagger:model.

ImageSource represents the source of an image swagger:model.

ImagesPost represents the fields available for a new image swagger:model.

ImagesPostSource represents the source of a new image swagger:model.

InitClusterPreseed represents initialization configuration for the cluster.

InitLocalPreseed represents initialization configuration.

InitNetworksProjectPost represents the fields of a new network along with its associated project.

InitPreseed represents initialization configuration that can be supplied to `init`.

Instance represents an instance.

InstanceBackup represents an instance backup.

InstanceBackupPost represents the fields available for the renaming of a instance backup.

InstanceBackupsPost represents the fields available for a new instance backup.

InstanceConsoleControl represents a message on the instance console "control" socket.

InstanceConsolePost represents an instance console request.

InstanceExecControl represents a message on the instance exec "control" socket.

InstanceExecPost represents an instance exec request.

InstanceFull is a combination of Instance, InstanceBackup, InstanceState and InstanceSnapshot.

InstancePost represents the fields required to rename/move an instance.

InstancePostTarget represents the migration target host and operation.

InstancePut represents the modifiable fields of an instance.

InstanceRebuildPost indicates how to rebuild an instance.

InstanceSnapshot represents an instance snapshot.

InstanceSnapshotPost represents the fields required to rename/move an instance snapshot.

InstanceSnapshotPut represents the modifiable fields of an instance snapshot.

InstanceSnapshotsPost represents the fields available for a new instance snapshot.

InstanceSource represents the creation source for a new instance.

InstancesPost represents the fields available for a new instance.

InstancesPut represents the fields available for a mass update.

InstanceState represents an instance's state.

InstanceStateCPU represents the cpu information section of an instance's state.

InstanceStateDisk represents the disk information section of an instance's state.

InstanceStateMemory represents the memory information section of an instance's state.

InstanceStateNetwork represents the network information section of an instance's state.

InstanceStateNetworkAddress represents a network address as part of the network section of an instance's state.

InstanceStateNetworkCounters represents packet counters as part of the network section of an instance's state.

InstanceStatePut represents the modifiable fields of an instance's state.

MetadataConfigGroup represents a group of config keys swagger:model API extension: metadata_configuration.

MetadataConfigKey describe a configuration key swagger:model API extension: metadata_configuration.

MetadataConfiguration represents a server's exposed configuration metadata swagger:model API extension: metadata_configuration.

Network represents a network swagger:model.

NetworkACL used for displaying an ACL.

NetworkACLPost used for renaming an ACL.

NetworkACLPut used for updating an ACL.

NetworkACLRule represents a single rule in an ACL ruleset.

NetworkACLsPost used for creating an ACL.

NetworkAllocations used for displaying network addresses used by a consuming entity e.g, instance, network forward, load-balancer, network..

NetworkForward used for displaying an network address forward.

NetworkForwardPort represents a port specification in a network address forward swagger:model API extension: network_forward.

NetworkForwardPut represents the modifiable fields of a network address forward swagger:model API extension: network_forward.

NetworkForwardsPost represents the fields of a new network address forward swagger:model API extension: network_forward.

NetworkIntegration represents a network integration.

NetworkIntegrationPost represents the fields required to rename a network integration swagger:model API extension: network_integrations.

NetworkIntegrationPut represents the modifiable fields of a network integration swagger:model API extension: network_integrations.

NetworkIntegrationsPost represents the fields of a new network integration swagger:model API extension: network_integrations.

NetworkLease represents a DHCP lease swagger:model API extension: network_leases.

NetworkLoadBalancer used for displaying a network load balancer swagger:model API extension: network_load_balancer.

NetworkLoadBalancerBackend represents a target backend specification in a network load balancer swagger:model API extension: network_load_balancer.

NetworkLoadBalancerPort represents a port specification in a network load balancer swagger:model API extension: network_load_balancer.

NetworkLoadBalancerPut represents the modifiable fields of a network load balancer swagger:model API extension: network_load_balancer.

NetworkLoadBalancersPost represents the fields of a new network load balancer swagger:model API extension: network_load_balancer.

NetworkPeer used for displaying a network peering.

NetworkPeerPut represents the modifiable fields of a network peering swagger:model API extension: network_peer.

NetworkPeersPost represents the fields of a new network peering swagger:model API extension: network_peer.

NetworkPost represents the fields required to rename a network swagger:model API extension: network.

NetworkPut represents the modifiable fields of a network swagger:model API extension: network.

NetworksPost represents the fields of a new network swagger:model API extension: network.

NetworkState represents the network state swagger:model.

NetworkStateAddress represents a network address swagger:model.

NetworkStateBond represents bond specific state swagger:model API extension: network_state_bond_bridge.

NetworkStateBridge represents bridge specific state swagger:model API extension: network_state_bond_bridge.

NetworkStateCounters represents packet counters swagger:model.

NetworkStateOVN represents OVN specific state swagger:model API extension: network_state_ovn.

NetworkStateVLAN represents VLAN specific state swagger:model API extension: network_state_vlan.

NetworkZone represents a network zone (DNS).

NetworkZonePut represents the modifiable fields of a network zone swagger:model API extension: network_dns.

NetworkZoneRecord represents a network zone (DNS) record.

NetworkZoneRecordEntry represents the fields in a record entry swagger:model API extension: network_dns_records.

NetworkZoneRecordPut represents the modifiable fields of a network zone record swagger:model API extension: network_dns_records.

NetworkZoneRecordsPost represents the fields of a new network zone record swagger:model API extension: network_dns_records.

NetworkZonesPost represents the fields of a new network zone swagger:model API extension: network_dns.

Operation represents a background operation swagger:model.

Profile represents a profile swagger:model.

ProfilePost represents the fields required to rename a profile swagger:model.

ProfilePut represents the modifiable fields of a profile swagger:model.

ProfilesPost represents the fields of a new profile swagger:model.

Project represents a project swagger:model API extension: projects.

ProjectPost represents the fields required to rename a project swagger:model API extension: projects.

ProjectPut represents the modifiable fields of a project swagger:model API extension: projects.

ProjectsPost represents the fields of a new project swagger:model API extension: projects.

ProjectState represents the current running state of a project swagger:model API extension: project_usage.

ProjectStateResource represents the state of a particular resource in a project swagger:model API extension: project_usage.

Resources represents the system hardware resources swagger:model API extension: resources.

ResourcesCPU represents the cpu resources available on the system swagger:model API extension: resources.

ResourcesCPUCache represents a CPU cache swagger:model API extension: resources_v2.

ResourcesCPUCore represents a CPU core on the system swagger:model API extension: resources_v2.

ResourcesCPUSocket represents a CPU socket on the system swagger:model API extension: resources_v2.

ResourcesCPUThread represents a CPU thread on the system swagger:model API extension: resources_v2.

ResourcesGPU represents the GPU resources available on the system swagger:model API extension: resources_gpu.

ResourcesGPUCard represents a GPU card on the system swagger:model API extension: resources_v2.

ResourcesGPUCardDRM represents the Linux DRM configuration of the GPU swagger:model API extension: resources_v2.

ResourcesGPUCardMdev represents the mediated devices configuration of the GPU swagger:model API extension: resources_gpu_mdev.

ResourcesGPUCardNvidia represents additional information for NVIDIA GPUs swagger:model API extension: resources_gpu.

ResourcesGPUCardSRIOV represents the SRIOV configuration of the GPU swagger:model API extension: resources_v2.

ResourcesMemory represents the memory resources available on the system swagger:model API extension: resources.

ResourcesMemoryNode represents the node-specific memory resources available on the system swagger:model API extension: resources_v2.

ResourcesNetwork represents the network cards available on the system swagger:model API extension: resources_v2.

ResourcesNetworkCard represents a network card on the system swagger:model API extension: resources_v2.

ResourcesNetworkCardPort represents a network port on the system swagger:model API extension: resources_v2.

ResourcesNetworkCardPortInfiniband represents the Linux Infiniband configuration for the port swagger:model API extension: resources_infiniband.

ResourcesNetworkCardSRIOV represents the SRIOV configuration of the network card swagger:model API extension: resources_v2.

ResourceNetworkCardVDPA represents the VDPA configuration of the network card swagger:model API extension: ovn_nic_acceleration_vdpa.

ResourcesPCI represents the PCI devices available on the system swagger:model API extension: resources_usb_pci.

ResourcesPCIDevice represents a PCI device swagger:model API extension: resources_usb_pci.

ResourcesPCIVPD represents VPD entries for a device swagger:model API extension: resources_pci_vpd.

ResourcesStorage represents the local storage swagger:model API extension: resources_v2.

ResourcesStorageDisk represents a disk swagger:model API extension: resources_v2.

ResourcesStorageDiskPartition represents a partition on a disk swagger:model API extension: resources_v2.

ResourcesStoragePool represents the resources available to a given storage pool swagger:model API extension: resources.

ResourcesStoragePoolInodes represents the inodes available to a given storage pool swagger:model API extension: resources.

ResourcesStoragePoolSpace represents the space available to a given storage pool swagger:model API extension: resources.

ResourcesSystem represents the system swagger:model API extension: resources_system.

ResourcesSystemChassis represents the system chassis swagger:model API extension: resources_system.

ResourcesSystemFirmware represents the system firmware swagger:model API extension: resources_system.

ResourcesSystemMotherboard represents the motherboard swagger:model API extension: resources_system.

ResourcesUSB represents the USB devices available on the system swagger:model API extension: resources_usb_pci.

ResourcesUSBDevice represents a USB device swagger:model API extension: resources_usb_pci.

ResourcesUSBDeviceInterface represents a USB device interface swagger:model API extension: resources_usb_pci.

Response represents an operation.

ResponseRaw represents an operation in its original form.

Server represents a server configuration swagger:model.

ServerEnvironment represents the read-only environment fields of a server configuration.

ServerPut represents the modifiable fields of a server configuration swagger:model.

ServerStorageDriverInfo represents the read-only info about a storage driver swagger:model API extension: server_supported_storage_drivers.

ServerUntrusted represents a server configuration for an untrusted client swagger:model.

StatusError error type that contains an HTTP status code and message.

StorageBucket represents the fields of a storage pool bucket swagger:model API extension: storage_buckets.

StorageBucketBackup represents the fields available for a new storage bucket backup swagger:model API extension: storage_bucket_backup.

StorageBucketBackupPost represents the fields available for the renaming of a bucket backup swagger:model API extension: storage_bucket_backup.

StorageBucketBackupsPost represents the fields available for a new storage bucket backup swagger:model API extension: storage_bucket_backup.

StorageBucketKey represents the fields of a storage pool bucket key swagger:model API extension: storage_buckets.

StorageBucketKeyPut represents the modifiable fields of a storage pool bucket key swagger:model API extension: storage_buckets.

StorageBucketKeysPost represents the fields of a new storage pool bucket key swagger:model API extension: storage_buckets.

StorageBucketPut represents the modifiable fields of a storage pool bucket swagger:model API extension: storage_buckets.

StorageBucketsPost represents the fields of a new storage pool bucket swagger:model API extension: storage_buckets.

StoragePool represents the fields of a storage pool.

StoragePoolPut represents the modifiable fields of a storage pool.

StoragePoolsPost represents the fields of a new storage pool swagger:model API extension: storage.

StoragePoolState represents the state of a storage pool.

StoragePoolVolumeBackup represents a volume backup swagger:model API extension: custom_volume_backup.

StoragePoolVolumeBackupPost represents the fields available for the renaming of a volume backup swagger:model API extension: custom_volume_backup.

StoragePoolVolumeBackupsPost represents the fields available for a new volume backup swagger:model API extension: custom_volume_backup.

StorageVolume represents the fields of a storage volume.

StorageVolumePost represents the fields required to rename a storage pool volume swagger:model API extension: storage_api_volume_rename.

StorageVolumePostTarget represents the migration target host and operation swagger:model API extension: storage_api_remote_volume_handling.

StorageVolumePut represents the modifiable fields of a storage volume swagger:model API extension: storage.

StorageVolumeSnapshot represents a storage volume snapshot swagger:model API extension: storage_api_volume_snapshots.

StorageVolumeSnapshotPost represents the fields required to rename/move a storage volume snapshot swagger:model API extension: storage_api_volume_snapshots.

StorageVolumeSnapshotPut represents the modifiable fields of a storage volume swagger:model API extension: storage_api_volume_snapshots.

StorageVolumeSnapshotsPost represents the fields available for a new storage volume snapshot swagger:model API extension: storage_api_volume_snapshots.

StorageVolumeSource represents the creation source for a new storage volume swagger:model API extension: storage_api_local_volume_handling.

StorageVolumesPost represents the fields of a new storage pool volume swagger:model API extension: storage.

StorageVolumeState represents the live state of the volume swagger:model API extension: storage_volume_state.

StorageVolumeStateUsage represents the disk usage of a volume swagger:model API extension: storage_volume_state.

URL represents an endpoint for the REST API.

Warning represents a warning entry.

WarningPut represents the modifiable fields of a warning.

InstanceType represents the type if instance being returned or requested via the API.

MetadataConfig repreents metadata about configuration keys swagger:model API extension: metadata_configuration.

MetadataConfigEntityName represents a main API object type Example: instance swagger:model API extension: metadata_configuration.

MetadataConfigGroupName represents the name of a group of config keys Example: volatile swagger:model API extension: metadata_configuration.

ResponseType represents a valid response type.

StatusCode represents a valid operation and container status.