Skip to main content

Update the object store plan​

Select

SaaS
Customer Managed

Used to modify an exsiting ObjectStore plan

Path Parameters
  • planId int32 required

    Id of the Plan to update

Request Body
  • name string

    New plan name to update

  • backupDestinations object[]

    Copy destinations for the plan. Specify where you want to store your data.

  • planBackupDestinationId int32

    Id of the backup destination to modify/delete

  • planBackupDestinationName string

    Backup Destination Name for add/modify operation

  • storagePool object
  • id int32
  • name string
  • storageType StorageType

    Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]

  • retentionPeriodDays int32

    Possible values: >= 1 and <= 9999

    Retention period in days. -1 can be specified for infinite retention.

  • useExtendedRetentionRules boolean

    Use extended retention rules(not applicable to the Primary(Snap) copy)

  • extendedRetentionRules object

    If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.

  • firstExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • secondExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • thirdExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED, MANUAL_JOBS]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • enableDataAging boolean

    enable or disable Datat aging on the backup destiantion

  • sourceCopy object
  • id int32
  • name string
  • backupDestinationOperationType string

    Possible values: [ADD, MODIFY, OVERWRITE, DELETE]

    Operation type for backup destination

  • rpo object

    Recovery Point Objective (RPO) is the maximum amount of time that data can be lost during a service disruption. Your RPO determines the frequency of your backup jobs.

  • backupFrequency object
  • schedules object[]
  • scheduleId int32

    Id of the schedule if available, required for modifying, deleting schedule

  • scheduleName string

    Name of the schedule, for modify

  • policyId int32

    Schedule policy Id to which the schedule belongs

  • scheduleOperation string

    Possible values: [ADD, DELETE, MODIFY]

    Default value: MODIFY

    Operation being performed on schedule

  • schedulePattern object required

    Used to describe when the schedule runs

  • scheduleFrequencyType string required

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY, AUTOMATIC]

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months

  • weeklyDays string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week for weekly frequency

  • dayOfMonth int32

    Possible values: >= 1 and <= 31

    Day on which to run the schedule, applicable for monthly, yearly

  • weekOfMonth string

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    Specific week of a month

  • dayOfWeek string

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

  • monthOfYear string

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

  • repeatIntervalInMinutes int32

    Possible values: >= 1

    How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types.

  • repeatUntilTime int32

    Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes

  • timezone object
  • id int32
  • name string
  • startTime int32

    Default value: 75600

    start time of schedule in seconds

  • startDate int32

    start date of schedule in epoch format

  • endDate int32

    Schedule end date in epoch format

  • noOfTimes int32

    The number of times you want the schedule to run.

  • exceptions object[]

    Exceptions to when a schedule should not run, either in dates or week of month and days

  • onDates int32[]

    Possible values: >= 1 and <= 31

    list of dates in a month. For ex: 1, 20

  • onWeekOfTheMonth string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    On which week of month, for ex: FIRST, LAST

  • onDayOfTheWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

    On which days, for ex: MONDAY, FRIDAY

  • daysBetweenSyntheticFulls int32

    Possible values: >= 6

    No of days between two synthetic full jobs

  • maxBackupIntervalInMins int32

    Default value: 240

    The number of mins to force a backup on automatic schedule.

  • calendarId int32

    Default value: 1

    Custom Calendar Id for the schedule

  • calendarName string

    Custom Calendar name for the schedule

  • jobStaggerDurationInMins int32

    Specifies the duration in minutes of how long scheduled jobs can be spread. Applicable for daily, weekly, monthly and yearly frequency types. Value of 0 means job staggering is disabled.

  • operationType string

    Possible values: [ADD, MODIFY, DELETE, NONE, OVERWRITE]

    Operation type for the list

  • fullBackupWindow object[]

    Backup window for full backup

  • dayOfWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

  • startTime int64

    Time in seconds since the beginning of the day

  • endTime int64

    Time in seconds since the beginning of the day

  • SLA object

    A server meets SLA (Service Level Agreement) when all of its subclients have at least one successful backup during the number of days specified at the CommCell, Server Group or plan level.

  • useSystemDefaultSLA boolean

    Flag to set to use System Default Service Level Agreement

  • SLAPeriod int32

    SLA Period in Days

  • excludeFromSLA boolean

    Flag to set to exclude plan from SLA

  • enableAfterDelay int32

    Time provided in Unix format. Give 0 to reset any existing delay.

  • exclusionReason string

    Reason for exclusion from SLA

  • logSLAMinutes int32

    Database log SLA period in Minutes

Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/objectstoreplan/:planid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "name": "string",

  "backupDestinations": [

    {

      "planBackupDestinationId": 0,

      "planBackupDestinationName": "string",

      "storagePool": {

        "id": 0,

        "name": "string"

      },

      "storageType": "ALL",

      "retentionPeriodDays": 0,

      "useExtendedRetentionRules": true,

      "extendedRetentionRules": {

        "firstExtendedRetentionRule": {

          "isInfiniteRetention": true,

          "retentionPeriodDays": 0,

          "type": "All_JOBS"

        },

        "secondExtendedRetentionRule": {

          "isInfiniteRetention": true,

          "retentionPeriodDays": 0,

          "type": "All_JOBS"

        },

        "thirdExtendedRetentionRule": {

          "isInfiniteRetention": true,

          "retentionPeriodDays": 0,

          "type": "All_JOBS"

        }

      },

      "enableDataAging": true,

      "sourceCopy": {

        "id": 0,

        "name": "string"

      }

    }

  ],

  "backupDestinationOperationType": "ADD",

  "rpo": {

    "backupFrequency": {

      "schedules": [

        {

          "scheduleId": 0,

          "scheduleName": "string",

          "policyId": 0,

          "scheduleOperation": "MODIFY",

          "schedulePattern": {

            "scheduleFrequencyType": "MINUTES",

            "frequency": 0,

            "weeklyDays": [

              "SUNDAY"

            ],

            "dayOfMonth": 0,

            "weekOfMonth": "FIRST",

            "dayOfWeek": "SUNDAY",

            "monthOfYear": "JANUARY",

            "repeatIntervalInMinutes": 0,

            "repeatUntilTime": 0,

            "timezone": {

              "id": 0,

              "name": "string"

            },

            "startTime": 75600,

            "startDate": 0,

            "endDate": 0,

            "noOfTimes": 0,

            "exceptions": [

              {

                "onDates": [

                  0

                ],

                "onWeekOfTheMonth": [

                  "FIRST"

                ],

                "onDayOfTheWeek": [

                  "SUNDAY"

                ]

              }

            ],

            "daysBetweenSyntheticFulls": 0,

            "maxBackupIntervalInMins": 240,

            "calendarId": 1,

            "calendarName": "string",

            "jobStaggerDurationInMins": 0

          }

        }

      ],

      "operationType": "ADD"

    },

    "fullBackupWindow": [

      {

        "dayOfWeek": [

          "SUNDAY"

        ],

        "startTime": 0,

        "endTime": 0

      }

    ],

    "SLA": {

      "useSystemDefaultSLA": true,

      "SLAPeriod": 0,

      "excludeFromSLA": true,

      "enableAfterDelay": 0,

      "exclusionReason": "string",

      "logSLAMinutes": 0

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/ObjectStorePlan/:planId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "backupDestinations": [
    {
      "planBackupDestinationId": 0,
      "planBackupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "storageType": "ALL",
      "retentionPeriodDays": 0,
      "useExtendedRetentionRules": true,
      "extendedRetentionRules": {
        "firstExtendedRetentionRule": {
          "isInfiniteRetention": true,
          "retentionPeriodDays": 0,
          "type": "All_JOBS"
        },
        "secondExtendedRetentionRule": {
          "isInfiniteRetention": true,
          "retentionPeriodDays": 0,
          "type": "All_JOBS"
        },
        "thirdExtendedRetentionRule": {
          "isInfiniteRetention": true,
          "retentionPeriodDays": 0,
          "type": "All_JOBS"
        }
      },
      "enableDataAging": true,
      "sourceCopy": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "backupDestinationOperationType": "ADD",
  "rpo": {
    "backupFrequency": {
      "schedules": [
        {
          "scheduleId": 0,
          "scheduleName": "string",
          "policyId": 0,
          "scheduleOperation": "MODIFY",
          "schedulePattern": {
            "scheduleFrequencyType": "MINUTES",
            "frequency": 0,
            "weeklyDays": [
              "SUNDAY"
            ],
            "dayOfMonth": 0,
            "weekOfMonth": "FIRST",
            "dayOfWeek": "SUNDAY",
            "monthOfYear": "JANUARY",
            "repeatIntervalInMinutes": 0,
            "repeatUntilTime": 0,
            "timezone": {
              "id": 0,
              "name": "string"
            },
            "startTime": 75600,
            "startDate": 0,
            "endDate": 0,
            "noOfTimes": 0,
            "exceptions": [
              {
                "onDates": [
                  0
                ],
                "onWeekOfTheMonth": [
                  "FIRST"
                ],
                "onDayOfTheWeek": [
                  "SUNDAY"
                ]
              }
            ],
            "daysBetweenSyntheticFulls": 0,
            "maxBackupIntervalInMins": 240,
            "calendarId": 1,
            "calendarName": "string",
            "jobStaggerDurationInMins": 0
          }
        }
      ],
      "operationType": "ADD"
    },
    "fullBackupWindow": [
      {
        "dayOfWeek": [
          "SUNDAY"
        ],
        "startTime": 0,
        "endTime": 0
      }
    ],
    "SLA": {
      "useSystemDefaultSLA": true,
      "SLAPeriod": 0,
      "excludeFromSLA": true,
      "enableAfterDelay": 0,
      "exclusionReason": "string",
      "logSLAMinutes": 0
    }
  }
}'