Skip to main content

Update Plan​

Select

SaaS
Customer Managed

This operation Updates a Plan.

Path Parameters
  • PlanId string required
Request Body required
  • summary object required
  • plan object required
  • planName string required
Responses

OK

Schema
  • plan object
  • summary object
  • slaInMinutes integer
  • restrictions integer
  • type integer
  • planStatusFlag integer
  • numDevices integer
  • subtype integer
  • numUsers integer
  • permissions object[]
  • permissionId integer
  • planOwner object
  • _type_ integer
  • userName string
  • userId integer
  • plan object
  • _type_ integer
  • planName string
  • planId integer
  • definesStorage object
  • definesEntity boolean
  • overrideEntity integer
  • securityAssociations object
  • associations object[]
  • userOrGroup object[]
  • userId integer
  • _type_ integer
  • userName string
  • properties object
  • isCreatorAssociation boolean
  • role object
  • _type_ integer
  • roleId integer
  • roleName string
  • ownerAssociations object
  • featureInfo object
  • edgedriveInfo object
  • definesEdgeDriveInfo object
  • definesEntity boolean
  • overrideEntity integer
  • inheritance object
  • isSealed boolean
  • storage object
  • storagePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • copy object[]
  • copyType integer
  • active integer
  • isDefault integer
  • copyPrecedence integer
  • retentionRules object
  • retainBackupDataForCycles integer
  • jobs integer
  • retainArchiverDataForDays integer
  • retainBackupDataForDays integer
  • StoragePolicyCopy object
  • copyId integer
  • copyName string
  • drivePool object
  • drivePoolName string
  • drivePoolId integer
  • library object
  • libraryName string
  • libraryId integer
  • useGlobalPolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • definesSchedule object
  • definesEntity boolean
  • overrideEntity integer
  • laptop object
  • features object
  • categoryPermission object
  • accessPolicies object
  • categoryPermission object
  • definesAccessPolicies object
  • definesEntity boolean
  • overrideEntity integer
  • content object
  • definesSubclientWin object
  • definesEntity boolean
  • overrideEntity integer
  • definesSubclientMac object
  • definesEntity boolean
  • overrideEntity integer
  • definesSubclientLin object
  • definesEntity boolean
  • overrideEntity integer
  • users object
  • definesFeatures object
  • definesEntity boolean
  • overrideEntity integer
  • alerts object
  • replicationTargets object
  • schedule object
  • task object
  • description string
  • ownerId integer
  • runUserId integer
  • taskType integer
  • ownerName string
  • alertId integer
  • GUID string
  • policyType integer
  • associatedObjects integer
  • taskName string
  • taskId integer
  • securityAssociations object
  • ownerAssociations object
  • originalCC object
  • commCellId integer
  • taskSecurity object
  • associatedUserGroups object[]
  • userGroupId integer
  • _type_ integer
  • userGroupName string
  • ownerCapabilities object
  • createAs object
  • user object
  • user object
  • userName string
  • userId integer
  • taskFlags object
  • isEdgeDrive boolean
  • isEZOperation boolean
  • forDDB boolean
  • uninstalled boolean
  • isSystem boolean
  • disabled boolean
  • task object
  • taskName string
  • taskId integer
  • appGroup object
  • subTasks object[]
  • subTask object
  • subTaskOrder integer
  • subTaskName string
  • subTaskType integer
  • flags integer
  • operationType integer
  • subTaskId integer
  • subTask object
  • subtaskId integer
  • subtaskName string
  • taskId integer
  • pattern object
  • active_end_occurence integer
  • freq_subday_interval integer
  • freq_type integer
  • patternId integer
  • flags integer
  • description string
  • active_end_time integer
  • active_end_date integer
  • skipOccurence integer
  • skipDayNumber integer
  • active_start_time integer
  • freq_restart_interval integer
  • active_start_date integer
  • freq_interval integer
  • freq_relative_interval integer
  • name string
  • freq_recurrence_factor integer
  • calendar object
  • calendarName string
  • calendarId integer
  • timeZone object
  • TimeZoneID integer
  • daysToRun object
  • week integer
  • Friday boolean
  • day integer
  • repeatPattern object[]
  • exception boolean
  • onDayNumber integer
  • onDay integer
  • description string
  • occurrence integer
  • repeatOn integer
  • options object
  • backupOpts object
  • bkpLatestVersion boolean
  • backupLevel integer
  • incLevel integer
  • runIncrementalBackup boolean
  • doNotTruncateLog boolean
  • cdrOptions object
  • incremental boolean
  • dataVerificationOnly boolean
  • full boolean
  • dataOpt object
  • stopWinService boolean
  • stopDhcpService boolean
  • useCatalogServer boolean
  • optimizedBackup boolean
  • followMountPoints boolean
  • bkpFilesProctedByFS boolean
  • granularrecovery boolean
  • verifySynthFull boolean
  • daysBetweenSyntheticBackup integer
  • enforceTransactionLogUsage boolean
  • skipConsistencyCheck boolean
  • createNewIndex boolean
  • autoCopy boolean
  • nasOptions object
  • snapShotType integer
  • backupQuotas boolean
  • vaultTrackerOpt object
  • mediaStatus object
  • bad boolean
  • overwriteProtected boolean
  • full boolean
  • mediaOpt object
  • numberofDays integer
  • retentionJobType integer
  • waitForInlineBackupResources boolean
  • allowOtherSchedulesToUseMediaSet boolean
  • truncateLogsOnSource boolean
  • sybaseSkipFullafterLogBkp boolean
  • vsaBackupOptions object
  • backupFailedVMsOnly boolean
  • commonOpts object
  • jobRetryOpts object
  • runningTime object
  • totalRunningTime integer
  • perfJobOpts object
  • database object
  • slaInMinutes integer
  • scheduleLog object
  • task object
  • storageLog object
  • storagePolicy object
  • definesScheduleLog object
  • definesEntity boolean
  • overrideEntity integer
  • definesStorageLog object
  • definesEntity boolean
  • overrideEntity integer
  • definesAlerts object
  • definesEntity boolean
  • overrideEntity integer
  • eDiscoveryInfo object
  • definesContentAnalyzerCloud object
  • definesEntity boolean
  • overrideEntity integer
  • definesAnalyticsEngineCloud object
  • definesEntity boolean
  • overrideEntity integer
  • options object
  • forcedArchiving boolean
  • quota integer
  • exchange object
  • definesMBRetention object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBCleanup object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBArchiving object
  • definesEntity boolean
  • overrideEntity integer
  • definesMBJournal object
  • definesEntity boolean
  • overrideEntity integer
  • definition object
  • possible integer[]
  • required integer[]
  • errors object[]
  • entity object
  • status object
  • errorMessage string
  • errorCode integer
PUT /v2/plan/:planid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "summary": {

    "plan": {

      "planName": "Updated Plan Name"

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/v2/Plan/:PlanId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "summary": {
    "plan": {
      "planName": "Updated Plan Name"
    }
  }
}'