Create Backup Repository

Creates a new Backup Repository.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

This is an example of creating a forever-incremental Backup Repository in a local folder on the assigned Transporter host.

curl

Copy

curl --request POST \
   --url https://<Director_IP_address>:4443/c/router \
   --header "content-type: application/json" \
   --cookie @cookies.txt \
   --data {
       "action": "BackupManagement",
       "method": "create",
       "data": [{
           "dataStorageType": "FOREVER_INCREMENTAL",
           "type": "LOCAL",
           "compression": "FAST",
           "useSelfHealSchedule": false,
           "useConsolidationSchedule": false,
           "useVerificationSchedule": false,
           "useDetachSchedule": false,
           "selfHealOverrideJobs": false,
           "consolidationOverrideJobs": false,
           "verificationOverrideJobs": false,
           "deleteAndRecreateOnAttach": false,
           "changeStatus": "CREATE_PENDING",
           "id": null,
           "state": null,
           "status": null,
           "isAccessible": null,
           "attached": null,
           "consistent": null,
           "licensed": null,
           "name": "test repository",
           "description": "",
           "size": null,
           "free": null,
           "allocated": null,
           "consumed": null,
           "path": "m:\",
           "transporterId": 1,
           "transporterName": null,
           "transporterCaps": null,
           "username": "",
           "password": "",
           "advancedMountOptions": "",
           "backupCount": null,
           "hvTypeBackupCount": null,
           "hvTypeBackupHasRootDiskCount": null,
           "wasDiscoveredOnce": null,
           "wasEdited": null,
           "wasImported": null,
           "wasCreated": null,
           "progress": null,
           "operationStart": null,
           "operationStartRelative": null,
           "transporterLockedExclusive": null,
           "transporterLockReasons": null,
           "lockedExclusive": null,
           "lockedShared": null,
           "lockReasons": null,
           "preventModification": null,
           "compressionRatio": null,
           "deduplication": true,
           "deduplicationRatio": null,
           "selfHeal": true,
           "encryption": false,
           "encryptionPassword": "",
           "autoSize": true,
           "storageSize": 500,
           "chunkSize": 500,
           "volumeType": "sc1",
           "selfHealSchedule": {
               "enabled": true,
               "type": "DAILY",
               "startTime": "11:00:00 AM",
               "timezoneOffsetMs": 7200000,
               "timezone": "EET",
               "on": 127,
               "endTime": null,
               "everyType": null,
               "every": null,
               "monthlyEveryType": null,
               "dayOfMonth": null,
               "dayOfWeek": null,
               "month": null,
               "triggerItem": null,
               "triggerRunType": null,
               "triggerEvents": null,
               "effectiveDate": null,
               "nextRun": null,
               "position": null },
           "verificationSchedule": {
               "enabled": true,
               "type": "DAILY",
               "startTime": "12:00:00 PM",
               "timezoneOffsetMs": 7200000,
               "timezone": "EET",
               "on": 64,
               "endTime": null,
               "everyType": null,
               "every": null,
               "monthlyEveryType": null,
               "dayOfMonth": null,
               "dayOfWeek": null,
               "month": null,
               "triggerItem": null,
               "triggerRunType": null,
               "triggerEvents": null,
               "effectiveDate": null,
               "nextRun": null,
               "position": null },
           "consolidationSchedule": {
               "enabled": true,
               "type": "DAILY",
               "startTime": "12:00:00 PM",
               "timezoneOffsetMs": 7200000,
               "timezone": "EET",
               "on": 32,
               "endTime": null,
               "everyType": null,
               "every": null,
               "monthlyEveryType": null,
               "dayOfMonth": null,
               "dayOfWeek": null,
               "month": null,
               "triggerItem": null,
               "triggerRunType": null,
               "triggerEvents": null,
               "effectiveDate": null,
               "nextRun": null,
               "position": null },
           "detachSchedule": {
               "enabled": true,
               "type": "DAILY",
               "startTime": "6:00:00 PM",
               "timezoneOffsetMs": 7200000,
               "timezone": "EET",
               "on": 127,
               "endTime": null,
               "everyType": null,
               "every": null,
               "monthlyEveryType": null,
               "dayOfMonth": null,
               "dayOfWeek": null,
               "month": null,
               "triggerItem": null,
               "triggerRunType": null,
               "triggerEvents": null,
               "effectiveDate": null,
               "nextRun": null,
               "position": null },
           "attachSchedule": {
               "enabled": true,
               "type": "DAILY",
               "startTime": "12:00:00 AM",
               "timezoneOffsetMs": 7200000,
               "timezone": "EET",
               "on": 127,
               "endTime": null,
               "everyType": null,
               "every": null,
               "monthlyEveryType": null,
               "dayOfMonth": null,
               "dayOfWeek": null,
               "month": null,
               "triggerItem": null,
               "triggerRunType": null,
               "triggerEvents": null,
               "effectiveDate": null,
               "nextRun": null,
               "position": null },
           "alertErrorCode": null,
           "alertTitle": null,
           "alertDescription": null
           }],
       "type": "rpc",
       "tid": 1 }

