Proxmox VE API. Pools.
/pools
GET
Description: Pool index.
Permissions:
| User | Permissions | Description |
|---|---|---|
| all | N/A | List all pools where you have Pool.Allocate or VM.Allocate permissions on /pool/ |
Return:
array
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| poolid | string | N/A | N/A |
Usage:
HTTP GET /api2/json/pools
CLI pvesh get /pools
POST
Description: Create new pool.
Permissions:
| User | Permissions | Description |
|---|---|---|
| N/A | [u'perm', u'/pool/{poolid}', [u'Pool.Allocate']] | N/A |
Parameters:
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| comment | string | N/A | N/A |  |
| poolid | string | pve-poolid | N/A |
Return:
null
Usage:
HTTP POST /api2/json/pools
CLI pvesh create /pools
/pools/{poolid}
GET
Description: Get pool configuration.
Permissions:
| User | Permissions | Description |
|---|---|---|
| N/A | [u'perm', u'/pool/{poolid}', [u'Pool.Allocate']] | N/A |
Parameters:
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| poolid | string | pve-poolid | N/A |
Return:
object
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| comment | string | N/A | N/A | |
| members | array | N/A | N/A |
Usage:
HTTP GET /api2/json/pools/{poolid}
CLI pvesh get /pools/{poolid}
PUT
Description: Update pool data.
Permissions:
| User | Permissions | Description |
|---|---|---|
| N/A | [u'perm', u'/pool/{poolid}', [u'Pool.Allocate']] | You also need the right to modify permissions on any object you add/delete. |
Parameters:
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| comment | string | N/A | N/A | |
| delete | boolean | N/A | Remove vms/storage (instead of adding it). | |
| storage | string | pve-storage-id-list | List of storage IDs. | |
| vms | string | pve-vmid-list | List of virtual machines. | |
| poolid | string | pve-poolid | N/A |
Return:
null
Usage:
HTTP PUT /api2/json/pools/{poolid}
CLI pvesh set /pools/{poolid}
DELETE
Description: Delete pool.
Permissions:
| User | Permissions | Description |
|---|---|---|
| N/A | [u'perm', u'/pool/{poolid}', [u'Pool.Allocate']] | You can only delete empty pools (no members). |
Parameters:
| Name | Type | Format | Description | Optional |
|---|---|---|---|---|
| poolid | string | pve-poolid | N/A |
Return:
null
Usage:
HTTP DELETE /api2/json/pools/{poolid}
CLI pvesh delete /pools/{poolid}
Proxmox VE API. Access.
Proxmox VE API. Cluster.
Proxmox VE API. Storage.
Proxmox VE API. Versions.
Proxmox VE API. Nodes.
