OS Backup Policies Controller Resource

The API allows you to list, view, create and edit os backup policies.

GET /policies/os-backup

Returns list of os backup policies filtered by specified query parameters.

Request Parameters
name type description default constraints
direction query    
extended query false boolean
filter query    
nameLike query    
orderBy query    
osType query   "LINUX" or "MAC" or "WINDOWS"
page query    
size query    
Response Body
media type data type description
application/json array of OSBackupPolicyListRecord (JSON) list of os backup policies filtered by specified query parameters

Example

Request
GET /policies/os-backup
Content-Type: */*
Accept: application/json

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

                
[ {
  "ruleCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoAssignMode" : "ASSIGN_AND_REMOVE",
  "osAgentCount" : 12345,
  "priority" : 50,
  "protectedEntitiesCount" : 12345,
  "ruleBackupDestinations" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345,
    "rule" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupDestination" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "roleType" : "SECONDARY",
    "backupRetentionSettings" : {
      "retentionKeepLastNFull" : 12345,
      "retentionKeepFullNewerThan" : 12345,
      "retentionKeepLastNIncremental" : 12345,
      "retentionKeepIncrementalNewerThan" : 12345,
      "keepLastBackupWhenSourceStillExists" : true
    }
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345,
    "rule" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupDestination" : {
      "type" : { },
      "guid" : "...",
      "name" : "..."
    },
    "roleType" : "SECONDARY",
    "backupRetentionSettings" : {
      "retentionKeepLastNFull" : 12345,
      "retentionKeepFullNewerThan" : 12345,
      "retentionKeepLastNIncremental" : 12345,
      "retentionKeepIncrementalNewerThan" : 12345,
      "keepLastBackupWhenSourceStillExists" : true
    }
  } ],
  "osType" : "WINDOWS"
} ]
                
              

POST /policies/os-backup

Create os backup policy.

Request Body
media type data type description
application/json OSBackupPolicyRequest (JSON) specify details for new os backup policy
Response Body
media type data type description
application/json OSBackupPolicyDetails (JSON) details of newly created os backup policy

Example

Request
POST /policies/os-backup
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupRetryCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "OS",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "STORAGE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "OS",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  } ],
  "priority" : 50,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "active" : true,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "autoAssignSettings" : {
    "mode" : "DISABLED",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "executeAutoAssignmentAfterSavingPolicy" : true,
  "osType" : "WINDOWS",
  "disableCleanOldBackups" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "autoAssignSettings" : {
    "mode" : "ASSIGN_AND_REMOVE",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "priority" : 50,
  "averageBackupSize" : 12345,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "osType" : "LINUX",
  "disableCleanOldBackups" : true
}
                
              

POST /policies/os-backup/auto-assignment-preview

Get auto-assignment preview for all os protected entities and given backup policy.

Request Body
media type data type description
application/json OSBackupPolicyRequest (JSON) specify os backup policy details to create preview
Response Body
media type data type description
application/json OSCommonAutoAssignResultPreviewListRecord (JSON) list of auto-assignment result preview records

Example

Request
POST /policies/os-backup/auto-assignment-preview
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupRetryCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "STORAGE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "CLOUD",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "OS",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  } ],
  "priority" : 50,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "active" : true,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "autoAssignSettings" : {
    "mode" : "ASSIGN_ONLY",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "executeAutoAssignmentAfterSavingPolicy" : true,
  "osType" : "LINUX",
  "disableCleanOldBackups" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "forOSAgent" : [ {
    "protectedEntity" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "changeType" : "REMOVAL",
    "changeReason" : "PE_IS_NOT_PRESENT"
  }, {
    "protectedEntity" : {
      "guid" : "...",
      "name" : "..."
    },
    "changeType" : "NONE",
    "changeReason" : "ALREADY_ASSIGNED_TO_NON_REMOVABLE_POLICY"
  } ]
}
                
              

GET /policies/os-backup/detailed

Returns detailed list of os backup policies.

Response Body
media type data type description
application/json array of OSBackupPolicyDetails (JSON) detailed list of os backup policies

Example

Request
GET /policies/os-backup/detailed
Content-Type: */*
Accept: application/json

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

                
[ {
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "autoAssignSettings" : {
    "mode" : "ASSIGN_ONLY",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "priority" : 50,
  "averageBackupSize" : 12345,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "osType" : "MAC",
  "disableCleanOldBackups" : true
} ]
                
              

POST /policies/os-backup/list-by-entities

Get all the policies and rules from selected protected entities

Request Body
media type data type description
application/json ProtectedEntityPolicyRequest (JSON) containing selected protected entities
Response Body
media type data type description
application/json array of BackupPolicyForBackupListRecord (JSON) list of policies and rules

Example

Request
POST /policies/os-backup/list-by-entities
Content-Type: application/json
Accept: application/json

                
{
  "protectedEntities" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "guid" : "...",
  "name" : "...",
  "entityCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "markedForDeletion" : true,
    "position" : 12345,
    "ruleBackupDestinations" : [ {
      "backupDestination" : { },
      "roleType" : "PRIMARY"
    }, {
      "backupDestination" : { },
      "roleType" : "ARCHIVE"
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "markedForDeletion" : true,
    "position" : 12345,
    "ruleBackupDestinations" : [ {
      "backupDestination" : { },
      "roleType" : "PRIMARY"
    }, {
      "backupDestination" : { },
      "roleType" : "ARCHIVE"
    } ]
  } ]
} ]
                
              

