Applications Controller Resource

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

GET /applications

Returns list of applications filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
appCmdExecConfig query   yes
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
direction query   no
filter query   no
nameLike query   no
node-config query   no
orderBy query   no
page query   no
policy query   yes
size query   no
Response Body
media type data type description
application/json array of ApplicationListRecord (JSON) list of applications filtered by specified query parameters

Example

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

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

POST /applications

Create a application.

Request Parameters
name type description constraints
ignoreCheckSupport query specify if checking of application support is ignored required boolean
Request Body
media type data type description
application/json ApplicationRequest (JSON) specify data for new application
Response Body
media type data type description
application/json ApplicationDetails (JSON) details of newly created application

Example

Request
POST /applications
Content-Type: application/json
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
}

POST /applications/assign-backup-policy

Assign applications to specified policy (or unassign if policy is null)

Request Body
media type data type description
application/json ProtectedEntityBackupPolicyAssignmentRequest (JSON) containing policy and applications info
Response Body
media type data type description
application/json array of ApplicationDetails (JSON) list of updated applications

Example

Request
POST /applications/assign-backup-policy
Content-Type: application/json
Accept: application/json

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

GET /applications/backup-cleanup

Returns list of protected entities for backup cleanup.

Request Parameters
name type description constraints
backup-destination query  
page query int
size query int
Response Body
media type data type description
application/json array of ApplicationListRecord (JSON) list of protected entities for backup cleanup

Example

Request
GET /applications/backup-cleanup
Content-Type: */*
Accept: application/json

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

GET /applications/detailed

Returns detailed list of applications filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
appCmdExecConfig query   yes
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
direction query   no
filter query   no
nameLike query   no
node-config query   no
orderBy query   no
page query   no
policy query   yes
size query   no
Response Body
media type data type description
application/json array of ApplicationDetails (JSON) detailed list of applications filtered by specified query parameters

Example

Request
GET /applications/detailed
Content-Type: */*
Accept: application/json

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

GET /applications/rbac-contexts

Returns list of applications 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 hypervisors filtered by specified query parameters

Example

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

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

                
[ { } ]

GET /applications/reduced

Returns list of applications with reduced data, filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
appCmdExecConfig query   yes
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
direction query   no
filter query   no
nameLike query   no
node-config query   no
orderBy query   no
page query   no
policy query   yes
size query   no
Response Body
media type data type description
application/json array of ApplicationReducedListRecord (JSON) list of applications with reduced data for UI listing, filtered by specified query parameters

Example

Request
GET /applications/reduced
Content-Type: */*
Accept: application/json

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

DELETE /applications/{guid}

Remove application.

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

Example

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

                
...
Response
HTTP/1.1 204 No Content

GET /applications/{guid}

Get a single application.

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

Example

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

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
}

PUT /applications/{guid}

Change application details.

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

Example

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

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
}

POST /applications/{guid}/clone

Clone application.

Request Parameters
name type description
guid path local unique identifier of application that will be cloned
Request Body
media type data type description
application/json CloneDTO (JSON) specify details for new application
Response Body
media type data type description
application/json ApplicationDetails (JSON) details of newly created application

Example

Request
POST /applications/{guid}/clone
Content-Type: application/json
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
}

PUT /applications/{guid}/env-variables

Request Parameters
name type description
guid path
Request Body
media type data type
application/json ApplicationEnvironmentVariableUpdateRequest (JSON)

Example

Request
PUT /applications/{guid}/env-variables
Content-Type: application/json

                
{
  "envVariables" : [ {
    "guid" : "...",
    "name" : "...",
    "value" : "...",
    "appCmdExecConfigParam" : "...",
    "hiddenInUI" : true
  }, {
    "guid" : "...",
    "name" : "...",
    "value" : "...",
    "appCmdExecConfigParam" : "...",
    "hiddenInUI" : true
  } ],
  "appCmdExecConfigGuids" : [ "...", "..." ]
}
Response
HTTP/1.1 204 No Content