snapshot-schedule

Schedule automatic snapshots for CephFS and RBD.

GET /snapshot-schedule/cephfs

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/snapshot-schedule/cephfs

Response 200

id
integer
optional
The ID of the snapshot schedule.
cron
string
optional
Cron string for the schedule.
enabled
boolean
optional
True if this schedule is enabled.
snapshotPrefix
string
optional
Prefix for the snapshots. The snapshots will be formatted using a millisecond-precision timestamp as "prefix-yyyy-MM-dd.HH:mm:ss.SSS".
maxSnapshots
integer
optional
Number of snapshots to be kept. Older snapshots exceeding this limit will be deleted. All snapshots fitting into the naming format will be considered.
paths
array
optional
List of CephFS directories to be snapshot.
failedSnapshots
array
optional
List of snapshots that couldn't be created.

Example response

[
  {
    "id": 0,
    "cron": "string",
    "enabled": true,
    "snapshotPrefix": "string",
    "maxSnapshots": 0,
    "paths": [
      "string"
    ],
    "failedSnapshots": [
      "string"
    ]
  }
]

POST /snapshot-schedule/cephfs

Parameters

body
object
optional
Request to create a CephFS snapshot schedule.

Endpoint

curl -X POST http://mgmt-node:8080/api/snapshot-schedule/cephfs

Example body

{
  "cephFsName": "string",
  "cron": "string",
  "snapshotPrefix": "string",
  "maxSnapshots": 0,
  "paths": [
    "string"
  ]
}

DELETE /snapshot-schedule/cephfs/{id}

Parameters

id
integer
path
The schedule to delete.

Endpoint

curl -X DELETE http://mgmt-node:8080/api/snapshot-schedule/cephfs/{id}

Response 200

Example response

true

PATCH /snapshot-schedule/cephfs/{id}

Parameters

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

Endpoint

curl -X PATCH http://mgmt-node:8080/api/snapshot-schedule/cephfs/{id}

Example body

{
  "cron": "string",
  "enabled": true,
  "snapshotPrefix": "string",
  "maxSnapshots": 0,
  "paths": [
    "string"
  ]
}

GET /snapshot-schedule/rbd

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/snapshot-schedule/rbd

Response 200

id
integer
optional
The ID of the snapshot schedule.
cron
string
optional
Cron string for the schedule.
enabled
boolean
optional
True if this schedule is enabled.
snapshotPrefix
string
optional
Prefix for the snapshots. The snapshots will be formatted using a timestamp as "prefix-yyyy-MM-dd.HH:mm:ss.SSS".
maxSnapshots
integer
optional
Number of snapshots to be kept. Older snapshots exceeding this limit will be deleted. All snapshots fitting into the naming format will be considered.
paths
array
optional
List of RBD pools and images to be snapshot.
failedSnapshots
array
optional
List of snapshots that couldn't be created.

Example response

[
  {
    "id": 0,
    "cron": "string",
    "enabled": true,
    "snapshotPrefix": "string",
    "maxSnapshots": 0,
    "paths": [
      {
        "pool": "string",
        "namespace": "string",
        "rbd": "string"
      }
    ],
    "failedSnapshots": [
      "string"
    ]
  }
]

POST /snapshot-schedule/rbd

Parameters

body
object
optional
Request to create a RBD snapshot schedule.

Endpoint

curl -X POST http://mgmt-node:8080/api/snapshot-schedule/rbd

Example body

{
  "cron": "string",
  "snapshotPrefix": "string",
  "maxSnapshots": 0,
  "paths": [
    {
      "pool": "string",
      "namespace": "string",
      "rbd": "string"
    }
  ]
}

DELETE /snapshot-schedule/rbd/{id}

Parameters

id
integer
path
The schedule to delete.

Endpoint

curl -X DELETE http://mgmt-node:8080/api/snapshot-schedule/rbd/{id}

Response 200

Example response

true

PATCH /snapshot-schedule/rbd/{id}

Parameters

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

Endpoint

curl -X PATCH http://mgmt-node:8080/api/snapshot-schedule/rbd/{id}

Example body

{
  "cron": "string",
  "enabled": true,
  "snapshotPrefix": "string",
  "maxSnapshots": 0,
  "paths": [
    {
      "pool": "string",
      "namespace": "string",
      "rbd": "string"
    }
  ]
}