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: get-a-single-backup
title: "Get a single backup"
description: "Get backup by its id"
sidebar_label: "Get a single backup"
hide_title: true
hide_table_of_contents: true
api: eJytVMGO2zYQ/RVhTi1A2E6RooFubpEG2yBo0G6Rg+HDSBpbXEskQw43dgT+ezGU1uv1aoMccrLMGc689+ZxBmgo1F471tZACe+IiwrrQ3RFdSo0h0I3oIBxH6DcwO85FGCrIFAdveYTlJsBKkJPfh25hXKzTVsFDj32xORDTgh1Sz1COQCfHEEJgb02e1BAR+xdJ0eadNMdT/v+y92b3+zx66/tkdnWb6S/5pwy9r9pICnw9DlqTw2U7CMpMNhLSvWQokALI4fcgiDyFJw1gYKg+GW1kp+n5P+u7qjm4ovm9kGEBhkXoKC2hsmw3EHnOl2j3FneBbk4Q8/mUqDAeevIsx7b6ua5BElBDORv5kMYAvFcTIGJXYeV6CICJAW1J2Rq1jxbKeivdBEwsa/IS6Cy9tCjP/xho+HZjMDIMcxOz8RejOHINONJiHVNIYCCHeoueoJtUkDeW/+BQsA9fQeXJ+PdQPbgJNKjJJeEJ3rXZM7QtylJ0der18/HPpqqMJaLnY2m+XHjrm0zwzYp6F9S4pp5rvCYn2nk+9zaBkrYU+4qHi9hOZo2LIeHR5BEAfL3D88w+g5KGLBpPIWQluj08v4VKLhHr0X/DHsKj0rtMHYMJbTMLpTLJfvT4oAeD0Rugc6BupLztqViqlDYXcEtFe+n/GLEAimliw3yr6g5dr7cI2dppLPwyGnywnOSzDp//Gl9j4Lwr0+3WT9tdlauC+sR0qvFarG6WCNnPOuPN7P41x9vip31T8EL2aTA2cA9Zh9MK0eWJhZBm31H0+K4rjo8WurFHTuyZTry0nWoTd4MMrBhGvBmWm7yuMrzntsqaG1gCQ9DhYH+811Kcvw5kpf9vH2cb3ZBo4N8N1DusAv0Dag//TN58efiJYTTIZpTtlEX5R8oONDpchsn2QItYUM+YxjD67omxxcXn702McrZ7e/e3sr7f2qPKzvk6rOghmHMuLUHMimdMbL8F4Ap/Q8pJ2jm
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={"Get a single backup"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/backups/{backupId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get backup by its id
<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":"Object with backup data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"assetId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"size":{"type":"number"},"bookmarkCount":{"type":"number"},"status":{"type":"string","enum":["pending","success","failure"]},"errorMessage":{"type":"string","nullable":true}},"required":["id","userId","assetId","createdAt","size","bookmarkCount","status"]}}}},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
