| Method | Path | Description |
|---|
| GET | /v1/nodes/{uid}/snapshots | Get node snapshots |
| DELETE | /v1/nodes/{uid}/snapshots/{snapshot_name} | Delete a node snapshot |
Get node snapshots
GET /v1/nodes/{int: uid}/snapshots
Get all cluster node snapshots of the specified node.
Permissions
| Permission name | Roles |
|---|
| view_node_info | admin
cluster_member
cluster_viewer
db_member
db_viewer |
Request
Example HTTP request
| Key | Value | Description |
|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
URL parameters
| Field | Type | Description |
|---|
| uid | integer | The unique ID of the node requested. |
Response
Returns an array of node snapshot JSON objects.
Example JSON body
[
{
"created_time": "2024-01-10 20:55:54",
"name": "nightly_snapshot_1",
"node_uid": "1"
},
{
"created_time": "2024-01-11 20:55:54",
"name": "nightly_snapshot_2",
"node_uid": "1"
}
]
Status codes
Delete node snapshot
DELETE /v1/nodes/{int: uid}/snapshots/{snapshot_name}
Delete a cluster node snapshot. Snapshots created by maintenance mode are not deleted.
Permissions
Request
Example HTTP request
DELETE /nodes/1/snapshots/nightly_snapshot_19
| Key | Value | Description |
|---|
| Host | cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
URL parameters
| Field | Type | Description |
|---|
| uid | integer | The unique ID of the updated node. |
| snapshot_name | string | The unique name of the snapshot to delete. |
Response
Returns a JSON object that represents the deleted node snapshot.
Example JSON body
{
"created_time": "2024-01-11 20:55:54",
"name": "nightly_snapshot_19",
"node_uid": "1"
}
Status codes
