Datacenter Controller Resource

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

GET /datacenters

Returns list of data centers filtered by specified query parameters.

Request Parameters
name type description constraints
compute-region query boolean
hypervisor query  
hypervisor-manager query  
name query  
uuid query  
Response Body
media type data type description
application/json array of DataCenterListRecord (JSON) list of hypervisor clusters filtered by specified query parameters

Example

Request
GET /datacenters
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

GET /datacenters/for-restore

Returns list of data centers for restore filtered by specified query parameters.

Request Parameters
name type description constraints
compute-region query boolean
hypervisor query  
hypervisor-manager query  
name query  
uuid query  
Response Body
media type data type description
application/json array of DataCenterForRestoreListRecord (JSON) list of hypervisor clusters filtered by specified query parameters

Example

Request
GET /datacenters/for-restore
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

GET /datacenters/rbac-contexts

Returns list of virtual machines filtered by specified query parameters.

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

Example

Request
GET /datacenters/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

DELETE /datacenters/{guid}

Remove project.

Request Parameters
name type description
guid path specify local unique identifier for project (use by vProtect)

Example

Request
DELETE /datacenters/{guid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /datacenters/{guid}

Get a single data center.

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

Example

Request
GET /datacenters/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }