StoragePoolController Resource

The API allows you to list, view, edit and create storage pools.

GET /storage-pools

Returns list of storage pools filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
storage-provider query
uuid query
Response Body
media type data type description
application/json array of StoragePoolListRecord (JSON) list of storage pools filtered by specified query parameters

Example

Request
GET /storage-pools
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

POST /storage-pools

Create storage pool.

Request Body
media type data type description
application/json StoragePoolRequest (JSON) specify details for new storage pool
Response Body
media type data type description
application/json StoragePoolListRecord (JSON) details of newly created storage pool

Example

Request
POST /storage-pools
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /storage-pools/rbac-contexts

Returns list of storage pools rbac contexts filtered by specified query parameters.

Request Parameters
name type description
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
Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of storage pools filtered by specified query parameters

Example

Request
GET /storage-pools/rbac-contexts
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

DELETE /storage-pools/{guid}

Remove storage pool.

Request Parameters
name type description
guid path specify local unqiue identifier for storage pool (use by vProtect)

Example

Request
DELETE /storage-pools/{guid}
Response
HTTP/1.1 204 No Content

GET /storage-pools/{guid}

Get a single storage pool.

Request Parameters
name type description
guid path specify local unique identifier for storage pool (use by vProtect)
Response Body
media type data type description
application/json StoragePoolListRecord (JSON) storage pool details

Example

Request
GET /storage-pools/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /storage-pools/{guid}

Change storage pool details.

Request Parameters
name type description
guid path specify local unique identifier for storage pool (use by vProtect)
Request Body
media type data type description
application/json StoragePoolRequest (JSON) specify storage pool details to update
Response Body
media type data type description
application/json StoragePoolListRecord (JSON) updated details of storage pool

Example

Request
PUT /storage-pools/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }