The API allows you to list, view, edit and create storage pools.
Returns list of storage pools filtered by specified query parameters.
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query | |
storage-provider | query | |
uuid | query |
media type | data type | description |
---|---|---|
application/json | array of StoragePoolListRecord (JSON) | list of storage pools filtered by specified query parameters |
GET /storage-pools
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"usedSpace" : 12345
} ]
Create storage pool.
media type | data type | description |
---|---|---|
application/json | StoragePoolRequest (JSON) | specify details for new storage pool |
media type | data type | description |
---|---|---|
application/json | StoragePoolListRecord (JSON) | details of newly created storage pool |
POST /storage-pools
Content-Type: application/json
Accept: application/json
{
"uuid" : "...",
"name" : "...",
"size" : 12345,
"usedSpace" : 12345,
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"usedSpace" : 12345
}
Returns list of storage pools rbac contexts filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
app-cmd-exec-config | query | ||
cloud-service-provider | query | ||
cluster | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
project | query | ||
size | query | ||
storage-pool | query | ||
storage-provider | query | ||
teams-group | query | boolean |
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of storage pools filtered by specified query parameters |
GET /storage-pools/rbac-contexts
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"nameAndGuid" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "...",
"type" : "CLOUD_USER",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Remove storage pool.
name | type | description |
---|---|---|
guid | path | specify local unqiue identifier for storage pool (use by vProtect) |
DELETE /storage-pools/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single storage pool.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for storage pool (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StoragePoolListRecord (JSON) | storage pool details |
GET /storage-pools/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"usedSpace" : 12345
}
Change storage pool details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for storage pool (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StoragePoolRequest (JSON) | specify storage pool details to update |
media type | data type | description |
---|---|---|
application/json | StoragePoolListRecord (JSON) | updated details of storage pool |
PUT /storage-pools/{guid}
Content-Type: application/json
Accept: application/json
{
"uuid" : "...",
"name" : "...",
"size" : 12345,
"usedSpace" : 12345,
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"storageProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"usedSpace" : 12345
}