Skip to main content

Create Archive Plan​

Select

SaaS
Customer Managed

Create Archive Plan

Request Body
  • planName string required
  • backupDestinations object[]
  • backupDestinationName string required

    Backup destination details. Enter the name during creation.

  • storagePool object required
  • id int32
  • name string
  • region object
  • id int32
  • name string
  • sourceCopy object
  • id int32
  • name string
  • retentionPeriodDays int32

    Possible values: >= 1 and <= 9999

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

  • overrideRetentionSettings boolean

    Tells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy.

  • 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.

  • archiveFrequency object

    Used to describe the frequency of backup

  • scheduleFrequencyType string

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

    Default value: DAILY

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Default value: 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]

  • startTime int32

    Default value: 75600

    start time of schedule in seconds for daily, weekly, monthly, yearly frequency

  • archiveWindow object[]

    Archive job will run only in the specified archive window

  • 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

  • archivingRules object

    Files which meet both time stamp and file size rules will be archived

  • fileTimestampMethod string

    Possible values: [LAST_ACCESSED, LAST_MODIFIED]

    Default value: LAST_MODIFIED

  • fileTimestamp int32

    Default value: 90

    To archive files based on the last accessed or modified date of each file within the folder, specify the number of days. Should be supplied with fileTimestampMethod.

  • fileSize int32

    Default value: 1

    To archive files based on the size of the file, specify the minimum file size in KB.

  • afterArchiving

    Possible values: [REPLACE_FILE_WITH_STUB, DELETE_THE_FILE]

    After an archive job, replace the file that meets the archiving rules with a stub or delete the file that meets the archiving rules

  • allowPlanOverride boolean

    Default value: false

    Flag to enable overriding of plan. Plan cannot be overriden by default.

  • overrideRestrictions object

    To allow the derived plans that use this plan as the base plan to override the settings, property allowPlanOverride must be true, and then select one of the options for Storage pool, RPO and Archiving rules.

  • storagePool string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • RPO string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • archivingRules string

    Possible values: [OPTIONAL, MUST, NOT_ALLOWED]

  • parentPlan object
  • id int32
  • name string
Responses

OK

Schema
  • plan object
  • id int32
  • GUID string
  • name string
  • errors object[]
  • component string

    Plan Entity for which error occured

  • errorCode int32

    Error Code for plan

  • errorMessage string

    Error message for plan

POST /v4/archiveplan

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "planName": "string",

  "backupDestinations": [

    {

      "backupDestinationName": "string",

      "storagePool": {

        "id": 0,

        "name": "string"

      },

      "region": {

        "id": 0,

        "name": "string"

      },

      "sourceCopy": {

        "id": 0,

        "name": "string"

      },

      "retentionPeriodDays": 0,

      "overrideRetentionSettings": true

    }

  ],

  "rpo": {

    "archiveFrequency": {

      "scheduleFrequencyType": "DAILY",

      "frequency": 1,

      "weeklyDays": [

        "SUNDAY"

      ],

      "dayOfMonth": 0,

      "weekOfMonth": "FIRST",

      "dayOfWeek": "SUNDAY",

      "monthOfYear": "JANUARY",

      "startTime": 75600

    },

    "archiveWindow": [

      {

        "dayOfWeek": [

          "SUNDAY"

        ],

        "startTime": 0,

        "endTime": 0

      }

    ]

  },

  "archivingRules": {

    "fileTimestampMethod": "LAST_MODIFIED",

    "fileTimestamp": 90,

    "fileSize": 1,

    "afterArchiving": "REPLACE_FILE_WITH_STUB"

  },

  "allowPlanOverride": false,

  "overrideRestrictions": {

    "storagePool": "OPTIONAL",

    "RPO": "OPTIONAL",

    "archivingRules": "OPTIONAL"

  },

  "parentPlan": {

    "id": 0,

    "name": "string"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ArchivePlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "planName": "string",
  "backupDestinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "rpo": {
    "archiveFrequency": {
      "scheduleFrequencyType": "DAILY",
      "frequency": 1,
      "weeklyDays": [
        "SUNDAY"
      ],
      "dayOfMonth": 0,
      "weekOfMonth": "FIRST",
      "dayOfWeek": "SUNDAY",
      "monthOfYear": "JANUARY",
      "startTime": 75600
    },
    "archiveWindow": [
      {
        "dayOfWeek": [
          "SUNDAY"
        ],
        "startTime": 0,
        "endTime": 0
      }
    ]
  },
  "archivingRules": {
    "fileTimestampMethod": "LAST_MODIFIED",
    "fileTimestamp": 90,
    "fileSize": 1,
    "afterArchiving": "REPLACE_FILE_WITH_STUB"
  },
  "allowPlanOverride": false,
  "overrideRestrictions": {
    "storagePool": "OPTIONAL",
    "RPO": "OPTIONAL",
    "archivingRules": "OPTIONAL"
  },
  "parentPlan": {
    "id": 0,
    "name": "string"
  }
}'