Skip to main content

Create a Plan​

Select

SaaS
Customer Managed

This operation creates a Plan.

Request Body
  • plan object
  • featureInfo object
  • edgedriveInfo object
  • enableNotificationsForShares boolean
  • auditDriveActivities boolean
  • edgeDriveAssociations object
  • indexServer object
  • clientId integer
  • clientName string
  • inheritance object
  • isSealed boolean
  • storage object
  • storagePolicy object
  • copy object[]
  • active integer
  • isDefault integer
  • dedupeFlags object
  • enableDASHFull integer
  • useGlobalDedupStore integer
  • enableDeduplication integer
  • enableClientSideDedup integer
  • storagePolicyFlags object
  • blockLevelDedup integer
  • retentionRules object
  • retainBackupDataForDays integer
  • retentionFlags object
  • enableDataAging integer
  • useGlobalPolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • laptop object
  • features object
  • categoryPermission object
  • categoriesPermissionList object[]
  • permissionId integer
  • permissionName string
  • _type_ integer
  • content object
  • backupContent object[]
  • idatype integer
  • subClientPolicy object
  • backupSetEntity object
  • backupsetName string
  • subClientList object[]
  • contentOperationType integer
  • fsSubClientProp object
  • useVSSForSystemState boolean
  • backupRetention boolean
  • backupSystemState boolean
  • afterDeletionKeepItemsForNDays integer
  • extendRetentionForNDays integer
  • archiverRetentionMode integer
  • enableOnePass boolean
  • useVSS boolean
  • extendStoragePolicyRetention boolean
  • keepAtLeastPreviousVersions integer
  • catalogACL boolean
  • archiverRetention boolean
  • olderFileVersionsMode integer
  • backupRetentionMode integer
  • backupSystemStateforFullBkpOnly boolean
  • keepVersions integer
  • scanOption integer
  • keepOlderVersionsForNDays integer
  • diskCleanupRules object
  • fileModifiedTimeOlderThan integer
  • fileSizeGreaterThan integer
  • afterArchivingRule integer
  • fileCreatedTimeOlderThan integer
  • maximumFileSize integer
  • fileAccessTimeOlderThan integer
  • startCleaningIfLessThan integer
  • archiveReadOnlyFiles boolean
  • stopCleaningIfupto integer
  • enableArchivingWithRules boolean
  • content object[]
  • path string
  • excludePath string
  • commonProperties object
  • storageDevice object
  • softwareCompression integer
  • deDuplicationOptions object
  • enableDeduplication boolean
  • generateSignature integer
  • options object
  • edgeDriveQuota integer
  • quota integer
  • summary object
  • description string
  • restrictions integer
  • type integer
  • slaInterval integer
  • rpoInMinutes integer
  • subtype integer
  • planOwner object
  • userGUID string
  • userName string
  • userId integer
  • plan object
  • planName string
  • alerts object
  • alerts object[]
  • alertName string
  • alertId integer
  • schedule object
  • task object
  • taskType integer
  • taskFlags object
  • isEdgeDrive boolean
  • isEZOperation boolean
  • disabled boolean
  • subTasks object[]
  • subTask object
  • subTaskName string
  • subTaskType integer
  • flags integer
  • operationType integer
  • subTaskId integer
  • pattern object
  • freq_subday_interval integer
  • freq_type integer
  • active_end_time integer
  • name string
  • freq_recurrence_factor integer
  • options object
  • backupOpts object
  • backupLevel integer
  • incLevel integer
  • runIncrementalBackup boolean
  • cdrOptions object
  • incremental boolean
  • dataOpt object
  • useCatalogServer boolean
  • followMountPoints boolean
  • daysBetweenSyntheticBackup integer
  • useMultiStream boolean
  • useMaximumStreams boolean
  • enforceTransactionLogUsage boolean
  • skipConsistencyCheck boolean
  • maxNumberOfStreams integer
  • createNewIndex boolean
  • autoCopy boolean
  • truncateLogsOnSource boolean
  • doNotTruncateLog boolean
  • vsaBackupOptions object
  • backupFailedVMsOnly boolean
  • commonOpts object
  • automaticSchedulePattern object
  • maxBackupInterval integer
  • ignoreOpWindowPastMaxInterval boolean
  • minBackupIntervalMinutes integer
  • maxBackupIntervalMinutes integer
  • minSyncInterval integer
  • minBackupInterval integer
  • minSyncIntervalMinutes integer
  • stopIfOnBattery object
  • enabled boolean
  • acPower object
  • enabled boolean
  • specfificNetwork object
  • enabled boolean
  • ipAddress object
  • subnet integer
  • address string
  • stopSleepIfBackUp object
  • enabled boolean
  • newOrModifiedFile object
  • enabled boolean
  • wiredNetworkConnection object
  • enabled boolean
  • minNetworkBandwidth object
  • enabled boolean
Responses

OK

POST /v2/plan

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "plan": {

    "featureInfo": {

      "edgedriveInfo": {

        "enableNotificationsForShares": true,

        "auditDriveActivities": true,

        "edgeDriveAssociations": {

          "indexServer": {

            "clientId": 0,

            "clientName": "string"

          }

        }

      }

    },

    "inheritance": {

      "isSealed": true

    },

    "storage": {

      "storagePolicy": {},

      "copy": [

        {

          "active": 0,

          "isDefault": 0,

          "dedupeFlags": {

            "enableDASHFull": 0,

            "useGlobalDedupStore": 0,

            "enableDeduplication": 0,

            "enableClientSideDedup": 0

          },

          "storagePolicyFlags": {

            "blockLevelDedup": 0

          },

          "retentionRules": {

            "retainBackupDataForDays": 0,

            "retentionFlags": {

              "enableDataAging": 0

            }

          },

          "useGlobalPolicy": {

            "storagePolicyName": "string",

            "storagePolicyId": 0

          }

        }

      ]

    },

    "laptop": {

      "features": {

        "categoryPermission": {

          "categoriesPermissionList": [

            {

              "permissionId": 0,

              "permissionName": "string",

              "_type_": 0

            }

          ]

        }

      },

      "content": {

        "backupContent": [

          {

            "idatype": 0,

            "subClientPolicy": {

              "backupSetEntity": {

                "backupsetName": "string"

              },

              "subClientList": [

                {

                  "contentOperationType": 0,

                  "fsSubClientProp": {

                    "useVSSForSystemState": true,

                    "backupRetention": true,

                    "backupSystemState": true,

                    "afterDeletionKeepItemsForNDays": 0,

                    "extendRetentionForNDays": 0,

                    "archiverRetentionMode": 0,

                    "enableOnePass": true,

                    "useVSS": true,

                    "extendStoragePolicyRetention": true,

                    "keepAtLeastPreviousVersions": 0,

                    "catalogACL": true,

                    "archiverRetention": true,

                    "olderFileVersionsMode": 0,

                    "backupRetentionMode": 0,

                    "backupSystemStateforFullBkpOnly": true,

                    "keepVersions": 0,

                    "scanOption": 0,

                    "keepOlderVersionsForNDays": 0,

                    "diskCleanupRules": {

                      "fileModifiedTimeOlderThan": 0,

                      "fileSizeGreaterThan": 0,

                      "afterArchivingRule": 0,

                      "fileCreatedTimeOlderThan": 0,

                      "maximumFileSize": 0,

                      "fileAccessTimeOlderThan": 0,

                      "startCleaningIfLessThan": 0,

                      "archiveReadOnlyFiles": true,

                      "stopCleaningIfupto": 0,

                      "enableArchivingWithRules": true

                    }

                  },

                  "content": [

                    {

                      "path": "string",

                      "excludePath": "string"

                    }

                  ],

                  "commonProperties": {

                    "storageDevice": {

                      "softwareCompression": 0,

                      "deDuplicationOptions": {

                        "enableDeduplication": true,

                        "generateSignature": 0

                      }

                    }

                  }

                }

              ]

            }

          }

        ]

      }

    },

    "options": {

      "edgeDriveQuota": 0,

      "quota": 0

    },

    "summary": {

      "description": "string",

      "restrictions": 0,

      "type": 0,

      "slaInterval": 0,

      "rpoInMinutes": 0,

      "subtype": 0,

      "planOwner": {

        "userGUID": "string",

        "userName": "string",

        "userId": 0

      },

      "plan": {

        "planName": "string"

      }

    },

    "alerts": {

      "alerts": [

        {

          "alertName": "string",

          "alertId": 0

        }

      ]

    },

    "schedule": {

      "task": {

        "taskType": 0,

        "taskFlags": {

          "isEdgeDrive": true,

          "isEZOperation": true,

          "disabled": true

        }

      },

      "subTasks": [

        {

          "subTask": {

            "subTaskName": "string",

            "subTaskType": 0,

            "flags": 0,

            "operationType": 0,

            "subTaskId": 0

          },

          "pattern": {

            "freq_subday_interval": 0,

            "freq_type": 0,

            "active_end_time": 0,

            "name": "string",

            "freq_recurrence_factor": 0

          },

          "options": {

            "backupOpts": {

              "backupLevel": 0,

              "incLevel": 0,

              "runIncrementalBackup": true,

              "cdrOptions": {

                "incremental": true

              },

              "dataOpt": {

                "useCatalogServer": true,

                "followMountPoints": true,

                "daysBetweenSyntheticBackup": 0,

                "useMultiStream": true,

                "useMaximumStreams": true,

                "enforceTransactionLogUsage": true,

                "skipConsistencyCheck": true,

                "maxNumberOfStreams": 0,

                "createNewIndex": true,

                "autoCopy": true

              },

              "truncateLogsOnSource": true,

              "doNotTruncateLog": true,

              "vsaBackupOptions": {

                "backupFailedVMsOnly": true

              }

            },

            "commonOpts": {

              "automaticSchedulePattern": {

                "maxBackupInterval": 0,

                "ignoreOpWindowPastMaxInterval": true,

                "minBackupIntervalMinutes": 0,

                "maxBackupIntervalMinutes": 0,

                "minSyncInterval": 0,

                "minBackupInterval": 0,

                "minSyncIntervalMinutes": 0,

                "stopIfOnBattery": {

                  "enabled": true

                },

                "acPower": {

                  "enabled": true

                },

                "specfificNetwork": {

                  "enabled": true,

                  "ipAddress": {

                    "subnet": 0,

                    "address": "string"

                  }

                },

                "stopSleepIfBackUp": {

                  "enabled": true

                },

                "newOrModifiedFile": {

                  "enabled": true

                },

                "wiredNetworkConnection": {

                  "enabled": true

                },

                "minNetworkBandwidth": {

                  "enabled": true

                }

              }

            }

          }

        }

      ]

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/v2/Plan' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "featureInfo": {
      "edgedriveInfo": {
        "enableNotificationsForShares": true,
        "auditDriveActivities": true,
        "edgeDriveAssociations": {
          "indexServer": {
            "clientId": 0,
            "clientName": "string"
          }
        }
      }
    },
    "inheritance": {
      "isSealed": true
    },
    "storage": {
      "storagePolicy": {},
      "copy": [
        {
          "active": 0,
          "isDefault": 0,
          "dedupeFlags": {
            "enableDASHFull": 0,
            "useGlobalDedupStore": 0,
            "enableDeduplication": 0,
            "enableClientSideDedup": 0
          },
          "storagePolicyFlags": {
            "blockLevelDedup": 0
          },
          "retentionRules": {
            "retainBackupDataForDays": 0,
            "retentionFlags": {
              "enableDataAging": 0
            }
          },
          "useGlobalPolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          }
        }
      ]
    },
    "laptop": {
      "features": {
        "categoryPermission": {
          "categoriesPermissionList": [
            {
              "permissionId": 0,
              "permissionName": "string",
              "_type_": 0
            }
          ]
        }
      },
      "content": {
        "backupContent": [
          {
            "idatype": 0,
            "subClientPolicy": {
              "backupSetEntity": {
                "backupsetName": "string"
              },
              "subClientList": [
                {
                  "contentOperationType": 0,
                  "fsSubClientProp": {
                    "useVSSForSystemState": true,
                    "backupRetention": true,
                    "backupSystemState": true,
                    "afterDeletionKeepItemsForNDays": 0,
                    "extendRetentionForNDays": 0,
                    "archiverRetentionMode": 0,
                    "enableOnePass": true,
                    "useVSS": true,
                    "extendStoragePolicyRetention": true,
                    "keepAtLeastPreviousVersions": 0,
                    "catalogACL": true,
                    "archiverRetention": true,
                    "olderFileVersionsMode": 0,
                    "backupRetentionMode": 0,
                    "backupSystemStateforFullBkpOnly": true,
                    "keepVersions": 0,
                    "scanOption": 0,
                    "keepOlderVersionsForNDays": 0,
                    "diskCleanupRules": {
                      "fileModifiedTimeOlderThan": 0,
                      "fileSizeGreaterThan": 0,
                      "afterArchivingRule": 0,
                      "fileCreatedTimeOlderThan": 0,
                      "maximumFileSize": 0,
                      "fileAccessTimeOlderThan": 0,
                      "startCleaningIfLessThan": 0,
                      "archiveReadOnlyFiles": true,
                      "stopCleaningIfupto": 0,
                      "enableArchivingWithRules": true
                    }
                  },
                  "content": [
                    {
                      "path": "string",
                      "excludePath": "string"
                    }
                  ],
                  "commonProperties": {
                    "storageDevice": {
                      "softwareCompression": 0,
                      "deDuplicationOptions": {
                        "enableDeduplication": true,
                        "generateSignature": 0
                      }
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "options": {
      "edgeDriveQuota": 0,
      "quota": 0
    },
    "summary": {
      "description": "string",
      "restrictions": 0,
      "type": 0,
      "slaInterval": 0,
      "rpoInMinutes": 0,
      "subtype": 0,
      "planOwner": {
        "userGUID": "string",
        "userName": "string",
        "userId": 0
      },
      "plan": {
        "planName": "string"
      }
    },
    "alerts": {
      "alerts": [
        {
          "alertName": "string",
          "alertId": 0
        }
      ]
    },
    "schedule": {
      "task": {
        "taskType": 0,
        "taskFlags": {
          "isEdgeDrive": true,
          "isEZOperation": true,
          "disabled": true
        }
      },
      "subTasks": [
        {
          "subTask": {
            "subTaskName": "string",
            "subTaskType": 0,
            "flags": 0,
            "operationType": 0,
            "subTaskId": 0
          },
          "pattern": {
            "freq_subday_interval": 0,
            "freq_type": 0,
            "active_end_time": 0,
            "name": "string",
            "freq_recurrence_factor": 0
          },
          "options": {
            "backupOpts": {
              "backupLevel": 0,
              "incLevel": 0,
              "runIncrementalBackup": true,
              "cdrOptions": {
                "incremental": true
              },
              "dataOpt": {
                "useCatalogServer": true,
                "followMountPoints": true,
                "daysBetweenSyntheticBackup": 0,
                "useMultiStream": true,
                "useMaximumStreams": true,
                "enforceTransactionLogUsage": true,
                "skipConsistencyCheck": true,
                "maxNumberOfStreams": 0,
                "createNewIndex": true,
                "autoCopy": true
              },
              "truncateLogsOnSource": true,
              "doNotTruncateLog": true,
              "vsaBackupOptions": {
                "backupFailedVMsOnly": true
              }
            },
            "commonOpts": {
              "automaticSchedulePattern": {
                "maxBackupInterval": 0,
                "ignoreOpWindowPastMaxInterval": true,
                "minBackupIntervalMinutes": 0,
                "maxBackupIntervalMinutes": 0,
                "minSyncInterval": 0,
                "minBackupInterval": 0,
                "minSyncIntervalMinutes": 0,
                "stopIfOnBattery": {
                  "enabled": true
                },
                "acPower": {
                  "enabled": true
                },
                "specfificNetwork": {
                  "enabled": true,
                  "ipAddress": {
                    "subnet": 0,
                    "address": "string"
                  }
                },
                "stopSleepIfBackUp": {
                  "enabled": true
                },
                "newOrModifiedFile": {
                  "enabled": true
                },
                "wiredNetworkConnection": {
                  "enabled": true
                },
                "minNetworkBandwidth": {
                  "enabled": true
                }
              }
            }
          }
        }
      ]
    }
  }
}'