snapshot-schedule

Schedule automatic snapshots for CephFS and RBD.

get /snapshot-schedule/rbd

Get all RBD snapshot jobs.

Parameters

pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.

Responses

default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.

Examples

No request body required
post /snapshot-schedule/rbd

Schedule a new RBD snapshot job.

Parameters

body object
Request to create a RBD snapshot schedule.

Examples

Request Body

{
  "cron": "string",
  "paths": [
    {
      "rbd": "string",
      "pool": "string",
      "namespace": "string"
    }
  ],
  "maxSnapshots": 42,
  "snapshotPrefix": "string",
  "disableRbdCheck": true
}
get /snapshot-schedule/cephfs

Get all CephFS snapshot jobs.

Parameters

pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.

Responses

default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.

Examples

No request body required
post /snapshot-schedule/cephfs

Schedule a new CephFS snapshot job.

Parameters

body object
Request to create a CephFS snapshot schedule.

Examples

Request Body

{
  "cron": "string",
  "paths": [
    "string"
  ],
  "maxSnapshots": 42,
  "snapshotPrefix": "string"
}
patch /snapshot-schedule/rbd/{id}

Update the schedule settings of an RBD snapshot job.

Parameters

id integer path Required
The schedule to update.
body object
Request to update the settings of a RBD snapshot schedule.

Examples

Request Body

{
  "cron": "string",
  "paths": [
    {
      "rbd": "string",
      "pool": "string",
      "namespace": "string"
    }
  ],
  "enabled": true,
  "maxSnapshots": 42,
  "snapshotPrefix": "string",
  "disableRbdCheck": true
}
delete /snapshot-schedule/rbd/{id}

Remove an RBD snapshot job.

Parameters

id integer path Required
The schedule to delete.

Responses

default response
default response
boolean

Examples

No request body required
patch /snapshot-schedule/cephfs/{id}

Update the schedule settings of a CephFS snapshot job.

Parameters

id integer path Required
The schedule to update.
body object
Request to update the settings of a CephFS snapshot schedule.

Examples

Request Body

{
  "cron": "string",
  "paths": [
    "string"
  ],
  "enabled": true,
  "maxSnapshots": 42,
  "snapshotPrefix": "string"
}
delete /snapshot-schedule/cephfs/{id}

Remove a CephFS snapshot job.

Parameters

id integer path Required
The schedule to delete.

Responses

default response
default response
boolean

Examples

No request body required