snapshot-schedule

Schedule automatic snapshots for CephFS and RBD.
get /snapshot-schedule/rbd

Get all RBD snapshot jobs.

Parameters
pagination string query
Responses
200 successful operation
RbdSnapshotSchedule array
RbdSnapshotSchedule object
Information for an RBD snapshot schedule.
[
  {
    "id": 0,
    "cron": "string",
    "paths": [
      {
        "rbd": "string",
        "pool": "string",
        "namespace": "string"
      }
    ],
    "enabled": true,
    "maxSnapshots": 0,
    "pathsFormatted": "string",
    "snapshotPrefix": "string",
    "failedSnapshots": [
      "string"
    ]
  }
]
post /snapshot-schedule/rbd

Schedule a new RBD snapshot job.

Parameters
body object
Request to create a RBD snapshot schedule.
{
  "cron": "string",
  "paths": [
    {
      "rbd": "string",
      "pool": "string",
      "namespace": "string"
    }
  ],
  "maxSnapshots": 0,
  "snapshotPrefix": "string",
  "disableRbdCheck": true
}
Responses
default successful operation
get /snapshot-schedule/cephfs

Get all CephFS snapshot jobs.

Parameters
pagination string query
Responses
200 successful operation
CephFSSnapshotSchedule array
CephFSSnapshotSchedule object
Object containing all information for an CephFS snapshot schedule.
[
  {
    "id": 0,
    "cron": "string",
    "paths": [
      "string"
    ],
    "enabled": true,
    "maxSnapshots": 0,
    "pathsFormatted": "string",
    "snapshotPrefix": "string",
    "failedSnapshots": [
      "string"
    ]
  }
]
post /snapshot-schedule/cephfs

Schedule a new CephFS snapshot job.

Parameters
body object
Request to create a CephFS snapshot schedule.
{
  "cron": "string",
  "paths": [
    "string"
  ],
  "maxSnapshots": 0,
  "snapshotPrefix": "string"
}
Responses
default successful operation
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.
{
  "cron": "string",
  "paths": [
    {
      "rbd": "string",
      "pool": "string",
      "namespace": "string"
    }
  ],
  "enabled": true,
  "maxSnapshots": 0,
  "snapshotPrefix": "string",
  "disableRbdCheck": true
}
Responses
default successful operation
delete /snapshot-schedule/rbd/{id}

Remove an RBD snapshot job.

Parameters
id integer path Required
The schedule to delete.
Responses
200 successful operation
boolean 
true
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.
{
  "cron": "string",
  "paths": [
    "string"
  ],
  "enabled": true,
  "maxSnapshots": 0,
  "snapshotPrefix": "string"
}
Responses
default successful operation
delete /snapshot-schedule/cephfs/{id}

Remove a CephFS snapshot job.

Parameters
id integer path Required
The schedule to delete.
Responses
200 successful operation
boolean 
true