diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:31:05 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-29 18:32:19 +0000 |
| commit | 97c386a4d15294b4ed07ff83c8a6a773e7289ab8 (patch) | |
| tree | 3c8a22fdd92efa489638d5216714497d61b47b3e /docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx | |
| parent | f01d96fd91f8829d4d91c465e9950e78fc6f7513 (diff) | |
| download | karakeep-97c386a4d15294b4ed07ff83c8a6a773e7289ab8.tar.zst | |
release(docs): release the 0.29 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx b/docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx new file mode 100644 index 00000000..34fd0777 --- /dev/null +++ b/docs/versioned_docs/version-v0.29.0/api/download-a-backup.api.mdx @@ -0,0 +1,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> + + +
\ No newline at end of file |
