nodes / storage
20 operations.
GET /nodes/{node}/storage
ts
proxmox.nodes.$(node).storage.$get()Get status for all datastores.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
content | string | Only list stores which support this content type. — format pve-storage-content-list | |
enabled | boolean | Only list stores which are enabled (not disabled in config). — default 0 | |
format | boolean | Include information about formats — default 0 | |
node | string | yes | The cluster node name. — format pve-node |
storage | string | Only list status for specified storage — format pve-storage-id | |
target | string | If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. — format pve-node |
GET /nodes/{node}/storage/{storage}
ts
proxmox.nodes.$(node).storage.$(storage).$get()Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
GET /nodes/{node}/storage/{storage}/content
ts
proxmox.nodes.$(node).storage.$(storage).content.$get()List storage content.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
content | string | Only list content of this type. — format pve-storage-content | |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
vmid | number | Only list images for this VM — format pve-vmid, min 100, max 999999999 |
POST /nodes/{node}/storage/{storage}/content
ts
proxmox.nodes.$(node).storage.$(storage).content.$post()Allocate disk images.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
filename | string | yes | The name of the file to create. |
format | raw | qcow2 | subvol | vmdk | Format of the image. | |
node | string | yes | The cluster node name. — format pve-node |
size | string | yes | Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) |
storage | string | yes | The storage identifier. — format pve-storage-id |
vmid | number | yes | Specify owner VM — format pve-vmid, min 100, max 999999999 |
GET /nodes/{node}/storage/{storage}/content/{volume}
ts
proxmox.nodes.$(node).storage.$(storage).content.$(volume).$get()Get volume attributes
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | The storage identifier. — format pve-storage-id | |
volume | string | yes | Volume identifier |
POST /nodes/{node}/storage/{storage}/content/{volume}
ts
proxmox.nodes.$(node).storage.$(storage).content.$(volume).$post()Copy a volume. This is experimental code - do not use.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | The storage identifier. — format pve-storage-id | |
target | string | yes | Target volume identifier |
target_node | string | Target node. Default is local node. — format pve-node | |
volume | string | yes | Source volume identifier |
PUT /nodes/{node}/storage/{storage}/content/{volume}
ts
proxmox.nodes.$(node).storage.$(storage).content.$(volume).$put()Update volume attributes
Returns nothing.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
notes | string | The new notes. | |
protected | boolean | Protection status. Currently only supported for backups. | |
storage | string | The storage identifier. — format pve-storage-id | |
volume | string | yes | Volume identifier |
DELETE /nodes/{node}/storage/{storage}/content/{volume}
ts
proxmox.nodes.$(node).storage.$(storage).content.$(volume).$delete()Delete volume
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
delay | number | Time to wait for the task to finish. We return 'null' if the task finish within that time. — min 1, max 30 | |
node | string | yes | The cluster node name. — format pve-node |
storage | string | The storage identifier. — format pve-storage-id | |
volume | string | yes | Volume identifier |
POST /nodes/{node}/storage/{storage}/download-url
ts
proxmox.nodes.$(node).storage.$(storage)["download-url"].$post()Download templates, ISO images, OVAs and VM images by using an URL.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
checksum | string | The expected checksum of the file. | |
checksum-algorithm | md5 | sha1 | sha224 | sha256 | sha384 | sha512 | The algorithm to calculate the checksum of the file. | |
compression | string | Decompress the downloaded file using the specified compression algorithm. | |
content | iso | vztmpl | import | yes | Content type. — format pve-storage-content |
filename | string | yes | The name of the file to create. Caution: This will be normalized! — ≤ 255 chars |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
url | string | yes | The URL to download the file from. |
verify-certificates | boolean | If false, no SSL/TLS certificates will be verified. — default 1 |
GET /nodes/{node}/storage/{storage}/file-restore/download
ts
proxmox.nodes.$(node).storage.$(storage)["file-restore"].download.$get()Extract a file or directory (as zip archive) from a PBS backup.
Returns any.
| Parameter | Type | Required | Notes |
|---|---|---|---|
filepath | string | yes | base64-path to the directory or file to download. |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
tar | boolean | Download dirs as 'tar.zst' instead of 'zip'. — default 0 | |
volume | string | yes | Backup volume ID or name. Currently only PBS snapshots are supported. |
GET /nodes/{node}/storage/{storage}/file-restore/list
ts
proxmox.nodes.$(node).storage.$(storage)["file-restore"].list.$get()List files and directories for single file restore under the given path.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
filepath | string | yes | base64-path to the directory or file being listed, or "/". |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
volume | string | yes | Backup volume ID or name. Currently only PBS snapshots are supported. |
GET /nodes/{node}/storage/{storage}/identity
ts
proxmox.nodes.$(node).storage.$(storage).identity.$get()Return identity information for this storage instance.
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
GET /nodes/{node}/storage/{storage}/import-metadata
ts
proxmox.nodes.$(node).storage.$(storage)["import-metadata"].$get()Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
volume | string | yes | Volume identifier for the guest archive/entry. |
POST /nodes/{node}/storage/{storage}/oci-registry-pull
ts
proxmox.nodes.$(node).storage.$(storage)["oci-registry-pull"].$post()Pull an OCI image from a registry.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
filename | string | Custom destination file name of the OCI image. Caution: This will be normalized! — ≤ 255 chars | |
node | string | yes | The cluster node name. — format pve-node |
reference | string | yes | The reference to the OCI image to download. |
storage | string | yes | The storage identifier. — format pve-storage-id |
GET /nodes/{node}/storage/{storage}/prunebackups
ts
proxmox.nodes.$(node).storage.$(storage).prunebackups.$get()Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
prune-backups | string | Use these retention options instead of those from the storage configuration. — format prune-backups | |
storage | string | yes | The storage identifier. — format pve-storage-id |
type | qemu | lxc | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. | |
vmid | number | Only consider backups for this guest. — format pve-vmid, min 100, max 999999999 |
DELETE /nodes/{node}/storage/{storage}/prunebackups
ts
proxmox.nodes.$(node).storage.$(storage).prunebackups.$delete()Prune backups. Only those using the standard naming scheme are considered.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
prune-backups | string | Use these retention options instead of those from the storage configuration. — format prune-backups | |
storage | string | yes | The storage identifier. — format pve-storage-id |
type | qemu | lxc | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. | |
vmid | number | Only prune backups for this VM. — format pve-vmid, min 100, max 999999999 |
GET /nodes/{node}/storage/{storage}/rrd
ts
proxmox.nodes.$(node).storage.$(storage).rrd.$get()Read storage RRD statistics (returns PNG).
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
cf | AVERAGE | MAX | The RRD consolidation function | |
ds | string | yes | The list of datasources you want to display. — format pve-configid-list |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
timeframe | hour | day | week | month | year | yes | Specify the time frame you are interested in. |
GET /nodes/{node}/storage/{storage}/rrddata
ts
proxmox.nodes.$(node).storage.$(storage).rrddata.$get()Read storage RRD statistics.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
cf | AVERAGE | MAX | The RRD consolidation function | |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
timeframe | hour | day | week | month | year | yes | Specify the time frame you are interested in. |
GET /nodes/{node}/storage/{storage}/status
ts
proxmox.nodes.$(node).storage.$(storage).status.$get()Read storage status.
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
POST /nodes/{node}/storage/{storage}/upload
ts
proxmox.nodes.$(node).storage.$(storage).upload.$post()Upload templates, ISO images, OVAs and VM images.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
checksum | string | The expected checksum of the file. | |
checksum-algorithm | md5 | sha1 | sha224 | sha256 | sha384 | sha512 | The algorithm to calculate the checksum of the file. | |
content | iso | vztmpl | import | yes | Content type. — format pve-storage-content |
filename | string | yes | The name of the file to create. Caution: This will be normalized! — ≤ 255 chars |
node | string | yes | The cluster node name. — format pve-node |
storage | string | yes | The storage identifier. — format pve-storage-id |
tmpfilename | string | The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. |