{
  "id": "snapshots",
  "title": "Node snapshot requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/nodes/snapshots/",
  "summary": "Node snapshot requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-snapshots) | `/v1/nodes/{uid}/snapshots` | Get node snapshots |\n| [DELETE](#delete-snapshot) | `/v1/nodes/{uid}/snapshots/{snapshot_name}` | Delete a node snapshot |\n\n## Get node snapshots {#get-snapshots}\n\n```sh\nGET /v1/nodes/{int: uid}/snapshots\n```\n\nGet all cluster node snapshots of the specified node.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_node_info]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/nodes/1/snapshots\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the node requested. |\n\n### Response {#get-response}\n\nReturns an array of node snapshot JSON objects.\n\n#### Example JSON body\n\n```json\n[\n    {\n        \"created_time\": \"2024-01-10 20:55:54\",\n        \"name\": \"nightly_snapshot_1\",\n        \"node_uid\": \"1\"\n    },\n    {\n        \"created_time\": \"2024-01-11 20:55:54\",\n        \"name\": \"nightly_snapshot_2\",\n        \"node_uid\": \"1\"\n    }\n]\n```\n\n### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Node UID does not exist |\n\n## Delete node snapshot {#delete-snapshot}\n\n```sh\nDELETE /v1/nodes/{int: uid}/snapshots/{snapshot_name}\n```\n\nDelete a cluster node snapshot. Snapshots created by maintenance mode are not deleted.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [update_node]() | admin |\n\n### Request {#delete-request}\n\n#### Example HTTP request\n\n```sh\nDELETE /v1/nodes/1/snapshots/nightly_snapshot_19\n```\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The unique ID of the updated node. |\n| snapshot_name | string | The unique name of the snapshot to delete. |\n\n### Response {#delete-response}\n\nReturns a JSON object that represents the deleted node snapshot.\n\n#### Example JSON body\n\n```json\n{\n    \"created_time\": \"2024-01-11 20:55:54\",\n    \"name\": \"nightly_snapshot_19\",\n    \"node_uid\": \"1\"\n}\n```\n\n#### Status codes {#delete-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n| [403 Forbidden](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4) | Node snapshot is a maintenance snapshot and cannot be deleted |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Node uid does not exist |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Snapshot name does not exist for this node uid |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}