Home
Incus
Incus external REST API — storage
Incus external REST API — storage
Incus external REST API — storage. 70 operations. Lead operation: Get the storage pools. Self-contained Naftiko capability covering one Incus business surface.
What You Can Do
GET
Storagepoolsget
— Get the storage pools
/v1/1-0/storage-pools
POST
Storagepoolspost
— Add a storage pool
/v1/1-0/storage-pools
DELETE
Storagepoolbucketdelete
— Delete the storage bucket
/v1/1-0/storage-pools/{name}/buckets/{bucketname}
PATCH
Storagepoolbucketpatch
— Partially update the storage bucket.
/v1/1-0/storage-pools/{name}/buckets/{bucketname}
PUT
Storagepoolbucketput
— Update the storage bucket
/v1/1-0/storage-pools/{name}/buckets/{bucketname}
DELETE
Storagepoolbucketkeydelete
— Delete the storage bucket key
/v1/1-0/storage-pools/{name}/buckets/{bucketname}/keys/{keyname}
PUT
Storagepoolbucketkeyput
— Update the storage bucket key
/v1/1-0/storage-pools/{name}/buckets/{bucketname}/keys/{keyname}
GET
Storagepoolresources
— Get storage pool resources information
/v1/1-0/storage-pools/{name}/resources
DELETE
Storagepoolsdelete
— Delete the storage pool
/v1/1-0/storage-pools/{poolname}
GET
Storagepoolget
— Get the storage pool
/v1/1-0/storage-pools/{poolname}
PATCH
Storagepoolpatch
— Partially update the storage pool
/v1/1-0/storage-pools/{poolname}
PUT
Storagepoolput
— Update the storage pool
/v1/1-0/storage-pools/{poolname}
GET
Storagepoolbucketsget
— Get the storage pool buckets
/v1/1-0/storage-pools/{poolname}/buckets
POST
Storagepoolbucketpost
— Add a storage pool bucket.
/v1/1-0/storage-pools/{poolname}/buckets
GET
Storagepoolbucketget
— Get the storage pool bucket
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}
GET
Storagepoolbucketsbackupsget
— Get the storage bucket backups
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups
POST
Storagepoolbucketsbackupspost
— Create a storage bucket backup
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups
DELETE
Storagepoolbucketsbackupdelete
— Delete a storage bucket backup
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups/{backupname}
GET
Storagepoolbucketsbackupget
— Get the storage bucket backup
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups/{backupname}
POST
Storagepoolbucketsbackuppost
— Rename a storage bucket backup
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups/{backupname}
GET
Storagepoolbucketsbackupexportget
— Get the raw backup file
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups/{backupname}/export
GET
Storagepoolbucketsbackupsgetrecursion1
— Get the storage bucket backups
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/backups-recursion-1
GET
Storagepoolbucketkeysget
— Get the storage pool bucket keys
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/keys
POST
Storagepoolbucketkeypost
— Add a storage pool bucket key.
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/keys
GET
Storagepoolbucketkeyget
— Get the storage pool bucket key
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/keys/{keyname}
GET
Storagepoolbucketkeysgetrecursion1
— Get the storage pool bucket keys
/v1/1-0/storage-pools/{poolname}/buckets/{bucketname}/keys-recursion-1
GET
Storagepoolbucketgetrecursion1
— Get the full storage pool bucket details
/v1/1-0/storage-pools/{poolname}/buckets/bucketname-recursion-1
GET
Storagepoolbucketsgetrecursion1
— Get the storage pool buckets
/v1/1-0/storage-pools/{poolname}/buckets-recursion-1
GET
Storagepoolbucketsgetrecursion2
— Get the storage pool bucket details
/v1/1-0/storage-pools/{poolname}/buckets-recursion-2
GET
Storagepoolvolumesget
— Get the storage volumes
/v1/1-0/storage-pools/{poolname}/volumes
POST
Storagepoolvolumespost
— Add a storage volume
/v1/1-0/storage-pools/{poolname}/volumes
GET
Storagepoolvolumestypeget
— Get the storage volumes
/v1/1-0/storage-pools/{poolname}/volumes/{type}
POST
Storagepoolvolumestypepost
— Add a storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}
DELETE
Storagepoolvolumetypedelete
— Delete the storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}
GET
Storagepoolvolumetypeget
— Get the storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}
PATCH
Storagepoolvolumetypepatch
— Partially update the storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}
POST
Storagepoolvolumetypepost
— Rename or move/migrate a storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}
PUT
Storagepoolvolumetypeput
— Update the storage volume
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}
GET
Storagepoolvolumestypebackupsget
— Get the storage volume backups
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups
POST
Storagepoolvolumestypebackupspost
— Create a storage volume backup
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups
DELETE
Storagepoolvolumestypebackupdelete
— Delete a storage volume backup
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups/{backupname}
GET
Storagepoolvolumestypebackupget
— Get the storage volume backup
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups/{backupname}
POST
Storagepoolvolumestypebackuppost
— Rename a storage volume backup
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups/{backupname}
GET
Storagepoolvolumestypebackupexportget
— Get the raw backup file
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups/{backupname}/export
GET
Storagepoolvolumestypebackupsgetrecursion1
— Get the storage volume backups
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/backups-recursion-1
GET
Storagepoolvolumetypebitmapsget
— Get the storage volume dirty bitmaps
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/bitmaps
POST
Storagepoolvolumestypebitmapspost
— Create a storage volume bitmap
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/bitmaps
DELETE
Storagepoolvolumestypebitmapdelete
— Delete a storage volume bitmap
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/bitmaps/{bitmapname}
GET
Storagepoolvolumetypebitmapget
— Get the storage volume dirty bitmap
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/bitmaps/{bitmapname}
GET
Storagepoolvolumetypebitmapsgetrecursion1
— Get the storage volume dirty bitmaps
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/bitmaps-recursion-1
DELETE
Storagepoolvolumetypefilesdelete
— Delete a file
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/files
GET
Storagepoolvolumetypefilesget
— Get a file
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/files
HEAD
Storagepoolvolumetypefileshead
— Get metadata for a file
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/files
POST
Storagepoolvolumetypefilespost
— Create or replace a file
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/files
GET
Storagepoolvolumetypenbdget
— Get the storage volume NBD connection
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/nbd
GET
Storagepoolvolumetypesftpget
— Get the storage volume SFTP connection
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/sftp
GET
Storagepoolvolumestypesnapshotsget
— Get the storage volume snapshots
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots
POST
Storagepoolvolumestypesnapshotspost
— Create a storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots
DELETE
Storagepoolvolumestypesnapshotdelete
— Delete a storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots/{snapshotname}
GET
Storagepoolvolumestypesnapshotget
— Get the storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots/{snapshotname}
PATCH
Storagepoolvolumestypesnapshotpatch
— Partially update the storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots/{snapshotname}
POST
Storagepoolvolumestypesnapshotpost
— Rename a storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots/{snapshotname}
PUT
Storagepoolvolumestypesnapshotput
— Update the storage volume snapshot
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots/{snapshotname}
GET
Storagepoolvolumestypesnapshotsgetrecursion1
— Get the storage volume snapshots
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/snapshots-recursion-1
GET
Storagepoolvolumetypestateget
— Get the storage volume state
/v1/1-0/storage-pools/{poolname}/volumes/{type}/{volumename}/state
GET
Storagepoolvolumetypegetrecursion1
— Get the full storage volume details
/v1/1-0/storage-pools/{poolname}/volumes/{type}/volumename-recursion-1
GET
Storagepoolvolumestypegetrecursion1
— Get the storage volumes
/v1/1-0/storage-pools/{poolname}/volumes/type-recursion-1
GET
Storagepoolvolumestypegetrecursion2
— Get the storage volumes with all details
/v1/1-0/storage-pools/{poolname}/volumes/type-recursion-2
GET
Storagepoolvolumesgetrecursion1
— Get the storage volumes
/v1/1-0/storage-pools/{poolname}/volumes-recursion-1
GET
Storagepoolsgetrecursion1
— Get the storage pools
/v1/1-0/storage-pools-recursion-1
Capability Spec