Protected Entity Controller Resource

The API allows you to list and delete protected entities.

GET /protected-entities

Returns list of protected entities.

Response Body
media type data type description
application/json array of ProtectedEntityDTO (JSON) list of protected entities

Example

Request
GET /protected-entities
Content-Type: */*
Accept: application/json

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

                
[ {
  "name" : "...",
  "type" : "OS_AGENT",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]
                
              

PUT /protected-entities/credential

Change credentials for specified list of protected entities.

Request Body
media type data type description
application/json ProtectedEntityOsCredentialsAssignmentRequest (JSON) specify credential and guids of protected entities.
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of protected entities.

Example

Request
PUT /protected-entities/credential
Content-Type: application/json
Accept: application/json

                
{
  "value" : "...",
  "entities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

PUT /protected-entities/warnings-acknowledged

Acknowledge warnings for snapshot in protected entities.

Request Body
media type data type description
application/json WarningAcknowledgementRequest (JSON) batch request to ak

Example

Request
PUT /protected-entities/warnings-acknowledged
Content-Type: application/json

                
{
  "protectedEntities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backups" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "snapshots" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "restoreJobs" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupDestinations" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /protected-entities/{guid}

Remove protected entity and backups.

Request Parameters
name type description
guid path specify local unique identifier for protected entity (use by vProtect)
backup-destination query specify local unique identifier for backup destination (use by vProtect)

Example

Request
DELETE /protected-entities/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /protected-entities/{guid}/backup-warnings-ack

Acknowledge warnings for snapshot in protected entity. Left to conform to backwards compatibility

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

Example

Request
PUT /protected-entities/{guid}/backup-warnings-ack
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

PUT /protected-entities/{guid}/warnings-acknowledged

Acknowledge warnings for snapshot in protected entity.

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

Example

Request
PUT /protected-entities/{guid}/warnings-acknowledged
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content