Root Controller Resource

The API allows you to view vProtect version and get custom image of logo and background.

GET /background

Get custom background image from "/opt/vprotect/custom/background".

Response Body
media type data type description
text/plain object custom background image encoded in base64

Example

Request
GET /background
Content-Type: */*
Accept: text/plain

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...
                
              

GET /branding-configuration

Get branding configuration

Response Body
media type data type description
application/json BrandConfigurationDetails (JSON) branding configuration

Example

Request
GET /branding-configuration
Content-Type: */*
Accept: application/json

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

                
{
  "applicationSupport" : true,
  "insightSupport" : true,
  "sparsifySupported" : true,
  "dedupSupported" : true,
  "hypervisors" : [ "KVM", "HYPERV" ],
  "hypervisorManagers" : [ "HYPERV", "RHEV" ],
  "backupDestinations" : [ "RUBRIK", "DATAPROTECTOR" ],
  "storageProviders" : [ "NUTANIX_VG", "CEPH_RBD" ],
  "applicationConfigs" : [ "ETCD_BACKUP", "VPROTECT_GIT_REPOSITORY_BACKUP" ]
}
                
              

GET /logo

Get custom logo image from "/opt/vprotect/custom/logo".

Response Body
media type data type description
text/plain object custom logo image encoded in base64

Example

Request
GET /logo
Content-Type: */*
Accept: text/plain

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...
                
              

GET /version

Get vProtect version.

Response Body
media type data type description
application/json StringDTO (JSON) vProtect version

Example

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

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

                
{
  "value" : "..."
}
                
              

GET /capabilities/supported-by-license

Get capabilities list supported by the license file

Response Body
media type data type description
application/json SupportedLicenseCapabilitiesDetails (JSON) capabilities list supported by the license file

Example

Request
GET /capabilities/supported-by-license
Content-Type: */*
Accept: application/json

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

                
{
  "virtualMachineSupport" : true,
  "applicationSupport" : true,
  "storageSupport" : true,
  "cloudSupport" : true,
  "osAgentSupport" : true,
  "endpointsSupport" : true
}