Skip to content

sw2m/pyincusd

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
.github/workflows
.github/workflows
 
 
docs
docs
 
 
patches
patches
 
 
src/pyincusd
src/pyincusd
 
 
.gitignore
.gitignore
 
 
ADDENDUM.md
ADDENDUM.md
 
 
README.md
README.md
 
 
local.py
local.py
 
 

Repository files navigation

pyincusd

This is the REST API used by all Incus clients. Internal endpoints aren't included in this documentation.

The Incus API is available over both a local unix+http and remote https API. Authentication for local users relies on group membership and access to the unix socket. For remote users, the default authentication method is TLS client certificates.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 7.0.0
  • Generator version: 7.23.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/lxc/incus

Requirements.

Python 3.10+

Installation & Usage

pip install

pip install pyincusd

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pyincusd

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pyincusd
from pyincusd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = pyincusd.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with pyincusd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pyincusd.CertificatesApi(api_client)
    fingerprint = 'fingerprint_example' # str | Fingerprint

    try:
        # Delete the trusted certificate
        api_response = await api_instance.certificate_delete(fingerprint)
        print("The response of CertificatesApi->certificate_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CertificatesApi->certificate_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to the incusd API (unix socket or https). See Incus REST API docs.

Class Method HTTP request Description
CertificatesApi certificate_delete DELETE /1.0/certificates/{fingerprint} Delete the trusted certificate
CertificatesApi certificate_get GET /1.0/certificates/{fingerprint} Get the trusted certificate
CertificatesApi certificate_patch PATCH /1.0/certificates/{fingerprint} Partially update the trusted certificate
CertificatesApi certificate_put PUT /1.0/certificates/{fingerprint} Update the trusted certificate
CertificatesApi certificates_get GET /1.0/certificates Get the trusted certificates
CertificatesApi certificates_get_recursion1 GET /1.0/certificates?recursion=1 Get the trusted certificates
CertificatesApi certificates_post POST /1.0/certificates Add a trusted certificate
CertificatesApi certificates_post_untrusted POST /1.0/certificates?public Add a trusted certificate
ClusterApi cluster_get GET /1.0/cluster Get the cluster configuration
ClusterApi cluster_groups_post POST /1.0/cluster/groups Create a cluster group.
ClusterApi cluster_member_delete DELETE /1.0/cluster/members/{name} Delete the cluster member
ClusterApi cluster_member_get GET /1.0/cluster/members/{name} Get the cluster member
ClusterApi cluster_member_patch PATCH /1.0/cluster/members/{name} Partially update the cluster member
ClusterApi cluster_member_post POST /1.0/cluster/members/{name} Rename the cluster member
ClusterApi cluster_member_put PUT /1.0/cluster/members/{name} Update the cluster member
ClusterApi cluster_member_state_get GET /1.0/cluster/members/{name}/state Get state of the cluster member
ClusterApi cluster_member_state_post POST /1.0/cluster/members/{name}/state Evacuate or restore a cluster member
ClusterApi cluster_members_get GET /1.0/cluster/members Get the cluster members
ClusterApi cluster_members_get_recursion1 GET /1.0/cluster/members?recursion=1 Get the cluster members
ClusterApi cluster_members_post POST /1.0/cluster/members Request a join token
ClusterApi cluster_put PUT /1.0/cluster Update the cluster configuration
ClusterApi clustering_update_cert PUT /1.0/cluster/certificate Update the certificate for the cluster
ClusterGroupsApi cluster_group_delete DELETE /1.0/cluster/groups/{name} Delete the cluster group.
ClusterGroupsApi cluster_group_get GET /1.0/cluster/groups/{name} Get the cluster group
ClusterGroupsApi cluster_group_patch PATCH /1.0/cluster/groups/{name} Update the cluster group
ClusterGroupsApi cluster_group_post POST /1.0/cluster/groups/{name} Rename the cluster group
ClusterGroupsApi cluster_group_put PUT /1.0/cluster/groups/{name} Update the cluster group
ClusterGroupsApi cluster_groups_get GET /1.0/cluster/groups Get the cluster groups
ClusterGroupsApi cluster_groups_get_recursion1 GET /1.0/cluster/groups?recursion=1 Get the cluster groups
DefaultApi metadata_configuration_get GET /1.0/metadata/configuration Get the metadata configuration
ImagesApi image_alias_delete DELETE /1.0/images/aliases/{name} Delete the image alias
ImagesApi image_alias_get GET /1.0/images/aliases/{name} Get the image alias
ImagesApi image_alias_get_untrusted GET /1.0/images/aliases/{name}?public Get the public image alias
ImagesApi image_delete DELETE /1.0/images/{fingerprint} Delete the image
ImagesApi image_export_get GET /1.0/images/{fingerprint}/export Get the raw image file(s)
ImagesApi image_export_get_untrusted GET /1.0/images/{fingerprint}/export?public Get the raw image file(s)
ImagesApi image_get GET /1.0/images/{fingerprint} Get the image
ImagesApi image_get_untrusted GET /1.0/images/{fingerprint}?public Get the public image
ImagesApi image_patch PATCH /1.0/images/{fingerprint} Partially update the image
ImagesApi image_put PUT /1.0/images/{fingerprint} Update the image
ImagesApi images_alias_patch PATCH /1.0/images/aliases/{name} Partially update the image alias
ImagesApi images_alias_post POST /1.0/images/aliases/{name} Rename the image alias
ImagesApi images_aliases_get GET /1.0/images/aliases Get the image aliases
ImagesApi images_aliases_get_recursion1 GET /1.0/images/aliases?recursion=1 Get the image aliases
ImagesApi images_aliases_post POST /1.0/images/aliases Add an image alias
ImagesApi images_aliases_put PUT /1.0/images/aliases/{name} Update the image alias
ImagesApi images_export_post POST /1.0/images/{fingerprint}/export Make the server push the image to a remote server
ImagesApi images_get GET /1.0/images Get the images
ImagesApi images_get_recursion1 GET /1.0/images?recursion=1 Get the images
ImagesApi images_get_recursion1_untrusted GET /1.0/images?public&recursion=1 Get the public images
ImagesApi images_get_untrusted GET /1.0/images?public Get the public images
ImagesApi images_post POST /1.0/images Add an image
ImagesApi images_post_untrusted POST /1.0/images?public Add an image
ImagesApi images_refresh_post POST /1.0/images/{fingerprint}/refresh Refresh an image
ImagesApi images_secret_post POST /1.0/images/{fingerprint}/secret Generate secret for retrieval of the image by an untrusted client
InstancesApi instance_access GET /1.0/instances/{name}/access Get who has access to an instance
InstancesApi instance_backup_delete DELETE /1.0/instances/{name}/backups/{backup} Delete a backup
InstancesApi instance_backup_export GET /1.0/instances/{name}/backups/{backup}/export Get the raw backup file(s)
InstancesApi instance_backup_get GET /1.0/instances/{name}/backups/{backup} Get the backup
InstancesApi instance_backup_post POST /1.0/instances/{name}/backups/{backup} Rename a backup
InstancesApi instance_backups_get GET /1.0/instances/{name}/backups Get the backups
InstancesApi instance_backups_get_recursion1 GET /1.0/instances/{name}/backups?recursion=1 Get the backups
InstancesApi instance_backups_post POST /1.0/instances/{name}/backups Create a backup
InstancesApi instance_bitmaps_post POST /1.0/instances/{name}/bitmaps Create a bitmap
InstancesApi instance_console_delete DELETE /1.0/instances/{name}/console Clear the console log
InstancesApi instance_console_get GET /1.0/instances/{name}/console Get console output
InstancesApi instance_console_post POST /1.0/instances/{name}/console Connect to console
InstancesApi instance_debug_memory_get GET /1.0/instances/{name}/debug/memory Get memory debug information of an instance
InstancesApi instance_debug_repair_post GET /1.0/instances/{name}/debug/repair Trigger a repair action on the instance.
InstancesApi instance_delete DELETE /1.0/instances/{name} Delete an instance
InstancesApi instance_exec_output_delete DELETE /1.0/instances/{name}/logs/exec-output/{filename} Delete the exec record-output file
InstancesApi instance_exec_output_get GET /1.0/instances/{name}/logs/exec-output/{filename} Get the exec-output log file
InstancesApi instance_exec_outputs_get GET /1.0/instances/{name}/logs/exec-output Get the exec record-output files
InstancesApi instance_exec_post POST /1.0/instances/{name}/exec Run a command
InstancesApi instance_files_delete DELETE /1.0/instances/{name}/files Delete a file
InstancesApi instance_files_get GET /1.0/instances/{name}/files Get a file
InstancesApi instance_files_head HEAD /1.0/instances/{name}/files Get metadata for a file
InstancesApi instance_files_post POST /1.0/instances/{name}/files Create or replace a file
InstancesApi instance_get GET /1.0/instances/{name} Get the instance
InstancesApi instance_get_recursion1 GET /1.0/instances/{name}?recursion=1 Get the instance
InstancesApi instance_log_delete DELETE /1.0/instances/{name}/logs/{filename} Delete the log file
InstancesApi instance_log_get GET /1.0/instances/{name}/logs/{filename} Get the log file
InstancesApi instance_logs_get GET /1.0/instances/{name}/logs Get the log files
InstancesApi instance_metadata_get GET /1.0/instances/{name}/metadata Get the instance image metadata
InstancesApi instance_metadata_patch PATCH /1.0/instances/{name}/metadata Partially update the image metadata
InstancesApi instance_metadata_put PUT /1.0/instances/{name}/metadata Update the image metadata
InstancesApi instance_metadata_templates_delete DELETE /1.0/instances/{name}/metadata/templates Delete a template file
InstancesApi instance_metadata_templates_get GET /1.0/instances/{name}/metadata/templates Get the template file names or a specific
InstancesApi instance_metadata_templates_post POST /1.0/instances/{name}/metadata/templates Create or replace a template file
InstancesApi instance_patch PATCH /1.0/instances/{name} Partially update the instance
InstancesApi instance_post POST /1.0/instances/{name} Rename or move/migrate an instance
InstancesApi instance_put PUT /1.0/instances/{name} Update the instance
InstancesApi instance_rebuild_post POST /1.0/instances/{name}/rebuild Rebuild an instance
InstancesApi instance_sftp GET /1.0/instances/{name}/sftp Get the instance SFTP connection
InstancesApi instance_snapshot_delete DELETE /1.0/instances/{name}/snapshots/{snapshot} Delete a snapshot
InstancesApi instance_snapshot_get GET /1.0/instances/{name}/snapshots/{snapshot} Get the snapshot
InstancesApi instance_snapshot_patch PATCH /1.0/instances/{name}/snapshots/{snapshot} Partially update snapshot
InstancesApi instance_snapshot_post POST /1.0/instances/{name}/snapshots/{snapshot} Rename or move/migrate a snapshot
InstancesApi instance_snapshot_put PUT /1.0/instances/{name}/snapshots/{snapshot} Update snapshot
InstancesApi instance_snapshots_get GET /1.0/instances/{name}/snapshots Get the snapshots
InstancesApi instance_snapshots_get_recursion1 GET /1.0/instances/{name}/snapshots?recursion=1 Get the snapshots
InstancesApi instance_snapshots_post POST /1.0/instances/{name}/snapshots Create a snapshot
InstancesApi instance_state_get GET /1.0/instances/{name}/state Get the runtime state
InstancesApi instance_state_put PUT /1.0/instances/{name}/state Change the state
InstancesApi instances_get GET /1.0/instances Get the instances
InstancesApi instances_get_recursion1 GET /1.0/instances?recursion=1 Get the instances
InstancesApi instances_get_recursion2 GET /1.0/instances?recursion=2 Get the instances
InstancesApi instances_post POST /1.0/instances Create a new instance
InstancesApi instances_put PUT /1.0/instances Bulk instance state update
MetricsApi metrics_get GET /1.0/metrics Get metrics
NetworkAclsApi network_acl_delete DELETE /1.0/network-acls/{name} Delete the network ACL
NetworkAclsApi network_acl_get GET /1.0/network-acls/{name} Get the network ACL
NetworkAclsApi network_acl_log_get GET /1.0/network-acls/{name}/log Get the network ACL log
NetworkAclsApi network_acl_patch PATCH /1.0/network-acls/{name} Partially update the network ACL
NetworkAclsApi network_acl_post POST /1.0/network-acls/{name} Rename the network ACL
NetworkAclsApi network_acl_put PUT /1.0/network-acls/{name} Update the network ACL
NetworkAclsApi network_acls_get GET /1.0/network-acls Get the network ACLs
NetworkAclsApi network_acls_get_recursion1 GET /1.0/network-acls?recursion=1 Get the network ACLs
NetworkAclsApi network_acls_post POST /1.0/network-acls Add a network ACL
NetworkAddressSetsApi network_address_set_delete DELETE /1.0/network-address-sets/{name} Delete the network address set
NetworkAddressSetsApi network_address_set_get GET /1.0/network-address-sets/{name} Get the network address set
NetworkAddressSetsApi network_address_set_patch PATCH /1.0/network-address-sets/{name} Partially update the network address set
NetworkAddressSetsApi network_address_set_post POST /1.0/network-address-sets/{name} Rename the network address set
NetworkAddressSetsApi network_address_set_put PUT /1.0/network-address-sets/{name} Update the network address set
NetworkAddressSetsApi network_address_sets_get GET /1.0/network-address-sets Get the network address sets
NetworkAddressSetsApi network_address_sets_get_recursion1 GET /1.0/network-address-sets?recursion=1 Get the network address sets
NetworkAddressSetsApi network_address_sets_post POST /1.0/network-address-sets Add a network address set
NetworkAllocationsApi network_allocations_get GET /1.0/network-allocations Get the network allocations in use (`network`, `network-forward` and `load-balancer` and `instance`)
NetworkForwardsApi network_forward_delete DELETE /1.0/networks/{networkName}/forwards/{listenAddress} Delete the network address forward
NetworkForwardsApi network_forward_get GET /1.0/networks/{networkName}/forwards/{listenAddress} Get the network address forward
NetworkForwardsApi network_forward_get_recursion1 GET /1.0/networks/{networkName}/forwards?recursion=1 Get the network address forwards
NetworkForwardsApi network_forward_patch PATCH /1.0/networks/{networkName}/forwards/{listenAddress} Partially update the network address forward
NetworkForwardsApi network_forward_put PUT /1.0/networks/{networkName}/forwards/{listenAddress} Update the network address forward
NetworkForwardsApi network_forwards_get GET /1.0/networks/{networkName}/forwards Get the network address forwards
NetworkForwardsApi network_forwards_post POST /1.0/networks/{networkName}/forwards Add a network address forward
NetworkIntegrationsApi network_integration_delete DELETE /1.0/network-integrations/{integration} Delete the network integration
NetworkIntegrationsApi network_integration_get GET /1.0/network-integrations/{integration} Get the network integration
NetworkIntegrationsApi network_integration_patch PATCH /1.0/network-integrations/{integration} Partially update the network integration
NetworkIntegrationsApi network_integration_post POST /1.0/network-integrations/{integration} Rename the network integration
NetworkIntegrationsApi network_integration_put PUT /1.0/network-integrations/{integration} Update the network integration
NetworkIntegrationsApi network_integrations_get GET /1.0/network-integrations Get the network integrations
NetworkIntegrationsApi network_integrations_get_recursion1 GET /1.0/network-integrations?recursion=1 Get the network integrations
NetworkIntegrationsApi network_integrations_post POST /1.0/network-integrations Add a network integration
NetworkLoadBalancersApi network_load_balancer_delete DELETE /1.0/networks/{networkName}/load-balancers/{listenAddress} Delete the network address load balancer
NetworkLoadBalancersApi network_load_balancer_get GET /1.0/networks/{networkName}/load-balancers/{listenAddress} Get the network address load balancer
NetworkLoadBalancersApi network_load_balancer_get_recursion1 GET /1.0/networks/{networkName}/load-balancers?recursion=1 Get the network address load balancers
NetworkLoadBalancersApi network_load_balancer_patch PATCH /1.0/networks/{networkName}/load-balancers/{listenAddress} Partially update the network address load balancer
NetworkLoadBalancersApi network_load_balancer_put PUT /1.0/networks/{networkName}/load-balancers/{listenAddress} Update the network address load balancer
NetworkLoadBalancersApi network_load_balancer_state_get GET /1.0/networks/{networkName}/load-balancers/{listenAddress}/state Get the network address load balancer state
NetworkLoadBalancersApi network_load_balancers_get GET /1.0/networks/{networkName}/load-balancers Get the network address of load balancers
NetworkLoadBalancersApi network_load_balancers_post POST /1.0/networks/{networkName}/load-balancers Add a network load balancer
NetworkPeersApi network_peer_delete DELETE /1.0/networks/{networkName}/peers/{peerName} Delete the network peer
NetworkPeersApi network_peer_get GET /1.0/networks/{networkName}/peers/{peerName} Get the network peer
NetworkPeersApi network_peer_get_recursion1 GET /1.0/networks/{networkName}/peers?recursion=1 Get the network peers
NetworkPeersApi network_peer_patch PATCH /1.0/networks/{networkName}/peers/{peerName} Partially update the network peer
NetworkPeersApi network_peer_put PUT /1.0/networks/{networkName}/peers/{peerName} Update the network peer
NetworkPeersApi network_peers_get GET /1.0/networks/{networkName}/peers Get the network peers
NetworkPeersApi network_peers_post POST /1.0/networks/{networkName}/peers Add a network peer
NetworkZonesApi network_zone_delete DELETE /1.0/network-zones/{zone} Delete the network zone
NetworkZonesApi network_zone_get GET /1.0/network-zones/{zone} Get the network zone
NetworkZonesApi network_zone_patch PATCH /1.0/network-zones/{zone} Partially update the network zone
NetworkZonesApi network_zone_put PUT /1.0/network-zones/{zone} Update the network zone
NetworkZonesApi network_zone_record_delete DELETE /1.0/network-zones/{zone}/records/{name} Delete the network zone record
NetworkZonesApi network_zone_record_get GET /1.0/network-zones/{zone}/records/{name} Get the network zone record
NetworkZonesApi network_zone_record_patch PATCH /1.0/network-zones/{zone}/records/{name} Partially update the network zone record
NetworkZonesApi network_zone_record_put PUT /1.0/network-zones/{zone}/records/{name} Update the network zone record
NetworkZonesApi network_zone_records_get GET /1.0/network-zones/{zone}/records Get the network zone records
NetworkZonesApi network_zone_records_get_recursion1 GET /1.0/network-zones/{zone}/records?recursion=1 Get the network zone records
NetworkZonesApi network_zone_records_post POST /1.0/network-zones/{zone}/records Add a network zone record
NetworkZonesApi network_zones_get GET /1.0/network-zones Get the network zones
NetworkZonesApi network_zones_get_recursion1 GET /1.0/network-zones?recursion=1 Get the network zones
NetworkZonesApi network_zones_post POST /1.0/network-zones Add a network zone
NetworksApi network_delete DELETE /1.0/networks/{name} Delete the network
NetworksApi network_get GET /1.0/networks/{name} Get the network
NetworksApi network_patch PATCH /1.0/networks/{name} Partially update the network
NetworksApi network_post POST /1.0/networks/{name} Rename the network
NetworksApi network_put PUT /1.0/networks/{name} Update the network
NetworksApi networks_get GET /1.0/networks Get the networks
NetworksApi networks_get_recursion1 GET /1.0/networks?recursion=1 Get the networks
NetworksApi networks_leases_get GET /1.0/networks/{name}/leases Get the DHCP leases
NetworksApi networks_post POST /1.0/networks Add a network
NetworksApi networks_state_get GET /1.0/networks/{name}/state Get the network state
OperationsApi operation_delete DELETE /1.0/operations/{id} Cancel the operation
OperationsApi operation_get GET /1.0/operations/{id} Get the operation state
OperationsApi operation_wait_get GET /1.0/operations/{id}/wait Wait for the operation
OperationsApi operation_wait_get_untrusted GET /1.0/operations/{id}/wait?public Wait for the operation
OperationsApi operation_websocket_get GET /1.0/operations/{id}/websocket Get the websocket stream
OperationsApi operation_websocket_get_untrusted GET /1.0/operations/{id}/websocket?public Get the websocket stream
OperationsApi operations_get GET /1.0/operations Get the operations
OperationsApi operations_get_recursion1 GET /1.0/operations?recursion=1 Get the operations
ProfilesApi profile_delete DELETE /1.0/profiles/{name} Delete the profile
ProfilesApi profile_get GET /1.0/profiles/{name} Get the profile
ProfilesApi profile_patch PATCH /1.0/profiles/{name} Partially update the profile
ProfilesApi profile_post POST /1.0/profiles/{name} Rename the profile
ProfilesApi profile_put PUT /1.0/profiles/{name} Update the profile
ProfilesApi profiles_get GET /1.0/profiles Get the profiles
ProfilesApi profiles_get_recursion1 GET /1.0/profiles?recursion=1 Get the profiles
ProfilesApi profiles_post POST /1.0/profiles Add a profile
ProjectsApi project_access GET /1.0/projects/{name}/access Get who has access to a project
ProjectsApi project_delete DELETE /1.0/projects/{name} Delete the project
ProjectsApi project_get GET /1.0/projects/{name} Get the project
ProjectsApi project_patch PATCH /1.0/projects/{name} Partially update the project
ProjectsApi project_post POST /1.0/projects/{name} Rename the project
ProjectsApi project_put PUT /1.0/projects/{name} Update the project
ProjectsApi project_state_get GET /1.0/projects/{name}/state Get the project state
ProjectsApi projects_get GET /1.0/projects Get the projects
ProjectsApi projects_get_recursion1 GET /1.0/projects?recursion=1 Get the projects
ProjectsApi projects_post POST /1.0/projects Add a project
ServerApi api_get GET / Get the supported API endpoints
ServerApi events_get GET /1.0/events Get the event stream
ServerApi resources_get GET /1.0/resources Get system resources information
ServerApi server_get GET /1.0 Get the server environment and configuration
ServerApi server_get_untrusted GET /1.0?public Get the server environment
ServerApi server_patch PATCH /1.0 Partially update the server configuration
ServerApi server_put PUT /1.0 Update the server configuration
StorageApi storage_pool_bucket_delete DELETE /1.0/storage-pools/{name}/buckets/{bucketName} Delete the storage bucket
StorageApi storage_pool_bucket_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName} Get the storage pool bucket
StorageApi storage_pool_bucket_get_recursion1 GET /1.0/storage-pools/{poolName}/buckets/{bucketName}?recursion=1 Get the full storage pool bucket details
StorageApi storage_pool_bucket_key_delete DELETE /1.0/storage-pools/{name}/buckets/{bucketName}/keys/{keyName} Delete the storage bucket key
StorageApi storage_pool_bucket_key_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/keys/{keyName} Get the storage pool bucket key
StorageApi storage_pool_bucket_key_post POST /1.0/storage-pools/{poolName}/buckets/{bucketName}/keys Add a storage pool bucket key.
StorageApi storage_pool_bucket_key_put PUT /1.0/storage-pools/{name}/buckets/{bucketName}/keys/{keyName} Update the storage bucket key
StorageApi storage_pool_bucket_keys_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/keys Get the storage pool bucket keys
StorageApi storage_pool_bucket_keys_get_recursion1 GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/keys?recursion=1 Get the storage pool bucket keys
StorageApi storage_pool_bucket_patch PATCH /1.0/storage-pools/{name}/buckets/{bucketName} Partially update the storage bucket.
StorageApi storage_pool_bucket_post POST /1.0/storage-pools/{poolName}/buckets Add a storage pool bucket.
StorageApi storage_pool_bucket_put PUT /1.0/storage-pools/{name}/buckets/{bucketName} Update the storage bucket
StorageApi storage_pool_buckets_backup_delete DELETE /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups/{backupName} Delete a storage bucket backup
StorageApi storage_pool_buckets_backup_export_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups/{backupName}/export Get the raw backup file
StorageApi storage_pool_buckets_backup_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups/{backupName} Get the storage bucket backup
StorageApi storage_pool_buckets_backup_post POST /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups/{backupName} Rename a storage bucket backup
StorageApi storage_pool_buckets_backups_get GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups Get the storage bucket backups
StorageApi storage_pool_buckets_backups_get_recursion1 GET /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups?recursion=1 Get the storage bucket backups
StorageApi storage_pool_buckets_backups_post POST /1.0/storage-pools/{poolName}/buckets/{bucketName}/backups Create a storage bucket backup
StorageApi storage_pool_buckets_get GET /1.0/storage-pools/{poolName}/buckets Get the storage pool buckets
StorageApi storage_pool_buckets_get_recursion1 GET /1.0/storage-pools/{poolName}/buckets?recursion=1 Get the storage pool buckets
StorageApi storage_pool_buckets_get_recursion2 GET /1.0/storage-pools/{poolName}/buckets?recursion=2 Get the storage pool bucket details
StorageApi storage_pool_get GET /1.0/storage-pools/{poolName} Get the storage pool
StorageApi storage_pool_patch PATCH /1.0/storage-pools/{poolName} Partially update the storage pool
StorageApi storage_pool_put PUT /1.0/storage-pools/{poolName} Update the storage pool
StorageApi storage_pool_resources GET /1.0/storage-pools/{name}/resources Get storage pool resources information
StorageApi storage_pool_volume_type_bitmap_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/bitmaps/{bitmapName} Get the storage volume dirty bitmap
StorageApi storage_pool_volume_type_bitmaps_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/bitmaps Get the storage volume dirty bitmaps
StorageApi storage_pool_volume_type_bitmaps_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/bitmaps?recursion=1 Get the storage volume dirty bitmaps
StorageApi storage_pool_volume_type_delete DELETE /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName} Delete the storage volume
StorageApi storage_pool_volume_type_files_delete DELETE /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/files Delete a file
StorageApi storage_pool_volume_type_files_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/files Get a file
StorageApi storage_pool_volume_type_files_head HEAD /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/files Get metadata for a file
StorageApi storage_pool_volume_type_files_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/files Create or replace a file
StorageApi storage_pool_volume_type_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName} Get the storage volume
StorageApi storage_pool_volume_type_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}?recursion=1 Get the full storage volume details
StorageApi storage_pool_volume_type_nbd_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/nbd Get the storage volume NBD connection
StorageApi storage_pool_volume_type_patch PATCH /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName} Partially update the storage volume
StorageApi storage_pool_volume_type_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName} Rename or move/migrate a storage volume
StorageApi storage_pool_volume_type_put PUT /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName} Update the storage volume
StorageApi storage_pool_volume_type_sftp_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/sftp Get the storage volume SFTP connection
StorageApi storage_pool_volume_type_state_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/state Get the storage volume state
StorageApi storage_pool_volumes_get GET /1.0/storage-pools/{poolName}/volumes Get the storage volumes
StorageApi storage_pool_volumes_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes?recursion=1 Get the storage volumes
StorageApi storage_pool_volumes_post POST /1.0/storage-pools/{poolName}/volumes Add a storage volume
StorageApi storage_pool_volumes_type_backup_delete DELETE /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName} Delete a storage volume backup
StorageApi storage_pool_volumes_type_backup_export_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName}/export Get the raw backup file
StorageApi storage_pool_volumes_type_backup_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName} Get the storage volume backup
StorageApi storage_pool_volumes_type_backup_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups/{backupName} Rename a storage volume backup
StorageApi storage_pool_volumes_type_backups_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups Get the storage volume backups
StorageApi storage_pool_volumes_type_backups_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups?recursion=1 Get the storage volume backups
StorageApi storage_pool_volumes_type_backups_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/backups Create a storage volume backup
StorageApi storage_pool_volumes_type_bitmap_delete DELETE /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/bitmaps/{bitmapName} Delete a storage volume bitmap
StorageApi storage_pool_volumes_type_bitmaps_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/bitmaps Create a storage volume bitmap
StorageApi storage_pool_volumes_type_get GET /1.0/storage-pools/{poolName}/volumes/{type} Get the storage volumes
StorageApi storage_pool_volumes_type_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes/{type}?recursion=1 Get the storage volumes
StorageApi storage_pool_volumes_type_get_recursion2 GET /1.0/storage-pools/{poolName}/volumes/{type}?recursion=2 Get the storage volumes with all details
StorageApi storage_pool_volumes_type_post POST /1.0/storage-pools/{poolName}/volumes/{type} Add a storage volume
StorageApi storage_pool_volumes_type_snapshot_delete DELETE /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName} Delete a storage volume snapshot
StorageApi storage_pool_volumes_type_snapshot_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName} Get the storage volume snapshot
StorageApi storage_pool_volumes_type_snapshot_patch PATCH /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName} Partially update the storage volume snapshot
StorageApi storage_pool_volumes_type_snapshot_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName} Rename a storage volume snapshot
StorageApi storage_pool_volumes_type_snapshot_put PUT /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots/{snapshotName} Update the storage volume snapshot
StorageApi storage_pool_volumes_type_snapshots_get GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots Get the storage volume snapshots
StorageApi storage_pool_volumes_type_snapshots_get_recursion1 GET /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots?recursion=1 Get the storage volume snapshots
StorageApi storage_pool_volumes_type_snapshots_post POST /1.0/storage-pools/{poolName}/volumes/{type}/{volumeName}/snapshots Create a storage volume snapshot
StorageApi storage_pools_delete DELETE /1.0/storage-pools/{poolName} Delete the storage pool
StorageApi storage_pools_get GET /1.0/storage-pools Get the storage pools
StorageApi storage_pools_get_recursion1 GET /1.0/storage-pools?recursion=1 Get the storage pools
StorageApi storage_pools_post POST /1.0/storage-pools Add a storage pool
WarningsApi warning_delete DELETE /1.0/warnings/{uuid} Delete the warning
WarningsApi warning_get GET /1.0/warnings/{uuid} Get the warning
WarningsApi warning_patch PATCH /1.0/warnings/{uuid} Partially update the warning
WarningsApi warning_put PUT /1.0/warnings/{uuid} Update the warning
WarningsApi warnings_get GET /1.0/warnings List the warnings
WarningsApi warnings_get_recursion1 GET /1.0/warnings?recursion=1 Get the warnings

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

API originally authored by LXC, Python client auto-generated by anonhostpi

Local Unix Socket Client

Connect to incusd without manual configuration:

from pyincusd.local import Client
from pyincusd.api import instances_api

c = Client()
result = c.run(instances_api.InstancesApi(c).instances_get())
print(result.metadata)

Client extends ApiClient with the Unix socket transport preconfigured. Client.run() wraps async API calls for synchronous use. Supports with blocks.

Custom socket path: Client(socket_path="/custom/path.socket")

Patches

Opt-in fixes for gaps in the auto-generated code. See patches/README.md for details.

Apply all patches:

from pyincusd.patches import apply_all
apply_all()

Apply individually:

from pyincusd.patches import metadata_config
metadata_config.apply()
metadata_config.revert()  # undo

New patches are auto-discovered — drop a .py with apply()/revert() in patches/ and apply_all() picks it up.

High-Level Client

For an OOP abstraction layer built on pyincusd, see incusd-client — provides classes like Instance, StoragePool, Network, Cluster with full coverage of the Incus REST API.

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 23

pyincusd 7.0.0 Latest
May 2, 2026
+ 22 releases

Packages

 
 
 

Contributors

Languages