DELETE /policies/os-backup/{guid}

Remove os backup policy.

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

Example

Request
DELETE /policies/os-backup/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /policies/os-backup/{guid}

Get a single os backup policy.

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

Example

Request
GET /policies/os-backup/{guid}
Content-Type: */*
Accept: application/json

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

                
{
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "autoAssignSettings" : {
    "mode" : "DISABLED",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "priority" : 50,
  "averageBackupSize" : 12345,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "osType" : "WINDOWS",
  "disableCleanOldBackups" : true
}
                
              

PUT /policies/os-backup/{guid}

Change os backup policy details.

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

Example

Request
PUT /policies/os-backup/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupRetryCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "STORAGE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "VIRTUAL_MACHINE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  } ],
  "priority" : 50,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "active" : true,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "autoAssignSettings" : {
    "mode" : "ASSIGN_AND_REMOVE",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "executeAutoAssignmentAfterSavingPolicy" : true,
  "osType" : "LINUX",
  "disableCleanOldBackups" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "autoAssignSettings" : {
    "mode" : "DISABLED",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "priority" : 50,
  "averageBackupSize" : 12345,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "osType" : "MAC",
  "disableCleanOldBackups" : true
}
                
              

POST /policies/os-backup/{guid}/auto-assignment-preview

Get auto-assignment preview for all os protected entities and given backup policy.

Request Parameters
name type description
guid path specify local unique identifier for os backup policy (use by vProtect)
Request Body
media type data type description
application/json OSBackupPolicyRequest (JSON) specify os backup policy details to create preview
Response Body
media type data type description
application/json OSCommonAutoAssignResultPreviewListRecord (JSON) list of auto-assignment result preview records

Example

Request
POST /policies/os-backup/{guid}/auto-assignment-preview
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "backupRetryCount" : 12345,
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "APPLICATION",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "STORAGE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "ruleBackupDestinations" : [ {
      "type" : "VIRTUAL_MACHINE",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    }, {
      "type" : "OS",
      "guid" : "...",
      "backupDestination" : { },
      "roleType" : "SECONDARY",
      "backupRetentionSettings" : { },
      "daysToKeepRetentionLock" : 12345,
      "active" : true
    } ],
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "active" : true,
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "position" : 12345,
    "includes" : [ {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "INCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ],
    "excludes" : [ {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    }, {
      "type" : "EXCLUDE",
      "protectedEntityGuid" : "...",
      "directory" : "...",
      "recursive" : true,
      "includeMountedFileSystems" : true,
      "filters" : [ { }, { } ]
    } ]
  } ],
  "priority" : 50,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "active" : true,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "autoAssignSettings" : {
    "mode" : "DISABLED",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "executeAutoAssignmentAfterSavingPolicy" : true,
  "osType" : "WINDOWS",
  "disableCleanOldBackups" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "forOSAgent" : [ {
    "protectedEntity" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "changeType" : "REMOVAL",
    "changeReason" : "PE_IS_NOT_PRESENT"
  }, {
    "protectedEntity" : {
      "guid" : "...",
      "name" : "..."
    },
    "changeType" : "NONE",
    "changeReason" : "PE_DOESNT_MATCH_ANY_INCLUDE_RULES"
  } ]
}
                
              

POST /policies/os-backup/{guid}/clone

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

Example

Request
POST /policies/os-backup/{guid}/clone
Content-Type: application/json
Accept: application/json

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

                
{
  "rules" : [ {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "schedules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "schedules" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "vmCount" : 12345,
    "schedulesCount" : 12345,
    "position" : 12345,
    "active" : true,
    "removable" : true,
    "daysToKeepRetentionLock" : 12345
  } ],
  "name" : "...",
  "active" : true,
  "backupRetryCount" : 12345,
  "autoAssignSettings" : {
    "mode" : "ASSIGN_AND_REMOVE",
    "includeRegExps" : [ "...", "..." ],
    "osAgents" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "autoRemoveNonPresent" : true,
  "osAgents" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "priority" : 50,
  "averageBackupSize" : 12345,
  "failRemainingBackupTasksExportThreshold" : 12345.0,
  "failRemainingBackupTasksStoreThreshold" : 12345.0,
  "dailyReportEnabled" : true,
  "mailingList" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "osType" : "WINDOWS",
  "disableCleanOldBackups" : true
}
                
              

GET /policies/os-backup/{guid}/entities

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

Example

Request
GET /policies/os-backup/{guid}/entities
Content-Type: */*
Accept: application/json

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

                
{
  "osAgents" : [ {
    "name" : "...",
    "type" : "VM",
    "backupUpToDate" : true,
    "restorable" : true,
    "description" : "...",
    "lastSuccessfulBackupSize" : 12345,
    "lastLoginDate" : 12345,
    "status" : "WORKING",
    "lastSuccessfulFullBackupSize" : 12345,
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "warningsPresent" : true,
    "possibleActions" : [ "HVM_READ", "HV_READ" ],
    "lastSuccessfulFullBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "policy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "lastSuccessfulIncBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "osType" : "WINDOWS",
    "averageProgress" : 12345.0,
    "lastChainMarkedForDeletion" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastBackup" : 1451649601000
  }, {
    "name" : "...",
    "type" : "CLOUD_TEAMS",
    "backupUpToDate" : true,
    "restorable" : true,
    "description" : "...",
    "lastSuccessfulBackupSize" : 12345,
    "lastLoginDate" : 12345,
    "status" : "DISCONNECTED",
    "lastSuccessfulFullBackupSize" : 12345,
    "nodeConfig" : {
      "guid" : "...",
      "name" : "..."
    },
    "warningsPresent" : true,
    "possibleActions" : [ "READ", "HV_READ" ],
    "lastSuccessfulFullBackup" : {
      "guid" : "...",
      "name" : "..."
    },
    "policy" : {
      "guid" : "...",
      "name" : "..."
    },
    "lastSuccessfulIncBackup" : {
      "guid" : "...",
      "name" : "..."
    },
    "osType" : "LINUX",
    "averageProgress" : 12345.0,
    "lastChainMarkedForDeletion" : true,
    "guid" : "...",
    "lastBackup" : 12345
  } ]
}