OSBackupRuleRequest Data Type

Properties
name data type constraints description
guid string  
name string required, max size: 255, min size: 1
ruleBackupDestinations array of OSRuleBackupDestinationRequest required, not empty
schedules array of NameAndGuid  
active boolean required
policy NameAndGuid  
position number required
includes array of OSRuleRangeDTO required, not empty
excludes array of OSRuleRangeDTO  

Example

{
  "guid" : "...",
  "name" : "...",
  "ruleBackupDestinations" : [ {
    "type" : "OS",
    "guid" : "...",
    "backupDestination" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "roleType" : "ARCHIVE",
    "backupRetentionSettings" : {
      "retentionKeepLastNFull" : 12345,
      "retentionKeepFullNewerThan" : 12345,
      "retentionKeepLastNIncremental" : 12345,
      "retentionKeepIncrementalNewerThan" : 12345,
      "keepLastBackupWhenSourceStillExists" : true
    },
    "daysToKeepRetentionLock" : 12345,
    "active" : true
  }, {
    "type" : "STORAGE",
    "guid" : "...",
    "backupDestination" : {
      "guid" : "...",
      "name" : "..."
    },
    "roleType" : "ARCHIVE",
    "backupRetentionSettings" : {
      "retentionKeepLastNFull" : 12345,
      "retentionKeepFullNewerThan" : 12345,
      "retentionKeepLastNIncremental" : 12345,
      "retentionKeepIncrementalNewerThan" : 12345,
      "keepLastBackupWhenSourceStillExists" : true
    },
    "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" : "EXTENSION",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    } ]
  }, {
    "type" : "INCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    } ]
  } ],
  "excludes" : [ {
    "type" : "INCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "EXTENSION",
      "conditions" : [ { }, { } ]
    } ]
  }, {
    "type" : "INCLUDE",
    "protectedEntityGuid" : "...",
    "directory" : "...",
    "recursive" : true,
    "includeMountedFileSystems" : true,
    "filters" : [ {
      "type" : "EXTENSION",
      "conditions" : [ { }, { } ]
    }, {
      "type" : "SIZE",
      "conditions" : [ { }, { } ]
    } ]
  } ]
}