Request Fields

Field	Type	Value(s)	Description
`action`	string	`BackupManagement`	The action that is invoked
`method`	string	`create`	The method that is invoked
`data`	array		Data of the Backup Repository to be created
`type`	string	`rpc`	Type of communication protocol
`tid`	int	`1`	Transaction ID. Used to identify the request by both the client and the server

Data

Field	Type	Description
`dataStorageType`	string	Data storage type of the Backup Repository. Possible values: `FOREVER_INCREMENTAL, INCREMENTAL_WITH_FULL_BACKUPS, MICROSOFT_OFFICE_365`
`type`	string	Type of the Backup Repository. Possible values: `SHARE, LOCAL, NFS_SHARE, AMAZON_EBS, AMAZON_S3, MICROSOFT_OFFICE_365, WASABI`
`compression`	string	Compression level of the Backup Repository. Possible values: `DISABLED, FAST, MEDIUM, BEST`
`useSelfHealSchedule`	boolean	`true` if self-healing is run on schedule
`useConsolidationSchedule`	boolean	`true` if space reclaiming is run on schedule
`useVerificationSchedule`	boolean	`true` if all backups verification is run on schedule
`useDetachSchedule`	boolean	`true` if backup repository detaching is run on schedule
`selfHealOverrideJobs`	boolean	`true` if scheduled self-healing has higher priority over the running jobs
`consolidationOverrideJobs`	boolean	`true` if scheduled space reclaiming has higher priority over the running jobs
`verificationOverrideJobs`	boolean	`true`if scheduled all backups verification has higher priority over the running jobs
`deleteAndRecreateOnAttach`	boolean	`true`if the Backup Repository is deleted and re-created on a scheduled attaching
`changeStatus`	string	Describes if there are any changes to be applied to the Backup Repository. Possible values: `NONE, CREATE_PENDING, CHANGE_PENDING, IMPORT_PENDING, RECREATE_PENDING`
`id`	integer	Backup Repository ID. For the create method, this field is ignored
`state`	string	Backup Repository state. Possible values: `OK, WARNING, INACCESSIBLE, ERROR`. For the create method, the field is ignored
`status`	string	Backup Repository status. Possible values: `NONE, UPDATING, SELF_HEALING, SPACE_RECLAIM, VERIFY_BACKUPS, STOPPING_SELF_HEALING, STOPPING_SPACE_RECLAIM, STOPPING_VERIFY_BACKUPS`. For the create method, the field is ignored
`isAccessible`	boolean	Checks if the Backup Repository is accessible. For the create method, the field is ignored
`attached`	boolean	Checks if the Backup Repository is attached. For the create method, the field is ignored
`consistent`	boolean	Checks if the Backup Repository is consistent. For the create method, the field is ignored
`licensed`	boolean	Checks if the Backup Repository is licensed. For the create method, the field is ignored
`name`	string	Backup Repository name
`description`	string	Backup Repository description
`size`	int	Size of the Backup Repository in bytes. For the create method, this field is ignored
`free`	int	Size of the Backup Repository free space in bytes. For the create method, this field is ignored
`allocated`	int	Allocated space in the Backup Repository in bytes. For the create method, this field is ignored
`consumed`	int	Consumed space in the Backup Repository in bytes. For the create method, this field is ignored
`path`	string	Path to the Backup Repository
`transporterId`	longint	ID of the assigned Transporter
`transporterName`	string	Name of the assigned Transporter. For the create method, this field is ignored
`transporterCaps`	Map<type, Boolean>	Capabilities of the assigned Transporter. For the create method, this field is ignored
`username`	string	User name for accessing the Backup Repository when the type field is `CIFS_SHARE`
`password`	string	Password for accessing the Backup Repository when the type field is `CIFS_SHARE`
`advancedMountOptions`	string	Advanced options of mounting the Backup Repository when the type field is either of the following: `NFS_SHARE, CIFS_SHARE`. The field is optional
`hvTypeBackupCount`	Map	Count of backups per platform. For the create method, this field is ignored
`hvTypeBackupHasRootDiskCount`	Map	Count of platform-specific backups that have a root disk. For the create method, this field is ignored
`wasDiscoveredOnce`	boolean	Checks if valid data are once got from the Backup Repository. For the create method, this field is ignored
`wasEdited`	boolean	Checks if the Backup Repository was edited. For the create method, this field is ignored
`wasImported`	boolean	Checks if the Backup Repository was imported
`progress`	int	Progress of a running operation when the status field is not NONE. For the create method, this field is ignored
`operationStart`	string	Time when the operation started while the status field is not NONE. For the create method, this field is ignored
`operationStartRelative`	string	Relative time when the operation started while the status field is not NONE. For the create method, this field is ignored
`transporterLockedExclusive`	boolean	Checks if the Transporter is exclusively locked. For the create method, this field is ignored
`transporterLockReasons`	array	Reasons for locking the Transporter. For the create method, this field is ignored
`lockedExclusive`	boolean	Checks if the Backup Repository is exclusively locked. For the create method, this field is ignored
`lockedShared`	boolean	Checks if the Backup Repository is locked by sharing. For the create method, this field is ignored
`lockReasons`	array	Reasons for locking the Backup Repository. For the create method, this field is ignored
`preventModification`	boolean	Checks if the Backup Repository modification is prevented
`compressionRatio`	int	Backup Repository compression ratio. For the create method, this field is ignored
`deduplication`	boolean	`true` if deduplication is enabled for the Backup Repository
`deduplicationRatio`	int	Deduplication ratio of the Backup Repository. For the create method, this field is ignored
`selfHeal`	boolean	Checks if self-healing is enabled
`encryption`	boolean	`true`if encryption is enabled for the Backup Repository
`encryptionPassword`	string	Password for encrypting the Backup Repository
`autoSize`	boolean	`true` if automatic resizing is enabled for the Backup Repository when the type field is AMAZON_EBS
`storageSize`	longint	Backup Repository storage size when the type field is `AMAZON_EBS`
`chunkSize`	longint	Backup Repository chunk storage size when the type field is `AMAZON_EBS`
`volumeType`	string	Backup Repository volume type when the type field is `AMAZON_EBS`
`awsAccountId`	string	AWS account ID - used when the type field is `AMAZON_S3` or `WASABI`
`awsAccountName`	string	AWS account name - used when the type field is `AMAZON_S3` or `WASABI`
`regionId`	string	AWS region ID - used when the type field is `AMAZON_S3` or `WASABI`
`regionName`	string	Aws region name - used when the type field is `AMAZON_S3` or `WASABI`
`bucketId`	string	Bucket id - used when the type field is `AMAZON_S3` or `WASABI`
`bucketName`	string	Bucket name - used when the type field is `AMAZON_S3` or `WASABI`
`selfHealSchedule`	JSON	Data of self-healing schedule
`verificationSchedule`	JSON	Data of verification schedule
`consolidationSchedule`	JSON	Data of consolidation schedule
`detachSchedule`	JSON	Data of detachment schedule
`attachSchedule`	JSON	Data of attachment schedule
`alertErrorCode`	longint	Alert error code when the state field is `INACCESSIBLE` and the `changeStatus` is one of the following: `CREATE_PENDING, CHANGE_PENDING, IMPORT_PENDING`. For the create method, the field is ignored
`alertTitle`	string	Alert title. For the create method, the field is ignored
`alertDescription`	string	Alert description. For the create method, the field is ignored

