aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx
blob: 34fd07775580e034065f7df18e3150a9fa7a7785 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
---
id: download-a-backup
title: "Download a backup"
description: "Download backup file"
sidebar_label: "Download a backup"
hide_title: true
hide_table_of_contents: true
api: eJx9VE1v2zAM/SsGTy0gxOnQYYVvKfaBbpdiy7BD4ANjM7Ea21IlOk1q6L8PtJ3PJTvZpijyvcdHt5CTz5y2rE0NCXw2b3VpMI/mmK0aGy10SaCAcekhmcFjF/WQKvCUNU7zFpJZC3NCR27ScAHJLA2pAosOK2JyvkvwWUEVQtICby1BAp6drpeggDZY2VJCmnRebrbL6u3l4ZPZvH8sNswme5D+mruUvv9TDkGBo9dGO8ohYdeQghorSZnvUhRoYWSRCxBEjrw1tScvKD6Mx/I4Jf944BzdvGsbocsKvaZbUJCZmqlmuYTWljpDuRS/ayuhPb0QQlBwP76/Wr02HC1MU+fXi754uXBBNDN/oYxBgXXGkmPdk8lMTv9KGxRU5D0uL52d6DfrKxzy09DzqIgLk0MCS+q6ipQJxL3EPm53Woc4H3wDYgy33o29cSUk0GKeO/I+xGh1vL4DBWt0Gudlj3847iVbYFMyJFAwW5/EMbvtaIUOV0R2hNaCOtN1WlA0VIjMIuKCoh9DftRjgRDCkWN/iax952Pf7jWSzsKjSxNHdUmghpevxlUoCL//mXZC6nph5Lqw7iHdjcaj8ZFt93gmz08X8U+en6KFcafghWxQYI3nCjtDDBbfLykOa3pesz046+pG91yZNhzbEnUtrbpxtcOcZ8MqeVCQHG3VftSpgsJ4lsy2naOn364MQcKvDTn5MaSHQXd2yLWX9xySBZae/oP65ufgztvoGtghiPW281PZyBcoWNH2+DcQ0qCgIMzJdRj640mWkeWji+dLLYbZ2//blykowFObnNmiK34RU9v2GVOzojqEPUSWb8EXwl+BY+PE
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Download a backup"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/backups/{backupId}/download"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Download backup file

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BackupId"},"required":true,"name":"backupId","in":"path"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Backup file (zip archive)","content":{"application/zip":{"schema":{}}}},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>