Archive strategies

>>>

GET /api/v1/archive_strategies
Display a list of all archive strategies.

>>>

GET /api/v1/archive_strategies/:id
Display an archive strategy.

Params

Param name Description
id
required

ID of the archive strategy to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/archive_strategies
Create a new archive strategy.

Params

Param name Description
archive_strategy
optional , nil allowed

Validations:

  • Must be a Hash
archive_strategy[name]
required

The name of a strategy.

Validations:

  • Must be a String
archive_strategy[destination]
required

The destination path of archived/copied data.

Validations:

  • Must be a String
archive_strategy[format]
required

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

Validations:

  • Must be a String
archive_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
archive_strategy[enabled]
optional , nil allowed
true | false

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

Validations:

  • Must be a String
archive_strategy[includes]
required

A string specifying the inclusion scope of a strategy. It indicates whether to include direct subprojects, transitive subprojects or none of them. Available values: [none | direct | transitive].

Validations:

  • Must be a String
archive_strategy[transmission_check]
required
sha2 | crc | fingerprint | md5 | none

The method of data verification for a strategy.

Validations:

  • Must be a String
>>>

PUT /api/v1/archive_strategies/:id
Update an archive strategy.

Params

Param name Description
id
required

ID of the archive strategy to be updated.

Validations:

  • Must be a String
archive_strategy
optional , nil allowed

Validations:

  • Must be a Hash
archive_strategy[name]
optional

The name of a strategy.

Validations:

  • Must be a String
archive_strategy[destination]
optional

The destination path of archived/copied data.

Validations:

  • Must be a String
archive_strategy[format]
optional

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

Validations:

  • Must be a String
archive_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
archive_strategy[enabled]
optional , nil allowed
true | false

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

Validations:

  • Must be a String
archive_strategy[includes]
optional

A string specifying the inclusion scope of a strategy. It indicates whether to include direct subprojects, transitive subprojects or none of them. Available values: [none | direct | transitive].

Validations:

  • Must be a String
archive_strategy[transmission_check]
optional
sha2 | crc | fingerprint | md5 | none

The method of data verification for a strategy.

Validations:

  • Must be a String
>>>

GET /api/v1/archive_strategies/configuration
Get list of possible third party archive configurations.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.