Schedule Data

Field	Type	Description
`enabled`	boolean	`true` if the schedule is enabled
`type`	string	Schedule type. Possible values: `DAILY, PERIODICALLY, NONE, MONTHLY_YEARLY, TRIGGER`
`startTime`	string	Schedule start time. Out of the day, it is null when on demand. Format: 24-hr, hh:mm:ss a
`timezoneOffsetMs`	integer	Time zone offset in ms. It is set by the server
`timezone`	string	Time zone
`on`	integer	A day mask; a month is the 0th bit, the last Sunday is the 6th bit.
`endTime`	string	Schedule end time. Out of the day, it can be null for a scheduled type with no endTime. Format: 24-hr, hh:mm:ss a
`everyType`	string	Possible values: `MINUTE, HOUR, SECOND, DAY`
`every`	int	For the `PERIODICALLY` and `TRIGGER` types, it specifies a repetition period. For the `TRIGGER` type, it sets the delay for use
`monthlyEveryType`	string	Possible values: `FIRST, SECOND, THIRD, FOURTH, LAST, DAY`
`dayOfMonth`	int	Day of the month the schedule to be run
`dayOfWeek`	int	Weekday the schedule to be run
`month`	int	Month in which the schedule to be run
`triggerItem`	string	VID of the item to monitor (job)
`triggerRunType`	string	Monitored item type. Possible values: `IMMEDIATELY, DELAYED`
`triggerEvents`	array	Events of the monitored item. Possible values: `RUN_SUCCESS, RUN_FAILURE, RUN_STOP`
`effectiveDate`	string	Effective date in the ISO8601 format
`nextRun`	string	Next run set by the server, if available
`position`	int	Position of the schedule

Response Sample

curl

Copy

{
"action": "BackupManagement",
"method": "create",
"tid": "1",
"type": "rpc",
"message": null,
"where": null,
"cause": null,
"data": 1
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	long	ID of the created Backup Repository