Restore dataset to a previous version

Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op).

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

version_refstringRequired>=1 character

Version hash or tag to restore from

Response

Version restored successfully

idstring or nullformat: "uuid"

dataset_idstring or nullformat: "uuid"

version_hashstring or null

tagslist of strings or null

is_latestboolean or null

Indicates whether this is the latest version of the dataset

version_namestring or null

Sequential version name formatted as 'v1', 'v2', etc.

items_totalinteger or null

Total number of items in this version

items_addedinteger or null

Number of items added since last version

items_modifiedinteger or null

Number of items modified since last version

items_deletedinteger or null

Number of items deleted since last version

change_descriptionstring or null

metadatamap from strings to strings or null

created_atstring or nullformat: "date-time"

created_bystring or null

last_updated_atstring or nullformat: "date-time"

last_updated_bystring or null

1	import requests
2
3	url = "http://localhost:5173/api/v1/private/datasets/id/versions/restore"
4
5	payload = { "version_ref": "string" }
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.post(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"id": "string",
3	"dataset_id": "string",
4	"version_hash": "string",
5	"tags": [
6	"string"
7	],
8	"is_latest": true,
9	"version_name": "string",
10	"items_total": 1,
11	"items_added": 1,
12	"items_modified": 1,
13	"items_deleted": 1,
14	"change_description": "string",
15	"metadata": {},
16	"created_at": "2024-01-15T09:30:00Z",
17	"created_by": "string",
18	"last_updated_at": "2024-01-15T09:30:00Z",
19	"last_updated_by": "string"
20	}

Path parameters

Request

Response

Errors