Back to Karakeep

Get a single backup

docs/versioned_docs/version-v0.29.0/api/get-a-single-backup.api.mdx

0.31.01.7 KB
Original Source

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>