Creates a new Backup Repository.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
This is an example of creating a forever-incremental Backup Repository in a local folder on the assigned Transporter host.
Request Fields
Field | Type | Value(s) | Description |
---|---|---|---|
action | string |
| The action that is invoked |
method | string |
| The method that is invoked |
data | array |
| Data of the Backup Repository to be created |
type | string |
| Type of communication protocol |
tid | int |
| Transaction ID. Used to identify the request by both the client and the server |
Data
Field | Type | Description |
| string | Data storage type of the Backup Repository. Possible values: |
| string | Type of the Backup Repository. Possible values: |
| string | Compression level of the Backup Repository. Possible values: |
| boolean |
|
| boolean |
|
| boolean |
|
| boolean |
|
| boolean |
|
| boolean |
|
| boolean |
|
| boolean |
|
| string | Describes if there are any changes to be applied to the Backup Repository. Possible values: |
| integer | Backup Repository ID. For the create method, this field is ignored |
| string | Backup Repository state. Possible values: |
| string | Backup Repository status. Possible values: |
| boolean | Checks if the Backup Repository is accessible. For the create method, the field is ignored |
| boolean | Checks if the Backup Repository is attached. For the create method, the field is ignored |
| boolean | Checks if the Backup Repository is consistent. For the create method, the field is ignored |
| boolean | Checks if the Backup Repository is licensed. For the create method, the field is ignored |
| string | Backup Repository name |
| string | Backup Repository description |
| int | Size of the Backup Repository in bytes. For the create method, this field is ignored |
| int | Size of the Backup Repository free space in bytes. For the create method, this field is ignored |
| int | Allocated space in the Backup Repository in bytes. For the create method, this field is ignored |
| int | Consumed space in the Backup Repository in bytes. For the create method, this field is ignored |
| string | Path to the Backup Repository |
| longint | ID of the assigned Transporter |
| string | Name of the assigned Transporter. For the create method, this field is ignored |
| Map<type, Boolean> | Capabilities of the assigned Transporter. For the create method, this field is ignored |
| string | User name for accessing the Backup Repository when the type field is |
| string | Password for accessing the Backup Repository when the type field is |
| string | Advanced options of mounting the Backup Repository when the type field is either of the following: |
| Map | Count of backups per platform. For the create method, this field is ignored |
| Map | Count of platform-specific backups that have a root disk. For the create method, this field is ignored |
| boolean | Checks if valid data are once got from the Backup Repository. For the create method, this field is ignored |
| boolean | Checks if the Backup Repository was edited. For the create method, this field is ignored |
| boolean | Checks if the Backup Repository was imported |
| int | Progress of a running operation when the status field is not NONE. For the create method, this field is ignored |
| string | Time when the operation started while the status field is not NONE. For the create method, this field is ignored |
| string | Relative time when the operation started while the status field is not NONE. For the create method, this field is ignored |
| boolean | Checks if the Transporter is exclusively locked. For the create method, this field is ignored |
| array | Reasons for locking the Transporter. For the create method, this field is ignored |
| boolean | Checks if the Backup Repository is exclusively locked. For the create method, this field is ignored |
| boolean | Checks if the Backup Repository is locked by sharing. For the create method, this field is ignored |
| array | Reasons for locking the Backup Repository. For the create method, this field is ignored |
| boolean | Checks if the Backup Repository modification is prevented |
| int | Backup Repository compression ratio. For the create method, this field is ignored |
| boolean |
|
| int | Deduplication ratio of the Backup Repository. For the create method, this field is ignored |
| boolean | Checks if self-healing is enabled |
| boolean |
|
| string | Password for encrypting the Backup Repository |
| boolean |
|
| longint | Backup Repository storage size when the type field is |
| longint | Backup Repository chunk storage size when the type field is |
| string | Backup Repository volume type when the type field is |
| string | AWS account ID - used when the type field is |
| string | AWS account name - used when the type field is |
| string | AWS region ID - used when the type field is |
| string | Aws region name - used when the type field is |
| string | Bucket id - used when the type field is |
| string | Bucket name - used when the type field is |
| JSON | Data of self-healing schedule |
| JSON | Data of verification schedule |
| JSON | Data of consolidation schedule |
| JSON | Data of detachment schedule |
| JSON | Data of attachment schedule |
| longint | Alert error code when the state field is |
| string | Alert title. For the create method, the field is ignored |
| string | Alert description. For the create method, the field is ignored |
Schedule Data
Field | Type | Description |
| boolean |
|
| string | Schedule type. Possible values: |
| string | Schedule start time. Out of the day, it is null when on demand. Format: 24-hr, hh:mm:ss a |
| integer | Time zone offset in ms. It is set by the server |
| string | Time zone |
| integer | A day mask; a month is the 0th bit, the last Sunday is the 6th bit. |
| 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 |
| string | Possible values: |
| int | For the |
| string | Possible values: |
| int | Day of the month the schedule to be run |
| int | Weekday the schedule to be run |
| int | Month in which the schedule to be run |
| string | VID of the item to monitor (job) |
| string | Monitored item type. Possible values: |
| array | Events of the monitored item. Possible values: |
| string | Effective date in the ISO8601 format |
| string | Next run set by the server, if available |
| int | Position of the schedule |
Response Sample
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 |
| long | ID of the created Backup Repository |