Backup strategies

>>>

GET /api/v1/backup_strategies
Display a list of all backup strategies.

>>>

GET /api/v1/backup_strategies/:id
Display a backup strategy.

Params

Param name Description
id
required

ID of the backup strategy to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/backup_strategies
Create a new backup strategy.

Params

Param name Description
backup_strategy
optional , nil allowed

Validations:

  • Must be a Hash
backup_strategy[name]
required

The name of a strategy.

Validations:

  • Must be a String
backup_strategy[destination]
required

The destination path of archived/copied data.

Validations:

  • Must be a String
backup_strategy[format]
required

[tarball | zipball | plain | archiware | pixstor | kumulate | cloud]. The format of archived/copied data.

Validations:

  • Must be a String
backup_strategy[admin_only]
required

Indicates whether a archived/copying strategy can be used only by administrators or all users. Available values: [true | false]. Default value: true

Validations:

  • Must be a String
backup_strategy[enabled]
optional , nil allowed
true | false

Indicates whether an archiving strategy is enabled. Default: true.

Validations:

  • Must be a String
backup_strategy[contents]
required
media | project | both

A string specifying the inclusion scope of a strategy regarding the contents. It indicates whether to include only media files, only project files, or both.

Validations:

  • Must be a String
backup_strategy[backup_mode]
required
full | incremental_replace | incremental_preserve

A string indicating whether this strategy should create full snapshots or should only copy files that have changed.

Validations:

  • Must be a String
backup_strategy[automatic]
required
true, false

Indicates whether this backup strategy should be executed automatically in a recurring task. Default: false.

Validations:

  • Must be a String
>>>

PUT /api/v1/backup_strategies/:id
Update a backup strategy.

Params

Param name Description
id
required

ID of the backup strategy to be updated.

Validations:

  • Must be a String
backup_strategy
optional , nil allowed

Validations:

  • Must be a Hash
backup_strategy[name]
optional

The name of a strategy.

Validations:

  • Must be a String
backup_strategy[destination]
optional

The destination path of archived/copied data.

Validations:

  • Must be a String
backup_strategy[format]
optional

[tarball | zipball | plain | archiware | pixstor | kumulate | cloud]. The format of archived/copied data.

Validations:

  • Must be a String
backup_strategy[admin_only]
optional

Indicates whether a archived/copying strategy can be used only by administrators or all users. Available values: [true | false]. Default value: true

Validations:

  • Must be a String
backup_strategy[enabled]
optional , nil allowed
true | false

Indicates whether an archiving strategy is enabled. Default: true.

Validations:

  • Must be a String
backup_strategy[contents]
optional
media | project | both

A string specifying the inclusion scope of a strategy regarding the contents. It indicates whether to include only media files, only project files, or both.

Validations:

  • Must be a String
backup_strategy[backup_mode]
optional
full | incremental_replace | incremental_preserve

A string indicating whether this strategy should create full snapshots or should only copy files that have changed.

Validations:

  • Must be a String
backup_strategy[automatic]
optional
true, false

Indicates whether this backup strategy should be executed automatically in a recurring task. Default: false.

Validations:

  • Must be a String